/ fm / liveswitch / Channel
Class: Channel
fm.liveswitch.Channel
A channel.
Hierarchy
-
↳ Channel
Table of contents
Methods
- addOnClaimUpdate
- addOnClientMessage
- addOnDeviceMessage
- addOnKick
- addOnMcuVideoLayout
- addOnMessage
- addOnPeerConnectionOffer
- addOnRemoteClientJoin
- addOnRemoteClientLeave
- addOnRemoteClientUpdate
- addOnRemoteUpstreamConnectionClose
- addOnRemoteUpstreamConnectionOpen
- addOnRemoteUpstreamConnectionUpdate
- addOnUserMessage
- closeAll
- createMcuConnection
- createPeerConnection
- createSfuDownstreamConnection
- createSfuUpstreamConnection
- fmliveswitchChannelInit
- getApplicationId
- getClaim
- getClientId
- getClientRoles
- getClientTag
- getConnections
- getDeviceAlias
- getDeviceId
- getDynamicProperties
- getDynamicValue
- getId
- getMessageBytesReceived
- getMessageBytesSent
- getMessagesReceived
- getMessagesSent
- getRemoteClientInfo
- getRemoteClientInfos
- getRemoteConnectionInfo
- getRemoteUpstreamConnectionInfos
- getTypeString
- getUserAlias
- getUserId
- invite
- kick
- kickClient
- kickConnection
- kickDevice
- kickUser
- rejectPeerConnection
- removeOnClaimUpdate
- removeOnClientMessage
- removeOnDeviceMessage
- removeOnKick
- removeOnMcuVideoLayout
- removeOnMessage
- removeOnPeerConnectionOffer
- removeOnRemoteClientJoin
- removeOnRemoteClientLeave
- removeOnRemoteClientUpdate
- removeOnRemoteUpstreamConnectionClose
- removeOnRemoteUpstreamConnectionOpen
- removeOnRemoteUpstreamConnectionUpdate
- removeOnUserMessage
- sendClientMessage
- sendDeviceMessage
- sendMessage
- sendUserMessage
- setDynamicValue
- unsetDynamicValue
- update
- updateClient
- updateClientLayout
- updateConnection
- updateConnectionLayout
- updateDevice
- updateDeviceLayout
- updateLayout
- updateUser
- updateUserLayout
Methods
addOnClaimUpdate
▸ addOnClaimUpdate(value
: IAction2<ChannelClaim, ChannelClaim>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ChannelClaim, ChannelClaim> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:219
addOnClientMessage
▸ addOnClientMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:234
addOnDeviceMessage
▸ addOnDeviceMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:249
addOnKick
▸ addOnKick(value
: IAction0): void
Adds a handler that is raised when the client is kicked from the channel.
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:261
addOnMcuVideoLayout
▸ addOnMcuVideoLayout(value
: IAction1<VideoLayout>): void
Adds a handler that is raised when a new MCU video layout is received from the server. Parameters:
- videoLayout - the new MCU video layout
Parameters:
Name | Type |
---|---|
value |
IAction1<VideoLayout> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:275
addOnMessage
▸ addOnMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:290
addOnPeerConnectionOffer
▸ addOnPeerConnectionOffer(value
: IAction1<PeerConnectionOffer>): void
Adds a handler that is raised when a remote client wants to open a peer connection. Parameters:
- peerConnectionOffer - the peer connection offer
Parameters:
Name | Type |
---|---|
value |
IAction1<PeerConnectionOffer> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:304
addOnRemoteClientJoin
▸ addOnRemoteClientJoin(value
: IAction1<ClientInfo>): void
Adds a handler that is raised when a remote client joins this channel. Parameters:
- clientInfo - the remote client information
Parameters:
Name | Type |
---|---|
value |
IAction1<ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:318
addOnRemoteClientLeave
▸ addOnRemoteClientLeave(value
: IAction1<ClientInfo>): void
Adds a handler that is raised when a remote client leaves this channel. Parameters:
- clientInfo - the remote client information
Parameters:
Name | Type |
---|---|
value |
IAction1<ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:332
addOnRemoteClientUpdate
▸ addOnRemoteClientUpdate(value
: IAction2<ClientInfo, ClientInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:347
addOnRemoteUpstreamConnectionClose
▸ addOnRemoteUpstreamConnectionClose(value
: IAction1<ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction1<ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:362
addOnRemoteUpstreamConnectionOpen
▸ addOnRemoteUpstreamConnectionOpen(value
: IAction1<ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction1<ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:377
addOnRemoteUpstreamConnectionUpdate
▸ addOnRemoteUpstreamConnectionUpdate(value
: IAction2<ConnectionInfo, ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ConnectionInfo, ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:393
addOnUserMessage
▸ addOnUserMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:408
closeAll
▸ closeAll(): Future<Object>
Closes all active connections.
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:420
createMcuConnection
▸ createMcuConnection(audioStream
: AudioStream): McuConnection
Creates an audio-only MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:438
▸ createMcuConnection(audioStream
: AudioStream, dataStream
: DataStream): McuConnection
Creates an audio/data MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:446
▸ createMcuConnection(audioStream
: AudioStream, dataStream
: DataStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:457
▸ createMcuConnection(audioStream
: AudioStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:467
▸ createMcuConnection(audioStream
: AudioStream, videoStream
: VideoStream): McuConnection
Creates an audio/video MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:475
▸ createMcuConnection(audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): McuConnection
Creates an audio/video/data MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:484
▸ createMcuConnection(audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:496
▸ createMcuConnection(audioStream
: AudioStream, videoStream
: VideoStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:507
▸ createMcuConnection(dataStream
: DataStream): McuConnection
Creates a data-only MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
dataStream |
DataStream | The data stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:514
▸ createMcuConnection(dataStream
: DataStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:524
▸ createMcuConnection(videoStream
: VideoStream): McuConnection
Creates a video-only MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:531
▸ createMcuConnection(videoStream
: VideoStream, dataStream
: DataStream): McuConnection
Creates a video/data MCU connection.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:539
▸ createMcuConnection(videoStream
: VideoStream, dataStream
: DataStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:550
▸ createMcuConnection(videoStream
: VideoStream, mediaId
: string): McuConnection
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:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: McuConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:560
createPeerConnection
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, audioStream
: AudioStream): PeerConnection
Creates an audio-only peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
audioStream |
AudioStream | The audio stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:644
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, audioStream
: AudioStream, dataStream
: DataStream): PeerConnection
Creates an audio/data peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:653
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, audioStream
: AudioStream, videoStream
: VideoStream): PeerConnection
Creates an audio/video peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:662
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): PeerConnection
Creates an audio/video/data peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:672
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, dataStream
: DataStream): PeerConnection
Creates a data-only peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:680
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, videoStream
: VideoStream): PeerConnection
Creates a video-only peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:688
▸ createPeerConnection(peerConnectionOffer
: PeerConnectionOffer, videoStream
: VideoStream, dataStream
: DataStream): PeerConnection
Creates a video/data peer connection in the answering role.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:697
▸ createPeerConnection(remoteClientInfo
: ClientInfo, audioStream
: AudioStream): PeerConnection
Creates an audio-only peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
audioStream |
AudioStream | The audio stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:705
▸ createPeerConnection(remoteClientInfo
: ClientInfo, audioStream
: AudioStream, dataStream
: DataStream): PeerConnection
Creates an audio/data peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:714
▸ createPeerConnection(remoteClientInfo
: ClientInfo, audioStream
: AudioStream, videoStream
: VideoStream): PeerConnection
Creates an audio/video peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:723
▸ createPeerConnection(remoteClientInfo
: ClientInfo, audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): PeerConnection
Creates an audio/video/data peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:733
▸ createPeerConnection(remoteClientInfo
: ClientInfo, dataStream
: DataStream): PeerConnection
Creates a data-only peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:741
▸ createPeerConnection(remoteClientInfo
: ClientInfo, videoStream
: VideoStream): PeerConnection
Creates a video-only peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
videoStream |
VideoStream | The video stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:749
▸ createPeerConnection(remoteClientInfo
: ClientInfo, videoStream
: VideoStream, dataStream
: DataStream): PeerConnection
Creates a video/data peer connection in the offering role.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: PeerConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:758
createSfuDownstreamConnection
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, audioStream
: AudioStream): SfuDownstreamConnection
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
audioStream |
AudioStream | The audio stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:886
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, audioStream
: AudioStream, dataStream
: DataStream): SfuDownstreamConnection
Creates an audio/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:895
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, audioStream
: AudioStream, videoStream
: VideoStream): SfuDownstreamConnection
Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:905
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): SfuDownstreamConnection
Creates an audio/video/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:915
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, dataStream
: DataStream): SfuDownstreamConnection
Creates a data-only SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:923
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, videoStream
: VideoStream): SfuDownstreamConnection
Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
videoStream |
VideoStream | The video stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:932
▸ createSfuDownstreamConnection(remoteConnectionInfo
: ConnectionInfo, videoStream
: VideoStream, dataStream
: DataStream): SfuDownstreamConnection
Creates a video/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:941
▸ createSfuDownstreamConnection(remoteMediaId
: string, audioStream
: AudioStream): SfuDownstreamConnection
Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
audioStream |
AudioStream | The audio stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:950
▸ createSfuDownstreamConnection(remoteMediaId
: string, audioStream
: AudioStream, dataStream
: DataStream): SfuDownstreamConnection
Creates an audio/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:959
▸ createSfuDownstreamConnection(remoteMediaId
: string, audioStream
: AudioStream, videoStream
: VideoStream): SfuDownstreamConnection
Creates an audio/video SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:968
▸ createSfuDownstreamConnection(remoteMediaId
: string, audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): SfuDownstreamConnection
Creates an audio/video/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:978
▸ createSfuDownstreamConnection(remoteMediaId
: string, dataStream
: DataStream): SfuDownstreamConnection
Creates a data-only SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:986
▸ createSfuDownstreamConnection(remoteMediaId
: string, videoStream
: VideoStream): SfuDownstreamConnection
Creates a video-only SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
videoStream |
VideoStream | The video stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:994
▸ createSfuDownstreamConnection(remoteMediaId
: string, videoStream
: VideoStream, dataStream
: DataStream): SfuDownstreamConnection
Creates a video/data SFU downstream connection.
Parameters:
Name | Type | Description |
---|---|---|
remoteMediaId |
string | The remote media identifier. |
videoStream |
VideoStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuDownstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1003
createSfuUpstreamConnection
▸ createSfuUpstreamConnection(audioStream
: AudioStream): SfuUpstreamConnection
Creates an audio-only SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1111
▸ createSfuUpstreamConnection(audioStream
: AudioStream, dataStream
: DataStream): SfuUpstreamConnection
Creates an audio/data SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1119
▸ createSfuUpstreamConnection(audioStream
: AudioStream, dataStream
: DataStream, mediaId
: string): SfuUpstreamConnection
Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1129
▸ createSfuUpstreamConnection(audioStream
: AudioStream, mediaId
: string): SfuUpstreamConnection
Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1138
▸ createSfuUpstreamConnection(audioStream
: AudioStream, videoStream
: VideoStream): SfuUpstreamConnection
Creates an audio/video SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1146
▸ createSfuUpstreamConnection(audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream): SfuUpstreamConnection
Creates an audio/video/data SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1155
▸ createSfuUpstreamConnection(audioStream
: AudioStream, videoStream
: VideoStream, dataStream
: DataStream, mediaId
: string): SfuUpstreamConnection
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The video stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1166
▸ createSfuUpstreamConnection(audioStream
: AudioStream, videoStream
: VideoStream, mediaId
: string): SfuUpstreamConnection
Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
audioStream |
AudioStream | The audio stream. |
videoStream |
VideoStream | The video stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1176
▸ createSfuUpstreamConnection(dataStream
: DataStream): SfuUpstreamConnection
Creates a data-only SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
dataStream |
DataStream | The data stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1183
▸ createSfuUpstreamConnection(dataStream
: DataStream, mediaId
: string): SfuUpstreamConnection
Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1192
▸ createSfuUpstreamConnection(videoStream
: VideoStream): SfuUpstreamConnection
Creates a video-only SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1199
▸ createSfuUpstreamConnection(videoStream
: VideoStream, dataStream
: DataStream): SfuUpstreamConnection
Creates a video/data SFU upstream connection.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1207
▸ createSfuUpstreamConnection(videoStream
: VideoStream, dataStream
: DataStream, mediaId
: string): SfuUpstreamConnection
Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
dataStream |
DataStream | The data stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1217
▸ createSfuUpstreamConnection(videoStream
: VideoStream, mediaId
: string): SfuUpstreamConnection
Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.
Parameters:
Name | Type | Description |
---|---|---|
videoStream |
VideoStream | The video stream. |
mediaId |
string | The media identifier, unique to this channel, for persistent SFU downstream connections. |
Returns: SfuUpstreamConnection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1226
fmliveswitchChannelInit
▸ Private
fmliveswitchChannelInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:126
getApplicationId
▸ getApplicationId(): string
Gets the application identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1401
getClaim
▸ getClaim(): ChannelClaim
Gets the claim.
Returns: ChannelClaim
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1413
getClientId
▸ getClientId(): string
Gets the client identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1425
getClientRoles
▸ getClientRoles(): string[]
Gets the client roles.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1437
getClientTag
▸ getClientTag(): string
Gets the client tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1449
getConnections
▸ getConnections(): ManagedConnectionCollection
Gets the active connections.
Returns: ManagedConnectionCollection
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1461
getDeviceAlias
▸ getDeviceAlias(): string
Gets the device alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1473
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1485
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37
getDynamicValue
▸ getDynamicValue(key
: string): Object
Gets a property value from the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: Object
The stored value, if found; otherwise null.
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58
getId
▸ getId(): string
Gets the channel identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1523
getMessageBytesReceived
▸ getMessageBytesReceived(): number
Gets the number of message bytes received.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1535
getMessageBytesSent
▸ getMessageBytesSent(): number
Gets the number of message bytes sent.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1547
getMessagesReceived
▸ getMessagesReceived(): number
Gets the number of messages received.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1559
getMessagesSent
▸ getMessagesSent(): number
Gets the number of messages sent.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1571
getRemoteClientInfo
▸ getRemoteClientInfo(clientId
: string): ClientInfo
Gets information about a remote client.
Parameters:
Name | Type | Description |
---|---|---|
clientId |
string | The client identifier. |
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1584
getRemoteClientInfos
▸ getRemoteClientInfos(): ClientInfo[]
Gets information about the remote client in this channel.
Returns: ClientInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1601
getRemoteConnectionInfo
▸ getRemoteConnectionInfo(connectionId
: string): ConnectionInfo
Gets information about a remote connection.
Parameters:
Name | Type | Description |
---|---|---|
connectionId |
string | The connection identifier. |
Returns: ConnectionInfo
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1618
getRemoteUpstreamConnectionInfos
▸ getRemoteUpstreamConnectionInfos(): ConnectionInfo[]
Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel.
Returns: ConnectionInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1636
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:10
getUserAlias
▸ getUserAlias(): string
Gets the user alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1666
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1678
invite
▸ invite(userId
: string, protocol
: string): Future<Invitation>
Invites a user into this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user id to invite. |
protocol |
string | The protocol to use for the invite. |
Returns: Future<Invitation>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1692
kick
▸ kick(): Future<Object>
Kicks this channel.
Returns: Future<Object>
A future that resolves when the channel has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1712
kickClient
▸ kickClient(remoteClientInfo
: ClientInfo): Future<Object>
Kicks a client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
Returns: Future<Object>
A future that resolves when the client has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1733
▸ kickClient(userId
: string, deviceId
: string, clientId
: string): Future<Object>
Kicks a client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
Returns: Future<Object>
A future that resolves when the client has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1743
kickConnection
▸ kickConnection(remoteConnectionInfo
: ConnectionInfo): Future<Object>
Kicks a connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
Returns: Future<Object>
A future that resolves when the connection has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1778
▸ kickConnection(userId
: string, deviceId
: string, clientId
: string, connectionId
: string): Future<Object>
Kicks a connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
connectionId |
string | The connection identifier. |
Returns: Future<Object>
A future that resolves when the connection has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1789
kickDevice
▸ kickDevice(userId
: string, deviceId
: string): Future<Object>
Kicks a device in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
Returns: Future<Object>
A future that resolves when the device has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1826
kickUser
▸ kickUser(userId
: string): Future<Object>
Kicks a user in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
Returns: Future<Object>
A future that resolves when the user has been kicked.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1847
rejectPeerConnection
▸ rejectPeerConnection(peerConnectionOffer
: PeerConnectionOffer): Future<Object>
Rejects a peer connection offer.
Parameters:
Name | Type | Description |
---|---|---|
peerConnectionOffer |
PeerConnectionOffer | The peer connection offer. |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2534
removeOnClaimUpdate
▸ removeOnClaimUpdate(value
: IAction2<ChannelClaim, ChannelClaim>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ChannelClaim, ChannelClaim> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2553
removeOnClientMessage
▸ removeOnClientMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2568
removeOnDeviceMessage
▸ removeOnDeviceMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2583
removeOnKick
▸ removeOnKick(value
: IAction0): void
Removes a handler that is raised when the client is kicked from the channel.
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2595
removeOnMcuVideoLayout
▸ removeOnMcuVideoLayout(value
: IAction1<VideoLayout>): void
Removes a handler that is raised when a new MCU video layout is received from the server. Parameters:
- videoLayout - the new MCU video layout
Parameters:
Name | Type |
---|---|
value |
IAction1<VideoLayout> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2609
removeOnMessage
▸ removeOnMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2624
removeOnPeerConnectionOffer
▸ removeOnPeerConnectionOffer(value
: IAction1<PeerConnectionOffer>): void
Removes a handler that is raised when a remote client wants to open a peer connection. Parameters:
- peerConnectionOffer - the peer connection offer
Parameters:
Name | Type |
---|---|
value |
IAction1<PeerConnectionOffer> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2638
removeOnRemoteClientJoin
▸ removeOnRemoteClientJoin(value
: IAction1<ClientInfo>): void
Removes a handler that is raised when a remote client joins this channel. Parameters:
- clientInfo - the remote client information
Parameters:
Name | Type |
---|---|
value |
IAction1<ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2652
removeOnRemoteClientLeave
▸ removeOnRemoteClientLeave(value
: IAction1<ClientInfo>): void
Removes a handler that is raised when a remote client leaves this channel. Parameters:
- clientInfo - the remote client information
Parameters:
Name | Type |
---|---|
value |
IAction1<ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2666
removeOnRemoteClientUpdate
▸ removeOnRemoteClientUpdate(value
: IAction2<ClientInfo, ClientInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, ClientInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2681
removeOnRemoteUpstreamConnectionClose
▸ removeOnRemoteUpstreamConnectionClose(value
: IAction1<ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction1<ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2696
removeOnRemoteUpstreamConnectionOpen
▸ removeOnRemoteUpstreamConnectionOpen(value
: IAction1<ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction1<ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2711
removeOnRemoteUpstreamConnectionUpdate
▸ removeOnRemoteUpstreamConnectionUpdate(value
: IAction2<ConnectionInfo, ConnectionInfo>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ConnectionInfo, ConnectionInfo> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2727
removeOnUserMessage
▸ removeOnUserMessage(value
: IAction2<ClientInfo, string>): void
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
Parameters:
Name | Type |
---|---|
value |
IAction2<ClientInfo, string> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2742
sendClientMessage
▸ sendClientMessage(userId
: string, deviceId
: string, clientId
: string, message
: string): Future<Object>
Sends a message to a client in the channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
message |
string | The message to be sent. |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2772
sendDeviceMessage
▸ sendDeviceMessage(userId
: string, deviceId
: string, message
: string): Future<Object>
Sends a message to a device in the channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
message |
string | The message to be sent. |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2799
sendMessage
▸ sendMessage(message
: string): Future<Object>
Sends a message to the channel.
Parameters:
Name | Type | Description |
---|---|---|
message |
string | The message to be sent. |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2821
sendUserMessage
▸ sendUserMessage(userId
: string, message
: string): Future<Object>
Sends a message to a user in the channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
message |
string | The message. |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2838
setDynamicValue
▸ setDynamicValue(key
: string, value
: Object): void
Sets a property value in the local cache.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
value |
Object | The property value. This can be any object that needs to be stored for future use. |
Returns: void
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95
unsetDynamicValue
▸ unsetDynamicValue(key
: string): boolean
Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions. |
Returns: boolean
true
if the value was removed; otherwise, false
.
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122
update
▸ update(newConfig
: ChannelConfig): Future<Object>
Updates this channel.
Parameters:
Name | Type | Description |
---|---|---|
newConfig |
ChannelConfig | The channel configuration. |
Returns: Future<Object>
A future that resolves when the channel has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2956
updateClient
▸ updateClient(remoteClientInfo
: ClientInfo, newConfig
: ChannelClientConfig): Future<Object>
Updates a client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
newConfig |
ChannelClientConfig | The client configuration. |
Returns: Future<Object>
A future that resolves when the client has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2978
▸ updateClient(userId
: string, deviceId
: string, clientId
: string, newConfig
: ChannelClientConfig): Future<Object>
Updates a client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
newConfig |
ChannelClientConfig | The client configuration. |
Returns: Future<Object>
A future that resolves when the client has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2989
updateClientLayout
▸ updateClientLayout(remoteClientInfo
: ClientInfo, newConfig
: ChannelClientLayoutConfig): Future<Object>
Applies a layout update to all upstream connections for the specified client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteClientInfo |
ClientInfo | The remote client information. |
newConfig |
ChannelClientLayoutConfig | The client configuration. |
Returns: Future<Object>
A future that resolves when the client layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3038
▸ updateClientLayout(userId
: string, deviceId
: string, clientId
: string, newConfig
: ChannelClientLayoutConfig): Future<Object>
Applies a layout update to all upstream connections for the specified client in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
newConfig |
ChannelClientLayoutConfig | The client configuration. |
Returns: Future<Object>
A future that resolves when the client layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3049
updateConnection
▸ updateConnection(remoteConnectionInfo
: ConnectionInfo, newConfig
: ChannelConnectionConfig): Future<Object>
Updates a connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
newConfig |
ChannelConnectionConfig | The connection configuration. |
Returns: Future<Object>
A future that resolves when the connection has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3087
▸ updateConnection(userId
: string, deviceId
: string, clientId
: string, connectionId
: string, newConfig
: ChannelConnectionConfig): Future<Object>
Updates a connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
connectionId |
string | The connection identifier. |
newConfig |
ChannelConnectionConfig | The connection configuration. |
Returns: Future<Object>
A future that resolves when the connection has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3099
updateConnectionLayout
▸ updateConnectionLayout(remoteConnectionInfo
: ConnectionInfo, newConfig
: ChannelConnectionLayoutConfig): Future<Object>
Updates a connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
remoteConnectionInfo |
ConnectionInfo | The remote connection information. |
newConfig |
ChannelConnectionLayoutConfig | The connection configuration. |
Returns: Future<Object>
A future that resolves when the connection has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3138
▸ updateConnectionLayout(userId
: string, deviceId
: string, clientId
: string, connectionId
: string, newConfig
: ChannelConnectionLayoutConfig): Future<Object>
Applies a layout update to the specified upstream connection in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
clientId |
string | The client identifier. |
connectionId |
string | The connection identifier. |
newConfig |
ChannelConnectionLayoutConfig | The connection configuration. |
Returns: Future<Object>
A future that resolves when the connection layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3150
updateDevice
▸ updateDevice(userId
: string, deviceId
: string, newConfig
: ChannelDeviceConfig): Future<Object>
Updates a device in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
newConfig |
ChannelDeviceConfig | The device configuration. |
Returns: Future<Object>
A future that resolves when the device has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3190
updateDeviceLayout
▸ updateDeviceLayout(userId
: string, deviceId
: string, newConfig
: ChannelDeviceLayoutConfig): Future<Object>
Applies a layout update to all upstream connections for the specified device in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
newConfig |
ChannelDeviceLayoutConfig | The device layout configuration. |
Returns: Future<Object>
A future that resolves when the device layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3213
updateLayout
▸ updateLayout(newLayoutConfig
: ChannelLayoutConfig): Future<Object>
Applies a layout update to all upstream connections on this channel
Parameters:
Name | Type | Description |
---|---|---|
newLayoutConfig |
ChannelLayoutConfig | The channel layout configuration. |
Returns: Future<Object>
A future that resolves when the channel layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3234
updateUser
▸ updateUser(userId
: string, newConfig
: ChannelUserConfig): Future<Object>
Updates a user in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
newConfig |
ChannelUserConfig | The user configuration. |
Returns: Future<Object>
A future that resolves when the user has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3256
updateUserLayout
▸ updateUserLayout(userId
: string, newLayoutConfig
: ChannelUserLayoutConfig): Future<Object>
Applies a layout update to all upstream connections for the specified user in this channel.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
newLayoutConfig |
ChannelUserLayoutConfig | The user layout configuration. |
Returns: Future<Object>
A future that resolves when the user layout has been updated.
Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:3278