/ fm / liveswitch / Message

Class: Message

fm.liveswitch.Message

A message.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new Message(): Message

Returns: Message

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:120

+ new Message(type: string): Message

Parameters:

Name Type
type string

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:121

Methods

clone

▸ clone(): Message

Creates a copy of the Message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1104

fmliveswitchMessageInit

▸ PrivatefmliveswitchMessageInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:112

getApiServiceId

▸ getApiServiceId(): string

Gets the API Service identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1163

getApiVersion

▸ getApiVersion(): string

Gets the API Version.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1175

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1187

getChannelId

▸ getChannelId(): string

Gets the channel identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1199

getChannelReports

▸ getChannelReports(): ChannelReport[]

Gets the channel reports.

Returns: ChannelReport[]

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1211

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1223

getClientProtocol

▸ getClientProtocol(): string

Gets the client protocol.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1235

getClientReports

▸ getClientReports(): ClientReport[]

Gets the client reports.

Returns: ClientReport[]

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1247

getClientRoles

▸ getClientRoles(): string[]

Gets the client roles.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1259

getClientTag

▸ getClientTag(): string

Gets the client tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1271

getConnectionId

▸ getConnectionId(): string

Gets the connection identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1283

getConnectionLayoutPriority

▸ getConnectionLayoutPriority(): number

Gets the connection LayoutPriority.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1295

getConnectionLayoutZone

▸ getConnectionLayoutZone(): string

Gets the connection LayoutZone.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1307

getConnectionTag

▸ getConnectionTag(): string

Gets the connection tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1319

getConnectionType

▸ getConnectionType(): string

Gets the connection type.

Returns: string

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

getConnectorId

▸ getConnectorId(): string

Gets the Connector identifer.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1343

getDeviceAlias

▸ getDeviceAlias(): string

Gets the device alias.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1355

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1367

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

getIceServers

▸ getIceServers(): string

Gets the payload.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1379

getIsHiddenObserver

▸ getIsHiddenObserver(): boolean

Gets if the offerer is a hidden observer.

Returns: boolean

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

getMediaId

▸ getMediaId(): string

Gets the broadcast identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1403

getMediaServerId

▸ getMediaServerId(): string

Gets the Media Server identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1426

getNoHostCandidates

▸ getNoHostCandidates(): boolean

Gets the value indicating whether the client should avoid using local host ICE candidates. Client can override this request.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1438

getPayload

▸ getPayload(): string

Gets the payload.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1450

getPreferredMediaServerId

▸ getPreferredMediaServerId(): string

Gets the preferred Media Server identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1462

getPreferredWebSocketMediaServerId

▸ getPreferredWebSocketMediaServerId(): string

Gets the preferred WebSocket Media Server identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1474

getRecordingMonitorId

▸ getRecordingMonitorId(): string

Gets the Recording Monitor identifer.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1486

getRecordingMoverId

▸ getRecordingMoverId(): string

Gets the Recording Mover identifer.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1498

getRecordingMuxerId

▸ getRecordingMuxerId(): string

Gets the Recording Muxer identifer.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1510

getRegion

▸ getRegion(): string

Gets the region.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1522

getRemoteClientId

▸ getRemoteClientId(): string

Gets the remote client identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1534

getRemoteConnectionId

▸ getRemoteConnectionId(): string

Gets the remote connection identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1546

getRemoteDeviceId

▸ getRemoteDeviceId(): string

Gets the remote device identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1558

getRemoteMediaId

▸ getRemoteMediaId(): string

Gets the remote broadcast identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1570

getRemoteUserId

▸ getRemoteUserId(): string

Gets the remote user identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1582

getRequestIceServers

▸ getRequestIceServers(): boolean

Gets the value indicating whether ICE Servers have been requested.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1594

getTimestamp

▸ getTimestamp(): number

Gets the message timestamp.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1622

getToken

▸ getToken(): string

Gets the token.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1634

getTransactionId

▸ getTransactionId(): string

