IVSTransmissionStatistics

Objective-C


@interface IVSTransmissionStatistics : NSObject

Swift

class IVSTransmissionStatistics : NSObject

IVSTransmissionStatistics contains statistics on the broadcast’s current measured bitrate, recommended bitrate by the SDK’s adaptive bitrate algorithm, average round trip time, broadcast quality (relative to configured minimum and maximum bitrates), and network health.

Expect this callback to be triggered on IVSBroadcastSession.delegate quite frequently (approximately twice per second) as the measured and recommended bitrates change. Measured versus recommended bitrate behavior can vary significantly between platforms. The documentation on each metric provides instructions on how to interpret these values.

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • The current measured average sending bitrate. Note that the device’s video encoder is often unable to match exactly the SDK’s recommended bitrate. There can be some delay between the SDK’s recommended bitrate and the video encoder responding to the recommendation.

    Declaration

    Objective-C

    @property (nonatomic, readonly) double measuredBitrate;

    Swift

    var measuredBitrate: Double { get }

  • The bitrate currently recommended by the SDK. Depending on network conditions, the SDK may recommend a higher or lower bitrate to preserve the stability of the broadcast, within the constraints of the minimum, maximum, and initial bitrates configured by the application in BroadcastConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, readonly) double recommendedBitrate;

    Swift

    var recommendedBitrate: Double { get }
  • rtt

    The current average round trip time for network packets (not image or audio samples).

    Declaration

    Objective-C

    @property (nonatomic, readonly) double rtt;

    Swift

    var rtt: Double { get }

  • The current IVSBroadcastQuality.

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSTransmissionStatisticsBroadcastQuality broadcastQuality;

    Swift

    var broadcastQuality: IVSTransmissionStatistics.BroadcastQuality { get }

  • The current IVSNetworkHealth.

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSTransmissionStatisticsNetworkHealth networkHealth;

    Swift

    var networkHealth: IVSTransmissionStatistics.NetworkHealth { get }