Enumerations

The following enumerations are available globally.

  • A description of the sample size and structure for audio samples.

    See more

    Declaration

    Objective-C

    enum IVSAudioFormat : NSInteger {}

    Swift

    enum IVSAudioFormat : Int, @unchecked Sendable

  • Supported aspect modes.

    See more

    Declaration

    Objective-C

    enum IVSAspectMode : NSInteger {}

    Swift

    enum AspectMode : Int, @unchecked Sendable

  • Supported audio quality presets. These will increase the quality of the resulting audio at the expense of CPU time. The impact on CPU is non-negligable, and can take up as much as 30% of the total CPU usage of the SDK. The default value is Medium.

    See more

    Declaration

    Objective-C

    enum IVSAudioQuality : NSInteger {}

    Swift

    enum AudioQuality : Int, @unchecked Sendable

  • Profiles for the automatic video bitrate behavior.

    See more

    Declaration

    Objective-C

    enum IVSAutomaticBitrateProfile : NSInteger {}

    Swift

    enum AutomaticBitrateProfile : Int, @unchecked Sendable

  • Possible log levels for IVSBroadcastSession.logLevel

    See more

    Declaration

    Objective-C

    enum IVSBroadcastLogLevel : NSInteger {}

  • Known errors that can be returned by various APIs in the Broadcast SDK

    See more

    Declaration

    Objective-C

    enum IVSBroadcastError : NSInteger {}

    Swift

    enum IVSBroadcastError : Int, @unchecked Sendable

  • A value representing the IVSBroadcastSessions current state.

    See more

    Declaration

    Objective-C

    enum IVSBroadcastSessionState : NSInteger {}

    Swift

    enum State : Int, @unchecked Sendable

  • A value representing the IVSBroadcastSessions retry state.

    See more

    Declaration

    Objective-C

    enum IVSBroadcastSessionRetryState : NSInteger {}

    Swift

    enum RetryState : Int, @unchecked Sendable

  • The state of a network quality test

    See more

    Declaration

    Objective-C

    enum IVSBroadcastSessionTestStatus : NSInteger {}

    Swift

    enum Status : Int, @unchecked Sendable

  • Types of input devices.

    See more

    Declaration

    Objective-C

    enum IVSDeviceType : NSInteger {}

    Swift

    enum IVSDeviceType : Int, @unchecked Sendable

  • Media types present in a stream.

    See more

    Declaration

    Objective-C

    enum IVSDeviceStreamType : NSInteger {}

    Swift

    enum IVSDeviceStreamType : Int, @unchecked Sendable

  • The position of the input device relative to the host device.

    See more

    Declaration

    Objective-C

    enum IVSDevicePosition : NSInteger {}

    Swift

    enum IVSDevicePosition : Int, @unchecked Sendable

  • The stage degradation preference.

    See more

    Declaration

    Objective-C

    enum IVSLocalStageStreamVideoConfigurationDegradationPreference : NSInteger {}

    Swift

    enum DegradationPreference : Int, @unchecked Sendable

  • A bitwise enum representing the capabilities that can be performed by this IVSParticipantInfo.

    See more

    Declaration

    Objective-C

    enum IVSParticipantCapability : NSUInteger {}

    Swift

    struct IVSParticipantCapability : OptionSet, @unchecked Sendable

  • The various potential publish states for a participant

    See more

    Declaration

    Objective-C

    enum IVSParticipantPublishState : NSUInteger {}

    Swift

    enum IVSParticipantPublishState : UInt, @unchecked Sendable

  • The various potential subscribe states for a participant

    See more

    Declaration

    Objective-C

    enum IVSParticipantSubscribeState : NSUInteger {}

    Swift

    enum IVSParticipantSubscribeState : UInt, @unchecked Sendable

  • A value representing how the IVSBroadcastSession will interact with AVAudioSession. If you are using the Stages SDK, please in IVSStageAudioManager instead.

    See more

    Declaration

    Objective-C

    enum IVSSessionAudioSessionStrategy : NSInteger {}

  • The various possible connection states for a Stage.

    See more

    Declaration

    Objective-C

    enum IVSStageConnectionState : NSInteger {}

    Swift

    enum IVSStageConnectionState : Int, @unchecked Sendable

  • These values map to the same name AVAudioSessionCategory values.

    See more

    Declaration

    Objective-C

    enum IVSStageAudioManagerCategory : NSInteger {}

    Swift

    enum Category : Int, @unchecked Sendable

  • These values map to the same name AVAudioSessionCategoryOptions values.

    See more

    Declaration

    Objective-C

    enum IVSStageAudioManagerCategoryOptions : NSInteger {}

    Swift

    struct CategoryOptions : OptionSet, @unchecked Sendable

  • These values map to the same name AVAudioSessionMode values.

    See more

    Declaration

    Objective-C

    enum IVSStageAudioManagerMode : NSInteger {}

    Swift

    enum Mode : Int, @unchecked Sendable

  • Presets for common Stage use cases that set tested combinations of category, categoryOptions, and mode.

    See more

    Declaration

    Objective-C

    enum IVSStageAudioManagerUseCasePreset : NSInteger {}

    Swift

    enum UseCasePreset : Int, @unchecked Sendable

  • The options for subscription types

    See more

    Declaration

    Objective-C

    enum IVSStageSubscribeType : NSInteger {}

    Swift

    enum IVSStageSubscribeType : Int, @unchecked Sendable

  • Enum that represents the network condition for either local audio, local video, remote audio or remote video

    See more

    Declaration

    Objective-C

    enum IVSStageStreamNetworkQuality : NSInteger {}

    Swift

    enum IVSStageStreamNetworkQuality : Int, @unchecked Sendable

  • BroadcastQuality represents the quality of the stream based on the bitrate minimum and maximum provided on session configuration. nearMinimum means the stream is near the lowest possible quality (the configured minimum bitrate), or streaming is not possible at all. nearMaximum means the bitrate is near the maximum allowed (the configured maximum bitrate).

    If the video configuration looks like: initial bitrate = 1000 kbps minimum bitrate = 300 kbps maximum bitrate = 5,000 kbps It will be expected that a nearMinimum quality is provided to this callback initially, since the initial bitrate is much closer to the minimum allowed bitrate than the maximum. If network conditions are good, the quality should improve over time towards nearMaximum.

    See more

    Declaration

    Objective-C

    enum IVSTransmissionStatisticsBroadcastQuality : NSInteger {}

    Swift

    @frozen enum BroadcastQuality : 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.

    See more

    Declaration

    Objective-C

    enum IVSTransmissionStatisticsNetworkHealth : NSInteger {}

    Swift

    @frozen enum NetworkHealth : Int, @unchecked Sendable