FMLiveSwitchChannel Class Reference

A channel. More...

Instance Methods

(void) - addOnClaimUpdate:
 Adds a handler that is raised when the client's channel claim has been updated. More...
 
(FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim *) - addOnClaimUpdateWithBlock
 Adds a handler that is raised when the client's channel claim has been updated. More...
 
(void) - addOnClaimUpdateWithBlock:
 Adds a handler that is raised when the client's channel claim has been updated. More...
 
(void) - addOnClientMessage:
 Adds a handler that is raised when a channel/client-scope message is received from the server. More...
 
(FMLiveSwitchClientInfo *, NSString *) - addOnClientMessageWithBlock
 Adds a handler that is raised when a channel/client-scope message is received from the server. More...
 
(void) - addOnClientMessageWithBlock:
 Adds a handler that is raised when a channel/client-scope message is received from the server. More...
 
(void) - addOnDeviceMessage:
 Adds a handler that is raised when a channel/device-scope message is received from the server. More...
 
(FMLiveSwitchClientInfo *, NSString *) - addOnDeviceMessageWithBlock
 Adds a handler that is raised when a channel/device-scope message is received from the server. More...
 
(void) - addOnDeviceMessageWithBlock:
 Adds a handler that is raised when a channel/device-scope message is received from the server. More...
 
(void) - addOnKick:
 Adds a handler that is raised when the client is kicked from the channel. More...
 
(void) - addOnMcuVideoLayout:
 Adds a handler that is raised when a new MCU video layout is received from the server. More...
 
(FMLiveSwitchVideoLayout *) - addOnMcuVideoLayoutWithBlock
 Adds a handler that is raised when a new MCU video layout is received from the server. More...
 
(void) - addOnMcuVideoLayoutWithBlock:
 Adds a handler that is raised when a new MCU video layout is received from the server. More...
 
(void) - addOnMessage:
 Adds a handler that is raised when a channel-scope message is received from the server. More...
 
(FMLiveSwitchClientInfo *, NSString *) - addOnMessageWithBlock
 Adds a handler that is raised when a channel-scope message is received from the server. More...
 
(void) - addOnMessageWithBlock:
 Adds a handler that is raised when a channel-scope message is received from the server. More...
 
(void) - addOnPeerConnectionOffer:
 Adds a handler that is raised when a remote client wants to open a peer connection. More...
 
(FMLiveSwitchPeerConnectionOffer *) - addOnPeerConnectionOfferWithBlock
 Adds a handler that is raised when a remote client wants to open a peer connection. More...
 
(void) - addOnPeerConnectionOfferWithBlock:
 Adds a handler that is raised when a remote client wants to open a peer connection. More...
 
(void) - addOnRemoteClientJoin:
 Adds a handler that is raised when a remote client joins this channel. More...
 
(FMLiveSwitchClientInfo *) - addOnRemoteClientJoinWithBlock
 Adds a handler that is raised when a remote client joins this channel. More...
 
(void) - addOnRemoteClientJoinWithBlock:
 Adds a handler that is raised when a remote client joins this channel. More...
 
(void) - addOnRemoteClientLeave:
 Adds a handler that is raised when a remote client leaves this channel. More...
 
(FMLiveSwitchClientInfo *) - addOnRemoteClientLeaveWithBlock
 Adds a handler that is raised when a remote client leaves this channel. More...
 
(void) - addOnRemoteClientLeaveWithBlock:
 Adds a handler that is raised when a remote client leaves this channel. More...
 
(void) - addOnRemoteClientUpdate:
 Adds a handler that is raised when a remote client updates their config. More...
 
(FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo *) - addOnRemoteClientUpdateWithBlock
 Adds a handler that is raised when a remote client updates their config. More...
 
(void) - addOnRemoteClientUpdateWithBlock:
 Adds a handler that is raised when a remote client updates their config. More...
 
(void) - addOnRemoteUpstreamConnectionClose:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
(FMLiveSwitchConnectionInfo *) - addOnRemoteUpstreamConnectionCloseWithBlock
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
(void) - addOnRemoteUpstreamConnectionCloseWithBlock:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
(void) - addOnRemoteUpstreamConnectionOpen:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
(FMLiveSwitchConnectionInfo *) - addOnRemoteUpstreamConnectionOpenWithBlock
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
(void) - addOnRemoteUpstreamConnectionOpenWithBlock:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
(void) - addOnRemoteUpstreamConnectionUpdate:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
(FMLiveSwitchConnectionInfo *, FMLiveSwitchConnectionInfo *) - addOnRemoteUpstreamConnectionUpdateWithBlock
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
(void) - addOnRemoteUpstreamConnectionUpdateWithBlock:
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
(void) - addOnUserMessage:
 Adds a handler that is raised when a channel/user-scope message is received from the server. More...
 
(FMLiveSwitchClientInfo *, NSString *) - addOnUserMessageWithBlock
 Adds a handler that is raised when a channel/user-scope message is received from the server. More...
 
