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:useWebSocketsForMedia: |
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. 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:audioStream:videoStream:dataStream:useWebSocketsForMedia: |
Creates an audio/video/data SFU downstream connection. More... | |
(FMLiveSwitchSfuDownstreamConnection *) | - createSfuDownstreamConnectionWithRemoteConnectionInfo:audioStream:videoStream:useWebSocketsForMedia: |
Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. 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 *) | - createSfuDownstreamConnectionWithRemoteConnectionInfo:videoStream:useWebSocketsForMedia: |
Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. 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:useWebSocketsForMedia: |
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier. 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:audioStream:videoStream:dataStream:useWebSocketsForMedia: |
Creates an audio/video/data SFU downstream connection. More... | |
(FMLiveSwitchSfuDownstreamConnection *) | - createSfuDownstreamConnectionWithRemoteMediaId:audioStream:videoStream:useWebSocketsForMedia: |
Creates an audio/video 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... | |
(FMLiveSwitchSfuDownstreamConnection *) | - createSfuDownstreamConnectionWithRemoteMediaId:videoStream:useWebSocketsForMedia: |
Creates a video-only 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:mediaId:useWebSocketsForMedia: |
Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More... | |
(FMLiveSwitchSfuUpstreamConnection *) | - createSfuUpstreamConnectionWithAudioStream:useWebSocketsForMedia: |
Creates an audio-only SFU upstream connection. 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:dataStream:mediaId:useWebSocketsForMedia: |
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More... | |
(FMLiveSwitchSfuUpstreamConnection *) | - createSfuUpstreamConnectionWithAudioStream:videoStream:dataStream:useWebSocketsForMedia: |
Creates an audio/video/data SFU upstream connection. 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 *) | - createSfuUpstreamConnectionWithAudioStream:videoStream:mediaId:useWebSocketsForMedia: |
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More... | |
(FMLiveSwitchSfuUpstreamConnection *) | - createSfuUpstreamConnectionWithAudioStream:videoStream:useWebSocketsForMedia: |
Creates an audio/video SFU upstream connection. 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... | |
(FMLiveSwitchSfuUpstreamConnection *) | - createSfuUpstreamConnectionWithVideoStream:mediaId:useWebSocketsForMedia: |
Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More... | |
(FMLiveSwitchSfuUpstreamConnection *) | - createSfuUpstreamConnectionWithVideoStream:useWebSocketsForMedia: |
Creates a video-only SFU upstream connection. 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... | |
(NSString *) | - webSocketAccessToken |
Gets the WebSocket Media Server Authorization Token for this channel. More... | |
(NSString *) | - webSocketServerEndpointUrl |
Gets the WebSocket Media Server Endpoint for this channel. 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... | |
A channel.
- (void) addOnClaimUpdate: | (FMLiveSwitchAction2< FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim * > *) | value |
Adds a handler that is raised when the client's channel claim has been updated.
Parameters:
- (FMLiveSwitchChannelClaim*, FMLiveSwitchChannelClaim*) addOnClaimUpdateWithBlock |
Adds a handler that is raised when the client's channel claim has been updated.
Parameters:
- (void) addOnClaimUpdateWithBlock: | (void(^)(FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim *)) | valueBlock |
Adds a handler that is raised when the client's channel claim has been updated.
Parameters:
- (void) addOnClientMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Adds a handler that is raised when a channel/client-scope message is received from the server.
Parameters:
- (FMLiveSwitchClientInfo*, NSString*) addOnClientMessageWithBlock |
Adds a handler that is raised when a channel/client-scope message is received from the server.
Parameters:
- (void) addOnClientMessageWithBlock: | (void(^)(FMLiveSwitchClientInfo *, NSString *)) | valueBlock |
Adds a handler that is raised when a channel/client-scope message is received from the server.
Parameters:
- (void) addOnDeviceMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Adds a handler that is raised when a channel/device-scope message is received from the server.
Parameters:
- (FMLiveSwitchClientInfo*, NSString*) addOnDeviceMessageWithBlock |
Adds a handler that is raised when a channel/device-scope message is received from the server.
Parameters:
- (void) addOnDeviceMessageWithBlock: | (void(^)(FMLiveSwitchClientInfo *, NSString *)) | valueBlock |
Adds a handler that is raised when a channel/device-scope message is received from the server.
Parameters:
- (void) addOnKick: | (FMLiveSwitchAction0 *) | value |
Adds a handler that is raised when the client is kicked from the channel.
- (void) addOnMcuVideoLayout: | (FMLiveSwitchAction1< FMLiveSwitchVideoLayout * > *) | value |
Adds a handler that is raised when a new MCU video layout is received from the server.
Parameters:
- (FMLiveSwitchVideoLayout*) addOnMcuVideoLayoutWithBlock |
Adds a handler that is raised when a new MCU video layout is received from the server.
Parameters:
- (void) addOnMcuVideoLayoutWithBlock: | (void(^)(FMLiveSwitchVideoLayout *)) | valueBlock |
Adds a handler that is raised when a new MCU video layout is received from the server.
Parameters:
- (void) addOnMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Adds a handler that is raised when a channel-scope message is received from the server.
Parameters:
- (FMLiveSwitchClientInfo*, NSString*) addOnMessageWithBlock |
Adds a handler that is raised when a channel-scope message is received from the server.
Parameters:
- (void) addOnMessageWithBlock: | (void(^)(FMLiveSwitchClientInfo *, NSString *)) | valueBlock |
Adds a handler that is raised when a channel-scope message is received from the server.
Parameters:
- (void) addOnPeerConnectionOffer: | (FMLiveSwitchAction1< FMLiveSwitchPeerConnectionOffer * > *) | value |
Adds a handler that is raised when a remote client wants to open a peer connection.
Parameters:
- (FMLiveSwitchPeerConnectionOffer*) addOnPeerConnectionOfferWithBlock |
Adds a handler that is raised when a remote client wants to open a peer connection.
Parameters:
- (void) addOnPeerConnectionOfferWithBlock: | (void(^)(FMLiveSwitchPeerConnectionOffer *)) | valueBlock |
Adds a handler that is raised when a remote client wants to open a peer connection.
Parameters:
- (void) addOnRemoteClientJoin: | (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *) | value |
Adds a handler that is raised when a remote client joins this channel.
Parameters:
- (FMLiveSwitchClientInfo*) addOnRemoteClientJoinWithBlock |
Adds a handler that is raised when a remote client joins this channel.
Parameters:
- (void) addOnRemoteClientJoinWithBlock: | (void(^)(FMLiveSwitchClientInfo *)) | valueBlock |
Adds a handler that is raised when a remote client joins this channel.
Parameters:
- (void) addOnRemoteClientLeave: | (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *) | value |
Adds a handler that is raised when a remote client leaves this channel.
Parameters:
- (FMLiveSwitchClientInfo*) addOnRemoteClientLeaveWithBlock |
Adds a handler that is raised when a remote client leaves this channel.
Parameters:
- (void) addOnRemoteClientLeaveWithBlock: | (void(^)(FMLiveSwitchClientInfo *)) | valueBlock |
Adds a handler that is raised when a remote client leaves this channel.
Parameters:
- (void) addOnRemoteClientUpdate: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo * > *) | value |
Adds a handler that is raised when a remote client updates their config.
Parameters:
- (FMLiveSwitchClientInfo*, FMLiveSwitchClientInfo*) addOnRemoteClientUpdateWithBlock |
Adds a handler that is raised when a remote client updates their config.
Parameters:
- (void) addOnRemoteClientUpdateWithBlock: | (void(^)(FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo *)) | valueBlock |
Adds a handler that is raised when a remote client updates their config.
Parameters:
- (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:
- (FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionCloseWithBlock |
Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.
Parameters:
- (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:
- (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:
- (FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionOpenWithBlock |
Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.
Parameters:
- (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:
- (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:
- (FMLiveSwitchConnectionInfo*, FMLiveSwitchConnectionInfo*) addOnRemoteUpstreamConnectionUpdateWithBlock |
Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.
Parameters:
- (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:
- (void) addOnUserMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Adds a handler that is raised when a channel/user-scope message is received from the server.
Parameters:
- (FMLiveSwitchClientInfo*, NSString*) addOnUserMessageWithBlock |
Adds a handler that is raised when a channel/user-scope message is received from the server.
Parameters:
- (void) addOnUserMessageWithBlock: | (void(^)(FMLiveSwitchClientInfo *, NSString *)) | valueBlock |
Adds a handler that is raised when a channel/user-scope message is received from the server.
Parameters:
- (NSString*) applicationId |
Gets the application identifier.
- (FMLiveSwitchChannelClaim*) claim |
Gets the claim.
- (NSString*) clientId |
Gets the client identifier.
- (NSMutableArray*) clientRoles |
Gets the client roles.
- (NSString*) clientTag |
Gets the client tag.
- (FMLiveSwitchFuture<id>*) closeAll |
Closes all active connections.
- (FMLiveSwitchManagedConnectionCollection*) connections |
Gets the active connections.
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream |
Creates an audio-only MCU connection.
audioStream | The audio stream. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data MCU connection.
audioStream | The audio stream. |
dataStream | The data stream. |
- (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.
audioStream | The audio stream. |
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
mediaId: | (NSString *) | 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.
audioStream | The audio stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates an audio/video MCU connection.
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data MCU connection.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (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.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (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.
audioStream | The audio stream. |
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithDataStream: | (FMLiveSwitchDataStream *) | dataStream |
Creates a data-only MCU connection.
dataStream | The data stream. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithDataStream: | (FMLiveSwitchDataStream *) | dataStream | |
mediaId: | (NSString *) | 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.
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream |
Creates a video-only MCU connection.
videoStream | The video stream. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data MCU connection.
videoStream | The video stream. |
dataStream | The data stream. |
- (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.
videoStream | The video stream. |
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchMcuConnection*) createMcuConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
mediaId: | (NSString *) | 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.
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
Creates an audio-only peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
audioStream | The audio stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
audioStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates an audio/video peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a data-only peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates a video-only peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
videoStream | The video stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data peer connection in the answering role.
peerConnectionOffer | The peer connection offer. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
Creates an audio-only peer connection in the offering role.
remoteClientInfo | The remote client information. |
audioStream | The audio stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data peer connection in the offering role.
remoteClientInfo | The remote client information. |
audioStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates an audio/video peer connection in the offering role.
remoteClientInfo | The remote client information. |
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data peer connection in the offering role.
remoteClientInfo | The remote client information. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a data-only peer connection in the offering role.
remoteClientInfo | The remote client information. |
dataStream | The data stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates a video-only peer connection in the offering role.
remoteClientInfo | The remote client information. |
videoStream | The video stream. |
- (FMLiveSwitchPeerConnection*) createPeerConnectionWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data peer connection in the offering role.
remoteClientInfo | The remote client information. |
videoStream | The video stream. |
dataStream | The data stream. |
- (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.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data SFU downstream connection.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (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.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data SFU downstream connection.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video/data SFU downstream connection.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
useWebSocketsForMedia | Use WebSockets to stream the media instead of WebRTC. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
remoteConnectionInfo | The remote connection information. |
audioStream | The audio stream. |
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a data-only SFU downstream connection.
remoteConnectionInfo | The remote connection information. |
dataStream | The data stream. |
- (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.
remoteConnectionInfo | The remote connection information. |
videoStream | The video stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data SFU downstream connection.
remoteConnectionInfo | The remote connection information. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
remoteConnectionInfo | The remote connection information. |
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (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.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data SFU downstream connection.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates an audio/video SFU downstream connection.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data SFU downstream connection.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video/data SFU downstream connection.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
useWebSocketsForMedia | Use WebSockets to stream the media instead of WebRTC. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
audioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video SFU downstream connection.
remoteMediaId | The remote media identifier. |
audioStream | The audio stream. |
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a data-only SFU downstream connection.
remoteMediaId | The remote media identifier. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates a video-only SFU downstream connection.
remoteMediaId | The remote media identifier. |
videoStream | The video stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data SFU downstream connection.
remoteMediaId | The remote media identifier. |
videoStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuDownstreamConnection*) createSfuDownstreamConnectionWithRemoteMediaId: | (NSString *) | remoteMediaId | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates a video-only SFU downstream connection.
remoteMediaId | The remote media identifier. |
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream |
Creates an audio-only SFU upstream connection.
audioStream | The audio stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/data SFU upstream connection.
audioStream | The audio stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
mediaId: | (NSString *) | mediaId | |
Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
mediaId: | (NSString *) | mediaId | |
Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
mediaId: | (NSString *) | mediaId | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio-only SFU upstream connection.
audioStream | The audio stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
Creates an audio/video SFU upstream connection.
audioStream | The audio stream. |
videoStream | The video stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates an audio/video/data SFU upstream connection.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
- (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.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
mediaId: | (NSString *) | mediaId | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
useWebSocketsForMedia | A flag to indicate if we should send media over a WebSocket connection. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video/data SFU upstream connection.
audioStream | The audio stream. |
videoStream | The video stream. |
dataStream | The data stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
mediaId: | (NSString *) | mediaId | |
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
mediaId: | (NSString *) | mediaId | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
audioStream | The audio stream. |
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithAudioStream: | (FMLiveSwitchAudioStream *) | audioStream | |
videoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates an audio/video SFU upstream connection.
audioStream | The audio stream. |
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithDataStream: | (FMLiveSwitchDataStream *) | dataStream |
Creates a data-only SFU upstream connection.
dataStream | The data stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithDataStream: | (FMLiveSwitchDataStream *) | dataStream | |
mediaId: | (NSString *) | mediaId | |
Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream |
Creates a video-only SFU upstream connection.
videoStream | The video stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
Creates a video/data SFU upstream connection.
videoStream | The video stream. |
dataStream | The data stream. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
dataStream: | (FMLiveSwitchDataStream *) | dataStream | |
mediaId: | (NSString *) | mediaId | |
Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
videoStream | The video stream. |
dataStream | The data stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
mediaId: | (NSString *) | mediaId | |
Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
mediaId: | (NSString *) | mediaId | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
videoStream | The video stream. |
mediaId | The media identifier, unique to this channel, for persistent SFU downstream connections. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (FMLiveSwitchSfuUpstreamConnection*) createSfuUpstreamConnectionWithVideoStream: | (FMLiveSwitchVideoStream *) | videoStream | |
useWebSocketsForMedia: | (bool) | useWebSocketsForMedia | |
Creates a video-only SFU upstream connection.
videoStream | The video stream. |
useWebSocketsForMedia | Use WebSockets to stream this media instead of WebRTC. |
- (NSString*) deviceAlias |
Gets the device alias.
- (NSString*) deviceId |
Gets the device identifier.
- (FMLiveSwitchClientInfo*) getRemoteClientInfoWithClientId: | (NSString *) | clientId |
Gets information about a remote client.
clientId | The client identifier. |
- (FMLiveSwitchConnectionInfo*) getRemoteConnectionInfoWithConnectionId: | (NSString *) | connectionId |
Gets information about a remote connection.
connectionId | The connection identifier. |
- (FMLiveSwitchFuture<FMLiveSwitchInvitation*>*) inviteWithUserId: | (NSString *) | userId | |
protocol: | (NSString *) | protocol | |
Invites a user into this channel.
userId | The user id to invite. |
protocol | The protocol to use for the invite. |
- (FMLiveSwitchFuture<id>*) kick |
Kicks this channel.
- (FMLiveSwitchFuture<id>*) kickClientWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo |
Kicks a client in this channel.
remoteClientInfo | The remote client information. |
- (FMLiveSwitchFuture<id>*) kickClientWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
clientId: | (NSString *) | clientId | |
Kicks a client in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
- (FMLiveSwitchFuture<id>*) kickConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo |
Kicks a connection in this channel.
remoteConnectionInfo | The remote connection information. |
- (FMLiveSwitchFuture<id>*) kickConnectionWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
clientId: | (NSString *) | clientId | |
connectionId: | (NSString *) | connectionId | |
Kicks a connection in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
connectionId | The connection identifier. |
- (FMLiveSwitchFuture<id>*) kickDeviceWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
Kicks a device in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
- (FMLiveSwitchFuture<id>*) kickUserWithUserId: | (NSString *) | userId |
Kicks a user in this channel.
userId | The user identifier. |
- (long long) messageBytesReceived |
Gets the number of message bytes received.
- (long long) messageBytesSent |
Gets the number of message bytes sent.
- (long long) messagesReceived |
Gets the number of messages received.
- (long long) messagesSent |
Gets the number of messages sent.
- (FMLiveSwitchFuture<id>*) rejectPeerConnectionWithPeerConnectionOffer: | (FMLiveSwitchPeerConnectionOffer *) | peerConnectionOffer |
Rejects a peer connection offer.
peerConnectionOffer | The peer connection offer. |
- (NSMutableArray*) remoteClientInfos |
Gets information about the remote client in this channel.
- (NSMutableArray*) remoteUpstreamConnectionInfos |
Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel.
- (void) removeOnClaimUpdate: | (FMLiveSwitchAction2< FMLiveSwitchChannelClaim *, FMLiveSwitchChannelClaim * > *) | value |
Removes a handler that is raised when the client's channel claim has been updated.
Parameters:
- (void) removeOnClientMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Removes a handler that is raised when a channel/client-scope message is received from the server.
Parameters:
- (void) removeOnDeviceMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Removes a handler that is raised when a channel/device-scope message is received from the server.
Parameters:
- (void) removeOnKick: | (FMLiveSwitchAction0 *) | value |
Removes a handler that is raised when the client is kicked from the channel.
- (void) removeOnMcuVideoLayout: | (FMLiveSwitchAction1< FMLiveSwitchVideoLayout * > *) | value |
Removes a handler that is raised when a new MCU video layout is received from the server.
Parameters:
- (void) removeOnMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Removes a handler that is raised when a channel-scope message is received from the server.
Parameters:
- (void) removeOnPeerConnectionOffer: | (FMLiveSwitchAction1< FMLiveSwitchPeerConnectionOffer * > *) | value |
Removes a handler that is raised when a remote client wants to open a peer connection.
Parameters:
- (void) removeOnRemoteClientJoin: | (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *) | value |
Removes a handler that is raised when a remote client joins this channel.
Parameters:
- (void) removeOnRemoteClientLeave: | (FMLiveSwitchAction1< FMLiveSwitchClientInfo * > *) | value |
Removes a handler that is raised when a remote client leaves this channel.
Parameters:
- (void) removeOnRemoteClientUpdate: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, FMLiveSwitchClientInfo * > *) | value |
Removes a handler that is raised when a remote client updates their config.
Parameters:
- (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:
- (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:
- (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:
- (void) removeOnUserMessage: | (FMLiveSwitchAction2< FMLiveSwitchClientInfo *, NSString * > *) | value |
Removes a handler that is raised when a channel/user-scope message is received from the server.
Parameters:
- (FMLiveSwitchFuture<id>*) sendClientMessageWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
clientId: | (NSString *) | clientId | |
message: | (NSString *) | message | |
Sends a message to a client in the channel.
message | The message to be sent. |
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
- (FMLiveSwitchFuture<id>*) sendDeviceMessageWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
message: | (NSString *) | message | |
Sends a message to a device in the channel.
message | The message to be sent. |
userId | The user identifier. |
deviceId | The device identifier. |
- (FMLiveSwitchFuture<id>*) sendMessage: | (NSString *) | message |
Sends a message to the channel.
message | The message to be sent. |
- (FMLiveSwitchFuture<id>*) sendUserMessageWithUserId: | (NSString *) | userId | |
message: | (NSString *) | message | |
Sends a message to a user in the channel.
userId | The user identifier. |
message | The message. |
- (FMLiveSwitchFuture<id>*) updateClientLayoutWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
newConfig: | (FMLiveSwitchChannelClientLayoutConfig *) | newConfig | |
Applies a layout update to all upstream connections for the specified client in this channel.
remoteClientInfo | The remote client information. |
newConfig | The client configuration. |
- (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.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
newConfig | The client configuration. |
- (FMLiveSwitchFuture<id>*) updateClientWithRemoteClientInfo: | (FMLiveSwitchClientInfo *) | remoteClientInfo | |
newConfig: | (FMLiveSwitchChannelClientConfig *) | newConfig | |
Updates a client in this channel.
remoteClientInfo | The remote client information. |
newConfig | The client configuration. |
- (FMLiveSwitchFuture<id>*) updateClientWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
clientId: | (NSString *) | clientId | |
newConfig: | (FMLiveSwitchChannelClientConfig *) | newConfig | |
Updates a client in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
newConfig | The client configuration. |
- (FMLiveSwitchFuture<id>*) updateConnectionLayoutWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
newConfig: | (FMLiveSwitchChannelConnectionLayoutConfig *) | newConfig | |
Updates a connection in this channel.
remoteConnectionInfo | The remote connection information. |
newConfig | The connection configuration. |
- (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.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
connectionId | The connection identifier. |
newConfig | The connection configuration. |
- (FMLiveSwitchFuture<id>*) updateConnectionWithRemoteConnectionInfo: | (FMLiveSwitchConnectionInfo *) | remoteConnectionInfo | |
newConfig: | (FMLiveSwitchChannelConnectionConfig *) | newConfig | |
Updates a connection in this channel.
remoteConnectionInfo | The remote connection information. |
newConfig | The connection configuration. |
- (FMLiveSwitchFuture<id>*) updateConnectionWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
clientId: | (NSString *) | clientId | |
connectionId: | (NSString *) | connectionId | |
newConfig: | (FMLiveSwitchChannelConnectionConfig *) | newConfig | |
Updates a connection in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
clientId | The client identifier. |
connectionId | The connection identifier. |
newConfig | The connection configuration. |
- (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.
userId | The user identifier. |
deviceId | The device identifier. |
newConfig | The device layout configuration. |
- (FMLiveSwitchFuture<id>*) updateDeviceWithUserId: | (NSString *) | userId | |
deviceId: | (NSString *) | deviceId | |
newConfig: | (FMLiveSwitchChannelDeviceConfig *) | newConfig | |
Updates a device in this channel.
userId | The user identifier. |
deviceId | The device identifier. |
newConfig | The device configuration. |
- (FMLiveSwitchFuture<id>*) updateLayoutWithNewLayoutConfig: | (FMLiveSwitchChannelLayoutConfig *) | newLayoutConfig |
Applies a layout update to all upstream connections on this channel.
newLayoutConfig | The channel layout configuration. |
- (FMLiveSwitchFuture<id>*) updateUserLayoutWithUserId: | (NSString *) | userId | |
newLayoutConfig: | (FMLiveSwitchChannelUserLayoutConfig *) | newLayoutConfig | |
Applies a layout update to all upstream connections for the specified user in this channel.
userId | The user identifier. |
newLayoutConfig | The user layout configuration. |
- (FMLiveSwitchFuture<id>*) updateUserWithUserId: | (NSString *) | userId | |
newConfig: | (FMLiveSwitchChannelUserConfig *) | newConfig | |
Updates a user in this channel.
userId | The user identifier. |
newConfig | The user configuration. |
- (FMLiveSwitchFuture<id>*) updateWithNewConfig: | (FMLiveSwitchChannelConfig *) | newConfig |
Updates this channel.
newConfig | The channel configuration. |
- (NSString*) userAlias |
Gets the user alias.
- (NSString*) userId |
Gets the user identifier.
- (NSString*) webSocketAccessToken |
Gets the WebSocket Media Server Authorization Token for this channel.
- (NSString*) webSocketServerEndpointUrl |
Gets the WebSocket Media Server Endpoint for this channel.