/ fm / liveswitch / Channel

Class: Channel

fm.liveswitch.Channel

A channel.

Hierarchy

Table of contents

Methods

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:229

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:244

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:259

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:271

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:293

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:308

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:322

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:336

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:350

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:365

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:380

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:395

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:411

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:426

closeAll

▸ closeAll(): Future<Object>

Closes all active connections.

Returns: Future<Object>

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:438

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:457

▸ 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:465

▸ 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:476

▸ 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:486

▸ 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:494

▸ 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:503

▸ 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:515

▸ 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:526

▸ 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:533

▸ 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:543

▸ 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:550

▸ 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:558

▸ 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:569

▸ 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:579

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:665

▸ 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:674

▸ 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:683

▸ 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:693

▸ 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:701

▸ 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:709

▸ 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:718

▸ 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:726

▸ 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:735

▸ 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:744

▸ 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:754

▸ 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:762

▸ 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:770

▸ 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:779

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:909

▸ 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:918

▸ createSfuDownstreamConnection(remoteConnectionInfo: ConnectionInfo, audioStream: AudioStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:928

▸ 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:938

▸ 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:948

▸ createSfuDownstreamConnection(remoteConnectionInfo: ConnectionInfo, audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream the media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:959

▸ createSfuDownstreamConnection(remoteConnectionInfo: ConnectionInfo, audioStream: AudioStream, videoStream: VideoStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:970

▸ 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:978

▸ 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:987

▸ 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:996

▸ createSfuDownstreamConnection(remoteConnectionInfo: ConnectionInfo, videoStream: VideoStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1006

▸ 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:1015

▸ 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:1024

▸ createSfuDownstreamConnection(remoteMediaId: string, audioStream: AudioStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1034

▸ 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:1043

▸ 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:1053

▸ createSfuDownstreamConnection(remoteMediaId: string, audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream the media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1064

▸ createSfuDownstreamConnection(remoteMediaId: string, audioStream: AudioStream, videoStream: VideoStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1074

▸ 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:1082

▸ 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:1090

▸ 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:1099

▸ createSfuDownstreamConnection(remoteMediaId: string, videoStream: VideoStream, useWebSocketsForMedia: boolean): SfuDownstreamConnection

Creates a video-only SFU downstream connection.

Parameters:

Name Type Description
remoteMediaId string The remote media identifier.
videoStream VideoStream The video stream.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuDownstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1108

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:1266

▸ 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:1274

▸ 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:1284

▸ 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:1293

▸ createSfuUpstreamConnection(audioStream: AudioStream, mediaId: string, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1303

▸ createSfuUpstreamConnection(audioStream: AudioStream, useWebSocketsForMedia: boolean): SfuUpstreamConnection

Creates an audio-only SFU upstream connection.

Parameters:

Name Type Description
audioStream AudioStream The audio stream.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1311

▸ 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:1319

▸ 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:1328

▸ 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:1339

▸ createSfuUpstreamConnection(audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream, mediaId: string, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean A flag to indicate if we should send media over a WebSocket connection.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1351

▸ createSfuUpstreamConnection(audioStream: AudioStream, videoStream: VideoStream, dataStream: DataStream, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1361

▸ 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:1371

▸ createSfuUpstreamConnection(audioStream: AudioStream, videoStream: VideoStream, mediaId: string, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1382

▸ createSfuUpstreamConnection(audioStream: AudioStream, videoStream: VideoStream, useWebSocketsForMedia: boolean): SfuUpstreamConnection

Creates an audio/video SFU upstream connection.

Parameters:

Name Type Description
audioStream AudioStream The audio stream.
videoStream VideoStream The video stream.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1391

▸ 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:1398

▸ 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:1407

▸ 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:1414

▸ 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:1422

▸ 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:1432

▸ 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:1441

▸ createSfuUpstreamConnection(videoStream: VideoStream, mediaId: string, useWebSocketsForMedia: boolean): 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.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1451

▸ createSfuUpstreamConnection(videoStream: VideoStream, useWebSocketsForMedia: boolean): SfuUpstreamConnection

Creates a video-only SFU upstream connection.

Parameters:

Name Type Description
videoStream VideoStream The video stream.
useWebSocketsForMedia boolean Use WebSockets to stream this media instead of WebRTC.

Returns: SfuUpstreamConnection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1459

fmliveswitchChannelInit

▸ PrivatefmliveswitchChannelInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:134

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1705

getClaim

▸ getClaim(): ChannelClaim

Gets the claim.

Returns: ChannelClaim

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1717

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1729

getClientRoles

▸ getClientRoles(): string[]

Gets the client roles.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1741

getClientTag

▸ getClientTag(): string

Gets the client tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1753

getConnections

▸ getConnections(): ManagedConnectionCollection

Gets the active connections.

Returns: ManagedConnectionCollection

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1765

getDeviceAlias

▸ getDeviceAlias(): string

Gets the device alias.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1777

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1789

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:1827

getMessageBytesReceived

▸ getMessageBytesReceived(): number

Gets the number of message bytes received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1839

getMessageBytesSent

▸ getMessageBytesSent(): number

Gets the number of message bytes sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1851

getMessagesReceived

▸ getMessagesReceived(): number

Gets the number of messages received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1863

getMessagesSent

▸ getMessagesSent(): number

Gets the number of messages sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1875

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:1888

getRemoteClientInfos

▸ getRemoteClientInfos(): ClientInfo[]

Gets information about the remote client in this channel.

Returns: ClientInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1905

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:1922

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:1940

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:1970

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1982

getWebSocketAccessToken

▸ getWebSocketAccessToken(): string

Gets the WebSocket Media Server Authorization Token for this channel.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:1994

getWebSocketServerEndpointUrl

▸ getWebSocketServerEndpointUrl(): string

Gets the WebSocket Media Server Endpoint for this channel.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Channel.ts:2006

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:2020

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:2040

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:2061

▸ 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:2071

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:2106

▸ 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:2117

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:2154

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:2175

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:2881

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:2900

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:2915

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:2930

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:2942

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:2964

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:2979

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:2993

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:3007

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:3021

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:3036

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:3051

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:3066

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:3082

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:3097

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:3127

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:3154

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:3176

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:3193

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:3327

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:3349

▸ 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:3360

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:3409

▸ 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:3420

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:3458

▸ 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:3470

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:3509

▸ 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:3521

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:3561

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:3584

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:3605

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:3627

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:3649