(void) - addOnUserMessageWithBlock:
 Adds a handler that is raised when a channel/user-scope message is received from the server. More...
 
(NSString *) - applicationId
 Gets the application identifier. More...
 
(FMLiveSwitchChannelClaim *) - claim
 Gets the claim. More...
 
(NSString *) - clientId
 Gets the client identifier. More...
 
(NSMutableArray *) - clientRoles
 Gets the client roles. More...
 
(NSString *) - clientTag
 Gets the client tag. More...
 
(FMLiveSwitchFuture< id > *) - closeAll
 Closes all active connections. More...
 
(FMLiveSwitchManagedConnectionCollection *) - connections
 Gets the active connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:
 Creates an audio-only MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:dataStream:
 Creates an audio/data MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:dataStream:mediaId:
 Creates an audio/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:mediaId:
 Creates an audio-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:videoStream:
 Creates an audio/video MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:videoStream:dataStream:
 Creates an audio/video/data MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:videoStream:dataStream:mediaId:
 Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithAudioStream:videoStream:mediaId:
 Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithDataStream:
 Creates a data-only MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithDataStream:mediaId:
 Creates a data-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithVideoStream:
 Creates a video-only MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithVideoStream:dataStream:
 Creates a video/data MCU connection. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithVideoStream:dataStream:mediaId:
 Creates a video/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchMcuConnection *) - createMcuConnectionWithVideoStream:mediaId:
 Creates a video-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:audioStream:
 Creates an audio-only peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:audioStream:dataStream:
 Creates an audio/data peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:audioStream:videoStream:
 Creates an audio/video peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:audioStream:videoStream:dataStream:
 Creates an audio/video/data peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:dataStream:
 Creates a data-only peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:videoStream:
 Creates a video-only peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithPeerConnectionOffer:videoStream:dataStream:
 Creates a video/data peer connection in the answering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:audioStream:
 Creates an audio-only peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:audioStream:dataStream:
 Creates an audio/data peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:audioStream:videoStream:
 Creates an audio/video peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:audioStream:videoStream:dataStream:
 Creates an audio/video/data peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:dataStream:
 Creates a data-only peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:videoStream:
 Creates a video-only peer connection in the offering role. More...
 
(FMLiveSwitchPeerConnection *) - createPeerConnectionWithRemoteClientInfo:videoStream:dataStream:
 Creates a video/data peer connection in the offering role. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:
 Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:dataStream:
 Creates an audio/data SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:videoStream:
 Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:videoStream:dataStream:
 Creates an audio/video/data SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:dataStream:
 Creates a data-only SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:videoStream:
 Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteConnectionInfo:videoStream:dataStream:
 Creates a video/data SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:audioStream:
 Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:audioStream:dataStream:
 Creates an audio/data SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:audioStream:videoStream:
 Creates an audio/video SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:audioStream:videoStream:dataStream:
 Creates an audio/video/data SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:dataStream:
 Creates a data-only SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:videoStream:
 Creates a video-only SFU downstream connection. More...
 
(FMLiveSwitchSfuDownstreamConnection *) - createSfuDownstreamConnectionWithRemoteMediaId:videoStream:dataStream:
 Creates a video/data SFU downstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:
 Creates an audio-only SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:dataStream:
 Creates an audio/data SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:dataStream:mediaId:
 Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:mediaId:
 Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:videoStream:
 Creates an audio/video SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:videoStream:dataStream:
 Creates an audio/video/data SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:videoStream:dataStream:mediaId:
 Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithAudioStream:videoStream:mediaId:
 Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithDataStream:
 Creates a data-only SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithDataStream:mediaId:
 Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithVideoStream:
 Creates a video-only SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithVideoStream:dataStream:
 Creates a video/data SFU upstream connection. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithVideoStream:dataStream:mediaId:
 Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(FMLiveSwitchSfuUpstreamConnection *) - createSfuUpstreamConnectionWithVideoStream:mediaId:
 Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
(NSString *) - deviceAlias
 Gets the device alias. More...
 
(NSString *) - deviceId
 Gets the device identifier. More...
 
(FMLiveSwitchClientInfo *) - getRemoteClientInfoWithClientId:
 Gets information about a remote client. More...
 
(FMLiveSwitchConnectionInfo *) - getRemoteConnectionInfoWithConnectionId:
 Gets information about a remote connection. More...
 
(NSString *) - id
 Gets the channel identifier. More...
 
(FMLiveSwitchFuture< FMLiveSwitchInvitation * > *) - inviteWithUserId:protocol:
 Invites a user into this channel. More...
 
