/ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:212

addOnClientMessage

▸ addOnClientMessage(value: IAction2<ClientInfo, string>): void

Adds a handler that is raised when a client 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:222

addOnDeviceMessage

▸ addOnDeviceMessage(value: IAction2<ClientInfo, string>): void

Adds a handler that is raised when a device 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:232

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:242

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:252

addOnMessage

▸ addOnMessage(value: IAction2<ClientInfo, string>): void

Adds a handler that is raised when a channel 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:262

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:272

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:282

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:292

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:302

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:312

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:322

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:332

addOnUserMessage

▸ addOnUserMessage(value: IAction2<ClientInfo, string>): void

Adds a handler that is raised when a user 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:342

closeAll

▸ closeAll(): Future<Object>

Closes all active connections.

Returns: Future<Object>

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

createMcuConnection

▸ createMcuConnection(audioStream: AudioStream): McuConnection

Creates an audio-only MCU connection.

Parameters:

Name Type Description
audioStream AudioStream The audio stream.

Returns: McuConnection

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

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:374

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:381

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:387

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:393

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:400

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:408

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:415

▸ createMcuConnection(dataStream: DataStream): McuConnection

Creates a data-only MCU connection.

Parameters:

Name Type Description
dataStream DataStream The data stream.

Returns: McuConnection

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

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:426

▸ createMcuConnection(videoStream: VideoStream): McuConnection

Creates a video-only MCU connection.

Parameters:

Name Type Description
videoStream VideoStream The video stream.

Returns: McuConnection

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

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:437

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:444

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:450

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:532

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:539

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:546

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:554

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:560

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:566

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:573

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:579

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:586

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:593

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:601

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:607

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:613

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:620

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:745

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:752

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:759

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:767

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:773

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:779

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:786

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:792

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:799

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:806

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:814

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:820

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:826

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:833

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:939

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:945

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:952

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:958

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:964

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:971

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:979

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:986

▸ createSfuUpstreamConnection(dataStream: DataStream): SfuUpstreamConnection

Creates a data-only SFU upstream connection.

Parameters:

Name Type Description
dataStream DataStream The data stream.

Returns: SfuUpstreamConnection

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

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:997

▸ createSfuUpstreamConnection(videoStream: VideoStream): SfuUpstreamConnection

Creates a video-only SFU upstream connection.

Parameters:

Name Type Description
videoStream VideoStream The video stream.

Returns: SfuUpstreamConnection

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

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:1008

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:1015

▸ 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:1021

fmliveswitchChannelInit

▸ PrivatefmliveswitchChannelInit(): void

Returns: void

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

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

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

getClaim

▸ getClaim(): ChannelClaim

Gets the claim.

Returns: ChannelClaim

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

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

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

getClientRoles

▸ getClientRoles(): string[]

Gets the client roles.

Returns: string[]

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

getClientTag

▸ getClientTag(): string

Gets the client tag.

Returns: string

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

getConnections

▸ getConnections(): ManagedConnectionCollection

Gets the active connections.

Returns: ManagedConnectionCollection

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

getDeviceAlias

▸ getDeviceAlias(): string

Gets the device alias.

Returns: string

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

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

Defined in: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:32

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getId

▸ getId(): string

Gets the channel identifier.

Returns: string

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

getMessageBytesReceived

▸ getMessageBytesReceived(): number

Gets the number of message bytes received.

Returns: number

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

getMessageBytesSent

▸ getMessageBytesSent(): number

Gets the number of message bytes sent.

Returns: number

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

getMessagesReceived

▸ getMessagesReceived(): number

Gets the number of messages received.

Returns: number

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

getMessagesSent

▸ getMessagesSent(): number

Gets the number of messages sent.

Returns: number

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

getRemoteClientInfo

▸ getRemoteClientInfo(clientId: string): ClientInfo

Gets information about a remote client.

Parameters:

Name Type Description
clientId string The client identifier.

Returns: ClientInfo

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

getRemoteClientInfos

▸ getRemoteClientInfos(): ClientInfo[]

Gets information about the remote client in this channel.

Returns: ClientInfo[]

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

getRemoteConnectionInfo

▸ getRemoteConnectionInfo(connectionId: string): ConnectionInfo

Gets information about a remote connection.

Parameters:

Name Type Description
connectionId string The connection identifier.

Returns: ConnectionInfo

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

getRemoteUpstreamConnectionInfos

▸ getRemoteUpstreamConnectionInfos(): ConnectionInfo[]

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

Returns: ConnectionInfo[]

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

getUserAlias

▸ getUserAlias(): string

Gets the user alias.

Returns: string

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

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

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

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:1426

kickClient

▸ kickClient(remoteClientInfo: ClientInfo): Future<Object>

Kicks a client from this channel if the kick permission is enabled.

Parameters:

Name Type Description
remoteClientInfo ClientInfo The remote client to kick.

Returns: Future<Object>

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

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2087

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2101

removeOnClientMessage

▸ removeOnClientMessage(value: IAction2<ClientInfo, string>): void

Removes a handler that is raised when a client 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2111

removeOnDeviceMessage

▸ removeOnDeviceMessage(value: IAction2<ClientInfo, string>): void

Removes a handler that is raised when a device 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2121

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2131

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2141

removeOnMessage

▸ removeOnMessage(value: IAction2<ClientInfo, string>): void

Removes a handler that is raised when a channel 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2151

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2161

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2171

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2181

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2191

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2201

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2211

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2221

removeOnUserMessage

▸ removeOnUserMessage(value: IAction2<ClientInfo, string>): void

Removes a handler that is raised when a user 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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2231

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2259

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2284

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2304

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: fm/Generated/TypeScript/fm.liveswitch/Channel.ts:2319

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets 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.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: Dynamic

Defined in: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:111

update

▸ update(newConfig: ChannelConfig): Future<Object>

Updates the configuration for this channel.

Parameters:

Name Type Description
newConfig ChannelConfig The new recording configuration

Returns: Future<Object>

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