IVSTransmissionStatisticsNetworkHealth

Objective-C

enum IVSTransmissionStatisticsNetworkHealth : NSInteger {}

Swift

@frozen enum NetworkHealth : Int, @unchecked Sendable

NetworkHealth represents the current health of the network. bad means the network is struggling to keep up and the broadcast may be experiencing latency spikes. The SDK may also reduce the quality of the broadcast on low values in order to keep it stable, depending on the minimum allowed bitrate in the broadcast configuration. A value of excellent means the network is easily able to keep up with the current demand and the SDK will be trying to increase the broadcast quality over time, depending on the maximum allowed bitrate. Values like medium or low are not necessarily bad, it just means the network is being saturated, but it is still able to keep up. The broadcast is still likely stable.

  • The network is easily able to keep up with the current broadcast.

    Declaration

    Objective-C

    IVSTransmissionStatisticsNetworkHealthExcellent

    Swift

    case excellent = 0

  • The network keeping up with the broadcast well but the connection is not perfect.

    Declaration

    Objective-C

    IVSTransmissionStatisticsNetworkHealthHigh

    Swift

    case high = 1

  • The network is experiencing some congestion but it can still keep up with the corrent quality.

    Declaration

    Objective-C

    IVSTransmissionStatisticsNetworkHealthMedium

    Swift

    case medium = 2

  • The network is struggling to keep up with the current video quality and may reduce quality.

    Declaration

    Objective-C

    IVSTransmissionStatisticsNetworkHealthLow

    Swift

    case low = 3

  • The network can not keep up with the current video quality and will be reducing the quality if allowed.

    Declaration

    Objective-C

    IVSTransmissionStatisticsNetworkHealthBad

    Swift

    case bad = 4