(FMLiveSwitchFuture< id > *) - kick
 Kicks this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickClientWithRemoteClientInfo:
 Kicks a client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickClientWithUserId:deviceId:clientId:
 Kicks a client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickConnectionWithRemoteConnectionInfo:
 Kicks a connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickConnectionWithUserId:deviceId:clientId:connectionId:
 Kicks a connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickDeviceWithUserId:deviceId:
 Kicks a device in this channel. More...
 
(FMLiveSwitchFuture< id > *) - kickUserWithUserId:
 Kicks a user in this channel. More...
 
(long long) - messageBytesReceived
 Gets the number of message bytes received. More...
 
(long long) - messageBytesSent
 Gets the number of message bytes sent. More...
 
(long long) - messagesReceived
 Gets the number of messages received. More...
 
(long long) - messagesSent
 Gets the number of messages sent. More...
 
(FMLiveSwitchFuture< id > *) - rejectPeerConnectionWithPeerConnectionOffer:
 Rejects a peer connection offer. More...
 
(NSMutableArray *) - remoteClientInfos
 Gets information about the remote client in this channel. More...
 
(NSMutableArray *) - remoteUpstreamConnectionInfos
 Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel. More...
 
(void) - removeOnClaimUpdate:
 Removes a handler that is raised when the client's channel claim has been updated. More...
 
(void) - removeOnClientMessage:
 Removes a handler that is raised when a channel/client-scope message is received from the server. More...
 
(void) - removeOnDeviceMessage:
 Removes a handler that is raised when a channel/device-scope message is received from the server. More...
 
(void) - removeOnKick:
 Removes a handler that is raised when the client is kicked from the channel. More...
 
(void) - removeOnMcuVideoLayout:
 Removes a handler that is raised when a new MCU video layout is received from the server. More...
 
(void) - removeOnMessage:
 Removes a handler that is raised when a channel-scope message is received from the server. More...
 
(void) - removeOnPeerConnectionOffer:
 Removes a handler that is raised when a remote client wants to open a peer connection. More...
 
(void) - removeOnRemoteClientJoin:
 Removes a handler that is raised when a remote client joins this channel. More...
 
(void) - removeOnRemoteClientLeave:
 Removes a handler that is raised when a remote client leaves this channel. More...
 
(void) - removeOnRemoteClientUpdate:
 Removes a handler that is raised when a remote client updates their config. More...
 
(void) - removeOnRemoteUpstreamConnectionClose:
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
(void) - removeOnRemoteUpstreamConnectionOpen:
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
(void) - removeOnRemoteUpstreamConnectionUpdate:
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
(void) - removeOnUserMessage:
 Removes a handler that is raised when a channel/user-scope message is received from the server. More...
 
(FMLiveSwitchFuture< id > *) - sendClientMessageWithUserId:deviceId:clientId:message:
 Sends a message to a client in the channel. More...
 
(FMLiveSwitchFuture< id > *) - sendDeviceMessageWithUserId:deviceId:message:
 Sends a message to a device in the channel. More...
 
(FMLiveSwitchFuture< id > *) - sendMessage:
 Sends a message to the channel. More...
 
(FMLiveSwitchFuture< id > *) - sendUserMessageWithUserId:message:
 Sends a message to a user in the channel. More...
 
(FMLiveSwitchFuture< id > *) - updateClientLayoutWithRemoteClientInfo:newConfig:
 Applies a layout update to all upstream connections for the specified client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateClientLayoutWithUserId:deviceId:clientId:newConfig:
 Applies a layout update to all upstream connections for the specified client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateClientWithRemoteClientInfo:newConfig:
 Updates a client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateClientWithUserId:deviceId:clientId:newConfig:
 Updates a client in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateConnectionLayoutWithRemoteConnectionInfo:newConfig:
 Updates a connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateConnectionLayoutWithUserId:deviceId:clientId:connectionId:newConfig:
 Applies a layout update to the specified upstream connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateConnectionWithRemoteConnectionInfo:newConfig:
 Updates a connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateConnectionWithUserId:deviceId:clientId:connectionId:newConfig:
 Updates a connection in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateDeviceLayoutWithUserId:deviceId:newConfig:
 Applies a layout update to all upstream connections for the specified device in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateDeviceWithUserId:deviceId:newConfig:
 Updates a device in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateLayoutWithNewLayoutConfig:
 Applies a layout update to all upstream connections on this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateUserLayoutWithUserId:newLayoutConfig:
 Applies a layout update to all upstream connections for the specified user in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateUserWithUserId:newConfig:
 Updates a user in this channel. More...
 
(FMLiveSwitchFuture< id > *) - updateWithNewConfig:
 Updates this channel. More...
 
(NSString *) - userAlias
 Gets the user alias. More...
 
(NSString *) - userId
 Gets the user identifier. More...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets all dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Removes a property value from the local cache. More...
 

Additional Inherited Members

- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

A channel.

Method Documentation

◆ addOnClaimUpdate:

- (void) addOnClaimUpdate: (FMLiveSwitchAction2< FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim * > *)  value

Adds a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ addOnClaimUpdateWithBlock

- (FMLiveSwitchChannelClaim*, FMLiveSwitchChannelClaim*) addOnClaimUpdateWithBlock

Adds a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ addOnClaimUpdateWithBlock:

- (void) addOnClaimUpdateWithBlock: (void(^)(FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim *))  valueBlock

Adds a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ addOnClientMessage:

- (void) addOnClientMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Adds a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnClientMessageWithBlock

- (FMLiveSwitchClientInfo*, NSString*) addOnClientMessageWithBlock

Adds a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnClientMessageWithBlock:

- (void) addOnClientMessageWithBlock: (void(^)(FMLiveSwitchClientInfo *, NSString *))  valueBlock

Adds a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnDeviceMessage:

- (void) addOnDeviceMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Adds a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnDeviceMessageWithBlock

- (FMLiveSwitchClientInfo*, NSString*) addOnDeviceMessageWithBlock

Adds a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnDeviceMessageWithBlock:

- (void) addOnDeviceMessageWithBlock: (void(^)(FMLiveSwitchClientInfo *, NSString *))  valueBlock

Adds a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnKick:

- (void) addOnKick: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the client is kicked from the channel.

◆ addOnMcuVideoLayout:

- (void) addOnMcuVideoLayout: (FMLiveSwitchAction1< FMLiveSwitchVideoLayout * > *)  value

Adds a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ addOnMcuVideoLayoutWithBlock

- (FMLiveSwitchVideoLayout*) addOnMcuVideoLayoutWithBlock

Adds a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ addOnMcuVideoLayoutWithBlock:

- (void) addOnMcuVideoLayoutWithBlock: (void(^)(FMLiveSwitchVideoLayout *))  valueBlock

Adds a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ addOnMessage:

- (void) addOnMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Adds a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnMessageWithBlock

- (FMLiveSwitchClientInfo*, NSString*) addOnMessageWithBlock

Adds a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnMessageWithBlock:

- (void) addOnMessageWithBlock: (void(^)(FMLiveSwitchClientInfo *, NSString *))  valueBlock

Adds a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnPeerConnectionOffer:

- (void) addOnPeerConnectionOffer: (FMLiveSwitchAction1< FMLiveSwitchPeerConnectionOffer * > *)  value

Adds a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ addOnPeerConnectionOfferWithBlock

- (FMLiveSwitchPeerConnectionOffer*) addOnPeerConnectionOfferWithBlock

Adds a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ addOnPeerConnectionOfferWithBlock:

- (void) addOnPeerConnectionOfferWithBlock: (void(^)(FMLiveSwitchPeerConnectionOffer *))  valueBlock

Adds a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ addOnRemoteClientJoin:

- (void) addOnRemoteClientJoin: (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *)  value

Adds a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientJoinWithBlock

- (FMLiveSwitchClientInfo*) addOnRemoteClientJoinWithBlock

Adds a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientJoinWithBlock:

- (void) addOnRemoteClientJoinWithBlock: (void(^)(FMLiveSwitchClientInfo *))  valueBlock

Adds a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientLeave:

- (void) addOnRemoteClientLeave: (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *)  value

Adds a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientLeaveWithBlock

- (FMLiveSwitchClientInfo*) addOnRemoteClientLeaveWithBlock

Adds a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientLeaveWithBlock:

- (void) addOnRemoteClientLeaveWithBlock: (void(^)(FMLiveSwitchClientInfo *))  valueBlock

Adds a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientUpdate:

- (void) addOnRemoteClientUpdate: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo * > *)  value

Adds a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ addOnRemoteClientUpdateWithBlock

- (FMLiveSwitchClientInfo*, FMLiveSwitchClientInfo*) addOnRemoteClientUpdateWithBlock

Adds a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ addOnRemoteClientUpdateWithBlock:

- (void) addOnRemoteClientUpdateWithBlock: (void(^)(FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo *))  valueBlock

Adds a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ addOnRemoteUpstreamConnectionClose:

- (void) addOnRemoteUpstreamConnectionClose: (FMLiveSwitchAction1< FMLiveSwitchConnectionInfo * > *)  value

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionCloseWithBlock

- (FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionCloseWithBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionCloseWithBlock:

- (void) addOnRemoteUpstreamConnectionCloseWithBlock: (void(^)(FMLiveSwitchConnectionInfo *))  valueBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionOpen:

- (void) addOnRemoteUpstreamConnectionOpen: (FMLiveSwitchAction1< FMLiveSwitchConnectionInfo * > *)  value

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionOpenWithBlock

- (FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionOpenWithBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionOpenWithBlock:

- (void) addOnRemoteUpstreamConnectionOpenWithBlock: (void(^)(FMLiveSwitchConnectionInfo *))  valueBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionUpdate:

- (void) addOnRemoteUpstreamConnectionUpdate: (FMLiveSwitchAction2< FMLiveSwitchConnectionInfo *, FMLiveSwitchConnectionInfo * > *)  value

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ addOnRemoteUpstreamConnectionUpdateWithBlock

- (FMLiveSwitchConnectionInfo*, FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionUpdateWithBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ addOnRemoteUpstreamConnectionUpdateWithBlock:

- (void) addOnRemoteUpstreamConnectionUpdateWithBlock: (void(^)(FMLiveSwitchConnectionInfo *, FMLiveSwitchConnectionInfo *))  valueBlock

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ addOnUserMessage:

- (void) addOnUserMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Adds a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnUserMessageWithBlock

- (FMLiveSwitchClientInfo*, NSString*) addOnUserMessageWithBlock

Adds a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnUserMessageWithBlock:

- (void) addOnUserMessageWithBlock: (void(^)(FMLiveSwitchClientInfo *, NSString *))  valueBlock

Adds a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ applicationId

- (NSString*) applicationId

Gets the application identifier.

◆ claim

Gets the claim.

◆ clientId

- (NSString*) clientId

Gets the client identifier.

◆ clientRoles

- (NSMutableArray*) clientRoles

Gets the client roles.

◆ clientTag

- (NSString*) clientTag

Gets the client tag.

◆ closeAll

- (FMLiveSwitchFuture<id>*) closeAll

Closes all active connections.

◆ connections

Gets the active connections.

◆ createMcuConnectionWithAudioStream:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream

Creates an audio-only MCU connection.

Parameters
audioStreamThe audio stream.

◆ createMcuConnectionWithAudioStream:dataStream:

Creates an audio/data MCU connection.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createMcuConnectionWithAudioStream:dataStream:mediaId:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
dataStream: (FMLiveSwitchDataStream *)  dataStream
mediaId: (NSString *)  mediaId 

Creates an audio/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithAudioStream:mediaId:

Creates an audio-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithAudioStream:videoStream:

Creates an audio/video MCU connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createMcuConnectionWithAudioStream:videoStream:dataStream:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/video/data MCU connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createMcuConnectionWithAudioStream:videoStream:dataStream:mediaId:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream
mediaId: (NSString *)  mediaId 

Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithAudioStream:videoStream:mediaId:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
mediaId: (NSString *)  mediaId 

Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithDataStream:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithDataStream: (FMLiveSwitchDataStream *)  dataStream

Creates a data-only MCU connection.

Parameters
dataStreamThe data stream.

◆ createMcuConnectionWithDataStream:mediaId:

Creates a data-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithVideoStream:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithVideoStream: (FMLiveSwitchVideoStream *)  videoStream

Creates a video-only MCU connection.

Parameters
videoStreamThe video stream.

◆ createMcuConnectionWithVideoStream:dataStream:

Creates a video/data MCU connection.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.

◆ createMcuConnectionWithVideoStream:dataStream:mediaId:

- (FMLiveSwitchMcuConnection*) createMcuConnectionWithVideoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream
mediaId: (NSString *)  mediaId 

Creates a video/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnectionWithVideoStream:mediaId:

Creates a video-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createPeerConnectionWithPeerConnectionOffer:audioStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
audioStream: (FMLiveSwitchAudioStream *)  audioStream 

Creates an audio-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.

◆ createPeerConnectionWithPeerConnectionOffer:audioStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
audioStream: (FMLiveSwitchAudioStream *)  audioStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createPeerConnectionWithPeerConnectionOffer:audioStream:videoStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates an audio/video peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createPeerConnectionWithPeerConnectionOffer:audioStream:videoStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/video/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnectionWithPeerConnectionOffer:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a data-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
dataStreamThe data stream.

◆ createPeerConnectionWithPeerConnectionOffer:videoStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates a video-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
videoStreamThe video stream.

◆ createPeerConnectionWithPeerConnectionOffer:videoStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a video/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnectionWithRemoteClientInfo:audioStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream 

Creates an audio-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.

◆ createPeerConnectionWithRemoteClientInfo:audioStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createPeerConnectionWithRemoteClientInfo:audioStream:videoStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates an audio/video peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createPeerConnectionWithRemoteClientInfo:audioStream:videoStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/video/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnectionWithRemoteClientInfo:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a data-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
dataStreamThe data stream.

◆ createPeerConnectionWithRemoteClientInfo:videoStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates a video-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
videoStreamThe video stream.

◆ createPeerConnectionWithRemoteClientInfo:videoStream:dataStream:

- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a video/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream 

Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:videoStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:videoStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/video/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a data-only SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:videoStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
videoStreamThe video stream.

◆ createSfuDownstreamConnectionWithRemoteConnectionInfo:videoStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a video/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:audioStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
audioStream: (FMLiveSwitchAudioStream *)  audioStream 

Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:audioStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
audioStream: (FMLiveSwitchAudioStream *)  audioStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:audioStream:videoStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates an audio/video SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:audioStream:videoStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
audioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates an audio/video/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a data-only SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
dataStreamThe data stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:videoStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
videoStream: (FMLiveSwitchVideoStream *)  videoStream 

Creates a video-only SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
videoStreamThe video stream.

◆ createSfuDownstreamConnectionWithRemoteMediaId:videoStream:dataStream:

- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: (NSString *)  remoteMediaId
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream 

Creates a video/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
videoStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnectionWithAudioStream:

- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream

Creates an audio-only SFU upstream connection.

Parameters
audioStreamThe audio stream.

◆ createSfuUpstreamConnectionWithAudioStream:dataStream:

Creates an audio/data SFU upstream connection.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnectionWithAudioStream:dataStream:mediaId:

Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithAudioStream:mediaId:

Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithAudioStream:videoStream:

Creates an audio/video SFU upstream connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuUpstreamConnectionWithAudioStream:videoStream:dataStream:

Creates an audio/video/data SFU upstream connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnectionWithAudioStream:videoStream:dataStream:mediaId:

- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: (FMLiveSwitchAudioStream *)  audioStream
videoStream: (FMLiveSwitchVideoStream *)  videoStream
dataStream: (FMLiveSwitchDataStream *)  dataStream
mediaId: (NSString *)  mediaId 

Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithAudioStream:videoStream:mediaId:

Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithDataStream:

- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithDataStream: (FMLiveSwitchDataStream *)  dataStream

Creates a data-only SFU upstream connection.

Parameters
dataStreamThe data stream.

◆ createSfuUpstreamConnectionWithDataStream:mediaId:

Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithVideoStream:

- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: (FMLiveSwitchVideoStream *)  videoStream

Creates a video-only SFU upstream connection.

Parameters
videoStreamThe video stream.

◆ createSfuUpstreamConnectionWithVideoStream:dataStream:

Creates a video/data SFU upstream connection.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnectionWithVideoStream:dataStream:mediaId:

Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnectionWithVideoStream:mediaId:

Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ deviceAlias

- (NSString*) deviceAlias

Gets the device alias.

◆ deviceId

- (NSString*) deviceId

Gets the device identifier.

◆ getRemoteClientInfoWithClientId:

- (FMLiveSwitchClientInfo*) getRemoteClientInfoWithClientId: (NSString *)  clientId

Gets information about a remote client.

Parameters
clientIdThe client identifier.

◆ getRemoteConnectionInfoWithConnectionId:

- (FMLiveSwitchConnectionInfo*) getRemoteConnectionInfoWithConnectionId: (NSString *)  connectionId

Gets information about a remote connection.

Parameters
connectionIdThe connection identifier.

◆ id

- (NSString*) id

Gets the channel identifier.

◆ inviteWithUserId:protocol:

- (FMLiveSwitchFuture<FMLiveSwitchInvitation*>*) inviteWithUserId: (NSString *)  userId
protocol: (NSString *)  protocol 

Invites a user into this channel.

Parameters
userIdThe user id to invite.
protocolThe protocol to use for the invite.

◆ kick

- (FMLiveSwitchFuture<id>*) kick

Kicks this channel.

Returns
A future that resolves when the channel has been kicked.

◆ kickClientWithRemoteClientInfo:

- (FMLiveSwitchFuture<id>*) kickClientWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo

Kicks a client in this channel.

Parameters
remoteClientInfoThe remote client information.
Returns
A future that resolves when the client has been kicked.

◆ kickClientWithUserId:deviceId:clientId:

- (FMLiveSwitchFuture<id>*) kickClientWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId 

Kicks a client in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
Returns
A future that resolves when the client has been kicked.

◆ kickConnectionWithRemoteConnectionInfo:

- (FMLiveSwitchFuture<id>*) kickConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo

Kicks a connection in this channel.

Parameters
remoteConnectionInfoThe remote connection information.
Returns
A future that resolves when the connection has been kicked.

◆ kickConnectionWithUserId:deviceId:clientId:connectionId:

- (FMLiveSwitchFuture<id>*) kickConnectionWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
connectionId: (NSString *)  connectionId 

Kicks a connection in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
connectionIdThe connection identifier.
Returns
A future that resolves when the connection has been kicked.

◆ kickDeviceWithUserId:deviceId:

- (FMLiveSwitchFuture<id>*) kickDeviceWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId 

Kicks a device in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
Returns
A future that resolves when the device has been kicked.

◆ kickUserWithUserId:

- (FMLiveSwitchFuture<id>*) kickUserWithUserId: (NSString *)  userId

Kicks a user in this channel.

Parameters
userIdThe user identifier.
Returns
A future that resolves when the user has been kicked.

◆ messageBytesReceived

- (long long) messageBytesReceived

Gets the number of message bytes received.

◆ messageBytesSent

- (long long) messageBytesSent

Gets the number of message bytes sent.

◆ messagesReceived

- (long long) messagesReceived

Gets the number of messages received.

◆ messagesSent

- (long long) messagesSent

Gets the number of messages sent.

◆ rejectPeerConnectionWithPeerConnectionOffer:

- (FMLiveSwitchFuture<id>*) rejectPeerConnectionWithPeerConnectionOffer: (FMLiveSwitchPeerConnectionOffer *)  peerConnectionOffer

Rejects a peer connection offer.

Parameters
peerConnectionOfferThe peer connection offer.

◆ remoteClientInfos

- (NSMutableArray*) remoteClientInfos

Gets information about the remote client in this channel.

◆ remoteUpstreamConnectionInfos

- (NSMutableArray*) remoteUpstreamConnectionInfos

Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel.

◆ removeOnClaimUpdate:

- (void) removeOnClaimUpdate: (FMLiveSwitchAction2< FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim * > *)  value

Removes a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ removeOnClientMessage:

- (void) removeOnClientMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Removes a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnDeviceMessage:

- (void) removeOnDeviceMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Removes a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnKick:

- (void) removeOnKick: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the client is kicked from the channel.

◆ removeOnMcuVideoLayout:

- (void) removeOnMcuVideoLayout: (FMLiveSwitchAction1< FMLiveSwitchVideoLayout * > *)  value

Removes a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ removeOnMessage:

- (void) removeOnMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Removes a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnPeerConnectionOffer:

- (void) removeOnPeerConnectionOffer: (FMLiveSwitchAction1< FMLiveSwitchPeerConnectionOffer * > *)  value

Removes a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ removeOnRemoteClientJoin:

- (void) removeOnRemoteClientJoin: (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *)  value

Removes a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ removeOnRemoteClientLeave:

- (void) removeOnRemoteClientLeave: (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *)  value

Removes a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ removeOnRemoteClientUpdate:

- (void) removeOnRemoteClientUpdate: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo * > *)  value

Removes a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ removeOnRemoteUpstreamConnectionClose:

- (void) removeOnRemoteUpstreamConnectionClose: (FMLiveSwitchAction1< FMLiveSwitchConnectionInfo * > *)  value

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ removeOnRemoteUpstreamConnectionOpen:

- (void) removeOnRemoteUpstreamConnectionOpen: (FMLiveSwitchAction1< FMLiveSwitchConnectionInfo * > *)  value

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ removeOnRemoteUpstreamConnectionUpdate:

- (void) removeOnRemoteUpstreamConnectionUpdate: (FMLiveSwitchAction2< FMLiveSwitchConnectionInfo *, FMLiveSwitchConnectionInfo * > *)  value

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ removeOnUserMessage:

- (void) removeOnUserMessage: (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *)  value

Removes a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ sendClientMessageWithUserId:deviceId:clientId:message:

- (FMLiveSwitchFuture<id>*) sendClientMessageWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
message: (NSString *)  message 

Sends a message to a client in the channel.

Parameters
messageThe message to be sent.
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.

◆ sendDeviceMessageWithUserId:deviceId:message:

- (FMLiveSwitchFuture<id>*) sendDeviceMessageWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
message: (NSString *)  message 

Sends a message to a device in the channel.

Parameters
messageThe message to be sent.
userIdThe user identifier.
deviceIdThe device identifier.

◆ sendMessage:

- (FMLiveSwitchFuture<id>*) sendMessage: (NSString *)  message

Sends a message to the channel.

Parameters
messageThe message to be sent.

◆ sendUserMessageWithUserId:message:

- (FMLiveSwitchFuture<id>*) sendUserMessageWithUserId: (NSString *)  userId
message: (NSString *)  message 

Sends a message to a user in the channel.

Parameters
userIdThe user identifier.
messageThe message.

◆ updateClientLayoutWithRemoteClientInfo:newConfig:

- (FMLiveSwitchFuture<id>*) updateClientLayoutWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
newConfig: (FMLiveSwitchChannelClientLayoutConfig *)  newConfig 

Applies a layout update to all upstream connections for the specified client in this channel.

Parameters
remoteClientInfoThe remote client information.
newConfigThe client configuration.
Returns
A future that resolves when the client layout has been updated.

◆ updateClientLayoutWithUserId:deviceId:clientId:newConfig:

- (FMLiveSwitchFuture<id>*) updateClientLayoutWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
newConfig: (FMLiveSwitchChannelClientLayoutConfig *)  newConfig 

Applies a layout update to all upstream connections for the specified client in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
newConfigThe client configuration.
Returns
A future that resolves when the client layout has been updated.

◆ updateClientWithRemoteClientInfo:newConfig:

- (FMLiveSwitchFuture<id>*) updateClientWithRemoteClientInfo: (FMLiveSwitchClientInfo *)  remoteClientInfo
newConfig: (FMLiveSwitchChannelClientConfig *)  newConfig 

Updates a client in this channel.

Parameters
remoteClientInfoThe remote client information.
newConfigThe client configuration.
Returns
A future that resolves when the client has been updated.

◆ updateClientWithUserId:deviceId:clientId:newConfig:

- (FMLiveSwitchFuture<id>*) updateClientWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
newConfig: (FMLiveSwitchChannelClientConfig *)  newConfig 

Updates a client in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
newConfigThe client configuration.
Returns
A future that resolves when the client has been updated.

◆ updateConnectionLayoutWithRemoteConnectionInfo:newConfig:

- (FMLiveSwitchFuture<id>*) updateConnectionLayoutWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
newConfig: (FMLiveSwitchChannelConnectionLayoutConfig *)  newConfig 

Updates a connection in this channel.

Parameters
remoteConnectionInfoThe remote connection information.
newConfigThe connection configuration.
Returns
A future that resolves when the connection has been updated.

◆ updateConnectionLayoutWithUserId:deviceId:clientId:connectionId:newConfig:

- (FMLiveSwitchFuture<id>*) updateConnectionLayoutWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
connectionId: (NSString *)  connectionId
newConfig: (FMLiveSwitchChannelConnectionLayoutConfig *)  newConfig 

Applies a layout update to the specified upstream connection in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
connectionIdThe connection identifier.
newConfigThe connection configuration.
Returns
A future that resolves when the connection layout has been updated.

◆ updateConnectionWithRemoteConnectionInfo:newConfig:

- (FMLiveSwitchFuture<id>*) updateConnectionWithRemoteConnectionInfo: (FMLiveSwitchConnectionInfo *)  remoteConnectionInfo
newConfig: (FMLiveSwitchChannelConnectionConfig *)  newConfig 

Updates a connection in this channel.

Parameters
remoteConnectionInfoThe remote connection information.
newConfigThe connection configuration.
Returns
A future that resolves when the connection has been updated.

◆ updateConnectionWithUserId:deviceId:clientId:connectionId:newConfig:

- (FMLiveSwitchFuture<id>*) updateConnectionWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
clientId: (NSString *)  clientId
connectionId: (NSString *)  connectionId
newConfig: (FMLiveSwitchChannelConnectionConfig *)  newConfig 

Updates a connection in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
connectionIdThe connection identifier.
newConfigThe connection configuration.
Returns
A future that resolves when the connection has been updated.

◆ updateDeviceLayoutWithUserId:deviceId:newConfig:

- (FMLiveSwitchFuture<id>*) updateDeviceLayoutWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
newConfig: (FMLiveSwitchChannelDeviceLayoutConfig *)  newConfig 

Applies a layout update to all upstream connections for the specified device in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
newConfigThe device layout configuration.
Returns
A future that resolves when the device layout has been updated.

◆ updateDeviceWithUserId:deviceId:newConfig:

- (FMLiveSwitchFuture<id>*) updateDeviceWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
newConfig: (FMLiveSwitchChannelDeviceConfig *)  newConfig 

Updates a device in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
newConfigThe device configuration.
Returns
A future that resolves when the device has been updated.

◆ updateLayoutWithNewLayoutConfig:

- (FMLiveSwitchFuture<id>*) updateLayoutWithNewLayoutConfig: (FMLiveSwitchChannelLayoutConfig *)  newLayoutConfig

Applies a layout update to all upstream connections on this channel.

Parameters
newLayoutConfigThe channel layout configuration.
Returns
A future that resolves when the channel layout has been updated.

◆ updateUserLayoutWithUserId:newLayoutConfig:

- (FMLiveSwitchFuture<id>*) updateUserLayoutWithUserId: (NSString *)  userId
newLayoutConfig: (FMLiveSwitchChannelUserLayoutConfig *)  newLayoutConfig 

Applies a layout update to all upstream connections for the specified user in this channel.

Parameters
userIdThe user identifier.
newLayoutConfigThe user layout configuration.
Returns
A future that resolves when the user layout has been updated.

◆ updateUserWithUserId:newConfig:

- (FMLiveSwitchFuture<id>*) updateUserWithUserId: (NSString *)  userId
newConfig: (FMLiveSwitchChannelUserConfig *)  newConfig 

Updates a user in this channel.

Parameters
userIdThe user identifier.
newConfigThe user configuration.
Returns
A future that resolves when the user has been updated.

◆ updateWithNewConfig:

- (FMLiveSwitchFuture<id>*) updateWithNewConfig: (FMLiveSwitchChannelConfig *)  newConfig

Updates this channel.

Parameters
newConfigThe channel configuration.
Returns
A future that resolves when the channel has been updated.

◆ userAlias

- (NSString*) userAlias

Gets the user alias.

◆ userId

- (NSString*) userId

Gets the user identifier.