Gets the transaction identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1646

getType

▸ getType(): string

Gets the type.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1658

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:10

getUserAlias

▸ getUserAlias(): string

Gets the user alias.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1670

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1682

getWebSocketMediaServerId

▸ getWebSocketMediaServerId(): string

Gets the Media Server identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1702

isError

▸ isError(errorType: string): boolean

Gets whether this message is an error of a particular type.

Parameters:

Name Type Description
errorType string The error type.

Returns: boolean

true if this message is an error of the particular type; otherwise, false.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1724

setApiServiceId

▸ setApiServiceId(value: string): void

Sets the API Service identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2048

setApiVersion

▸ setApiVersion(value: string): void

Sets the API Version.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2060

setApplicationId

▸ setApplicationId(value: string): void

Sets the application identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2072

setChannelId

▸ setChannelId(value: string): void

Sets the channel identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2084

setChannelReports

▸ setChannelReports(value: ChannelReport[]): void

Sets the channel reports.

Parameters:

Name Type
value ChannelReport[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2096

setClientId

▸ setClientId(value: string): void

Sets the client identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2108

setClientProtocol

▸ setClientProtocol(value: string): void

Sets the client protocol.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2120

setClientReports

▸ setClientReports(value: ClientReport[]): void

Sets the client reports.

Parameters:

Name Type
value ClientReport[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2132

setClientRoles

▸ setClientRoles(value: string[]): void

Sets the client roles.

Parameters:

Name Type
value string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2144

setClientTag

▸ setClientTag(value: string): void

Sets the client tag.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2156

setConnectionId

▸ setConnectionId(value: string): void

Sets the connection identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2168

setConnectionLayoutPriority

▸ setConnectionLayoutPriority(value: number): void

Sets the connection LayoutPriority.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2180

setConnectionLayoutZone

▸ setConnectionLayoutZone(value: string): void

Sets the connection LayoutZone.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2192

setConnectionTag

▸ setConnectionTag(value: string): void

Sets the connection tag.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2204

setConnectionType

▸ setConnectionType(value: string): void

Sets the connection type.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2216

setConnectorId

▸ setConnectorId(value: string): void

Sets the Connector identifer.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2228

setDeviceAlias

▸ setDeviceAlias(value: string): void

Sets the device alias.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2240

setDeviceId

▸ setDeviceId(value: string): void

Sets the device identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2252

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

setIceServers

▸ setIceServers(value: string): void

Sets the payload.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2264

setIsHiddenObserver

▸ setIsHiddenObserver(value: boolean): void

Sets if the offerer is a hidden observer.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2276

setMediaId

▸ setMediaId(value: string): void

Sets the broadcast identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2288

setMediaServerId

▸ setMediaServerId(value: string): void

Sets the Media Server identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2308

setNoHostCandidates

▸ setNoHostCandidates(value: boolean): void

Sets the value indicating whether the client should avoid using local host ICE candidates. Client can override this request.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2320

setPayload

▸ setPayload(value: string): void

Sets the payload.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2332

setPreferredMediaServerId

▸ setPreferredMediaServerId(value: string): void

Sets the preferred Media Server identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2344

setPreferredWebSocketMediaServerId

▸ setPreferredWebSocketMediaServerId(value: string): void

Sets the preferred WebSocket Media Server identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2356

setRecordingMonitorId

▸ setRecordingMonitorId(value: string): void

Sets the Recording Monitor identifer.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2368

setRecordingMoverId

▸ setRecordingMoverId(value: string): void

Sets the Recording Mover identifer.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2380

setRecordingMuxerId

▸ setRecordingMuxerId(value: string): void

Sets the Recording Muxer identifer.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2392

setRegion

▸ setRegion(value: string): void

Sets the region.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2404

setRemoteClientId

▸ setRemoteClientId(value: string): void

Sets the remote client identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2416

setRemoteConnectionId

▸ setRemoteConnectionId(value: string): void

Sets the remote connection identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2428

setRemoteDeviceId

▸ setRemoteDeviceId(value: string): void

Sets the remote device identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2440

setRemoteMediaId

▸ setRemoteMediaId(value: string): void

Sets the remote broadcast identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2452

setRemoteUserId

▸ setRemoteUserId(value: string): void

Sets the remote user identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2464

setRequestIceServers

▸ setRequestIceServers(value: boolean): void

Sets the value indicating whether ICE Servers have been requested.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2476

setTimestamp

▸ setTimestamp(value: number): void

Sets the message timestamp.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2504

setToken

▸ setToken(value: string): void

Sets the token.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2517

setTransactionId

▸ setTransactionId(value: string): void

Sets the transaction identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2529

setType

▸ setType(value: string): void

Sets the type.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2541

setUserAlias

▸ setUserAlias(value: string): void

Sets the user alias.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2553

setUserId

▸ setUserId(value: string): void

Sets the user identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2565

setWebSocketMediaServerId

▸ setWebSocketMediaServerId(value: string): void

Sets the Media Server identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2585

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:2605

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

createBitrateNotificationMessage

▸ StaticcreateBitrateNotificationMessage(bitrateNotification: BitrateNotification): Message

Creates a "bitrateNotification" message.

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:146

▸ StaticcreateBitrateNotificationMessage(bitrateNotifications: BitrateNotification[]): Message

Creates a "bitrateNotification" message.

Parameters:

Name Type
bitrateNotifications BitrateNotification[]

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:152

createBitrateRequestMessage

▸ StaticcreateBitrateRequestMessage(bitrateRequest: BitrateRequest): Message

Creates a "bitrateRequest" message.

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:171

▸ StaticcreateBitrateRequestMessage(bitrateRequests: BitrateRequest[]): Message

Creates a "bitrateRequest" message.

Parameters:

Name Type
bitrateRequests BitrateRequest[]

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:177

createCancelInviteMessage

▸ StaticcreateCancelInviteMessage(userId: string, protocol: string): Message

Creates a "cancelInvite" message.

Parameters:

Name Type
userId string
protocol string

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:196

createCandidateMessage

▸ StaticcreateCandidateMessage(candidateJson: string): Message

Creates a "candidate" message.

Parameters:

Name Type Description
candidateJson string The candidate.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:212

createCloseMessage

▸ StaticcreateCloseMessage(): Message

Creates a "close" message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:226

createDtmfTonesMessage

▸ StaticcreateDtmfTonesMessage(dtmfTones: Tone[]): Message

Creates a "dtmfTones" message.

Parameters:

Name Type
dtmfTones Tone[]

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:238

createErrorMessage

▸ StaticcreateErrorMessage(error: string): Message

Creates a "error" message.

Parameters:

Name Type Description
error string The error type.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:253

▸ StaticcreateErrorMessage(error: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a "error" message.

Parameters:

Name Type Description
error string The error type.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:263

createEventMessage

▸ StaticcreateEventMessage(eventInfoJson: string): Message

Creates an "event" message.

Parameters:

Name Type
eventInfoJson string

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:290

createIceServersMessage

▸ StaticcreateIceServersMessage(): Message

Creates an "iceServers" message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:304

createInviteMessage

▸ StaticcreateInviteMessage(userId: string, protocol: string): Message

Creates a "invite" message.

Parameters:

Name Type
userId string
protocol string

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:316

createJoinMessage

▸ StaticcreateJoinMessage(channelId: string, token: string): Message

Creates a "join" message.

Parameters:

Name Type Description
channelId string The channel to join.
token string The auth token.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:333

createKeyFrameRequestMessage

▸ StaticcreateKeyFrameRequestMessage(synchronizationSources: number[]): Message

Creates a "keyFrameRequest" message.

Parameters:

Name Type
synchronizationSources number[]

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:348

createKickMessage

▸ StaticcreateKickMessage(channelId: string, clientId: string): Message

Creates a "kick" message.

Parameters:

Name Type Description
channelId string The channel identifier.
clientId string The ID of the client to kick.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:364

▸ StaticcreateKickMessage(remoteUserId: string, remoteDeviceId: string, remoteClientId: string, remoteConnectionId: string): Message

Creates a "kick" message.

Parameters:

Name Type Description
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.
remoteConnectionId string The remote connection identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:374

createLayoutMessage

▸ StaticcreateLayoutMessage(configJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string, remoteConnectionId: string): Message

Creates a "layout" message.

Parameters:

Name Type Description
configJson string The layout config to send to the server.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.
remoteConnectionId string The remote connection identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:408

createLeaveMessage

▸ StaticcreateLeaveMessage(channelId: string, channelReport: ChannelReport): Message

Creates a "leave" message.

Parameters:

Name Type Description
channelId string The channel to leave.
channelReport ChannelReport The channel report.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:428

createMcuOfferMessage

▸ StaticcreateMcuOfferMessage(layoutZone: string, layoutPriority: number, tag: string, offerJson: string): Message

Creates an MCU "offer" message

Parameters:

Name Type Description
layoutZone string The connection LayoutZone
layoutPriority number The connection LayoutPriority
tag string The tag
offerJson string The offer.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:447

▸ StaticcreateMcuOfferMessage(tag: string, offerJson: string): Message

Creates an MCU "offer" message.

Parameters:

Name Type Description
tag string The tag.
offerJson string The offer.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:455

createMessageMessage

▸ StaticcreateMessageMessage(message: string): Message

Creates a "message" message.

Parameters:

Name Type Description
message string The message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:509

▸ StaticcreateMessageMessage(message: string, remoteUserId: string): Message

Creates a "message" message.

Parameters:

Name Type Description
message string The message.
remoteUserId string The remote user identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:517

▸ StaticcreateMessageMessage(message: string, remoteUserId: string, remoteDeviceId: string): Message

Creates a "message" message.

Parameters:

Name Type Description
message string The message.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:526

▸ StaticcreateMessageMessage(message: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a "message" message.

Parameters:

Name Type Description
message string The message.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:536

createPeerAnswerMessage

▸ StaticcreatePeerAnswerMessage(tag: string, answerJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a peer "answer" message.

Parameters:

Name Type Description
tag string The tag.
answerJson string The answer.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:575

createPeerCandidateMessage

▸ StaticcreatePeerCandidateMessage(candidateJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a "candidate" message.

Parameters:

Name Type Description
candidateJson string The candidate.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:598

createPeerCloseMessage

▸ StaticcreatePeerCloseMessage(remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a "close" message.

Parameters:

Name Type Description
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:618

createPeerOfferMessage

▸ StaticcreatePeerOfferMessage(tag: string, offerJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates a peer "offer" message.

Parameters:

Name Type Description
tag string The tag.
offerJson string The offer.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:639

createPeerRejectMessage

▸ StaticcreatePeerRejectMessage(remoteUserId: string, remoteDeviceId: string, remoteClientId: string, remoteConnectionId: string): Message

Creates a "reject" message.

Parameters:

Name Type Description
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.
remoteConnectionId string The remote connection identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:662

createRegisterMessage

▸ StaticcreateRegisterMessage(applicationId: string, userId: string, userAlias: string, deviceId: string, deviceAlias: string, clientId: string, clientTag: string, clientRoles: string[], region: string, token: string): Message

Creates a "register" message.

Parameters:

Name Type Description
applicationId string The application identifier.
userId string The user identifier.
userAlias string The user alias.
deviceId string The device identifier.
deviceAlias string The device alias.
clientId string The client identifier.
clientTag string The client tag.
clientRoles string[] The client roles.
region string The region.
token string The auth token.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:690

createRtcpDataChannelSignallingActivationMessage

▸ StaticcreateRtcpDataChannelSignallingActivationMessage(supportedMessageTypes: RtcpDataChannelSignallingActivation): Message

Creates a "activateInbandSignalling" message.

Parameters:

Name Type
supportedMessageTypes RtcpDataChannelSignallingActivation

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:728

createSfuOfferMessage

▸ StaticcreateSfuOfferMessage(layoutZone: string, layoutPriority: number, tag: string, offerJson: string): Message

Creates an SFU upstream "offer" message.

Parameters:

Name Type Description
layoutZone string The connection LayoutZone
layoutPriority number The connection LayoutPriority
tag string The tag
offerJson string The offer.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:746

▸ StaticcreateSfuOfferMessage(tag: string, offerJson: string): Message

Creates an SFU upstream "offer" message.

Parameters:

Name Type Description
tag string The tag.
offerJson string The offer.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:754

▸ StaticcreateSfuOfferMessage(tag: string, offerJson: string, remoteMediaId: string): Message

Creates an SFU downstream "offer" message.

Parameters:

Name Type Description
tag string The tag.
offerJson string The offer.
remoteMediaId string The remote media identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:763

▸ StaticcreateSfuOfferMessage(tag: string, offerJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string, remoteConnectionId: string): Message

Creates an SFU downstream "offer" message.

Parameters:

Name Type Description
tag string The tag.
offerJson string The offer.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.
remoteConnectionId string The remote connection identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:775

createSimulcastNotificationMessage

▸ StaticcreateSimulcastNotificationMessage(simulcastNotification: SimulcastNotification): Message

Creates a "simulcastNotification" message.

Parameters:

Name Type
simulcastNotification SimulcastNotification

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:832

▸ StaticcreateSimulcastNotificationMessage(simulcastNotifications: SimulcastNotification[]): Message

Creates a "simulcastNotification" message.

Parameters:

Name Type
simulcastNotifications SimulcastNotification[]

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:838

createUnregisterMessage

▸ StaticcreateUnregisterMessage(): Message

Creates an "unregister" message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:857

▸ StaticcreateUnregisterMessage(clientReport: ClientReport, channelReports: ChannelReport[]): Message

Creates an "unregister" message.

Parameters:

Name Type Description
clientReport ClientReport The client report.
channelReports ChannelReport[] The channel reports.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:865

createUpdateMessage

▸ StaticcreateUpdateMessage(configJson: string): Message

Creates an "update" message.

Parameters:

Name Type Description
configJson string The config to send to the server.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:886

▸ StaticcreateUpdateMessage(configJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string): Message

Creates an "update" message.

Parameters:

Name Type Description
configJson string The config to send to the server.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:896

▸ StaticcreateUpdateMessage(configJson: string, remoteUserId: string, remoteDeviceId: string, remoteClientId: string, remoteConnectionId: string): Message

Creates an "update" message.

Parameters:

Name Type Description
configJson string The config to send to the server.
remoteUserId string The remote user identifier.
remoteDeviceId string The remote device identifier.
remoteClientId string The remote client identifier.
remoteConnectionId string The remote connection identifier.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:907

fromJson

▸ StaticfromJson(messageJson: string): Message

Deserializes an instance from JSON.

Parameters:

Name Type Description
messageJson string The JSON to deserialize.

Returns: Message

The deserialized message.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1017

fromJsonArray

▸ StaticfromJsonArray(messagesJson: string): Message[]

Deserializes an array of instances from JSON.

Parameters:

Name Type Description
messagesJson string The JSON to deserialize.

Returns: Message[]

The deserialized messages.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1037

toJson

▸ StatictoJson(message: Message): string

Serializes an instance to JSON.

Parameters:

Name Type Description
message Message The message to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1057

▸ StatictoJson(message: Message, forceTimestamp: boolean): string

Serializes an instance to JSON and forces timestamp regardless of what generates Json.

Parameters:

Name Type Description
message Message The message to serialize.
forceTimestamp boolean Indicates whether timestamp must be included regardless of where serialization occurs.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1068

toJsonArray

▸ StatictoJsonArray(messages: Message[]): string

Serializes an array of instances to JSON.

Parameters:

Name Type Description
messages Message[] The messages to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/Message.ts:1092