MillicastSDK 2.0.0
Loading...
Searching...
No Matches
Instance Methods | List of all members
MCStatsReport Class Reference

Interface is a container for various different statistics. More...

#import <stats.h>

Inheritance diagram for MCStatsReport:
Inheritance graph
[legend]
Collaboration diagram for MCStatsReport:
Collaboration graph
[legend]

Instance Methods

(nullable MCStats *) - get:
 
(nullable NSArray< MCStats * > *) - getStatsOfType:
 
(int) - size
 
(nonnull MCStreamDetails *) - getStreamDetails
 
 initWithStatsReport:
 

Detailed Description

Interface is a container for various different statistics.

Method Documentation

◆ get:

- (nullable MCStats *) get: (nonnull NSString *)  statsId

Retrieves a specific MCStats object from the report based on its unique identifier.

  • Parameters:
    • statsId: A unique identifier. See MCStats/sid
  • Returns: a stats object of a specifc kind.

◆ getStatsOfType:

- (nullable NSArray< MCStats * > *) getStatsOfType: (MCStatsType)  type

Retrieves an array of MCStats objects from the report that match a specified MCStatsType.

  • Parameters:
    • type: The desired type of statistics. See MCStatsType
  • Returns: An array containing the stats of the specified type.

◆ getStreamDetails

- (nonnull MCStreamDetails *) getStreamDetails

Get the stream details of the session the stats belong to.

This information helps correlate logs between different components (Media Server, Publisher, and Viewer) that operate on the current stream session.

◆ size

- (int) size

The number of MCStats objects stored in the stats report.

  • Returns: The number of stats objects in the report.

The documentation for this class was generated from the following file: