IVSBroadcastSessionState

Objective-C

enum IVSBroadcastSessionState : NSInteger {}

Swift

@frozen enum State : Int, @unchecked Sendable

A value representing the IVSBroadcastSessions current state.

  • The session is invalid. This is the initial state after creating a session but before starting a stream.

    Declaration

    Objective-C

    IVSBroadcastSessionStateInvalid

    Swift

    case invalid = 0

  • The session has disconnected. After stopping a stream the session should return to this state unless it has errored.

    Declaration

    Objective-C

    IVSBroadcastSessionStateDisconnected

    Swift

    case disconnected = 1

  • The session is connecting to the ingest server.

    Declaration

    Objective-C

    IVSBroadcastSessionStateConnecting

    Swift

    case connecting = 2

  • The session has connected to the ingest server and is currently sending data.

    Declaration

    Objective-C

    IVSBroadcastSessionStateConnected

    Swift

    case connected = 3

  • The session has had an error. Use the IVSBroadcastSessionDelegate to catch errors thrown by the session.

    Declaration

    Objective-C

    IVSBroadcastSessionStateError

    Swift

    case error = 4