Search Results for

    / fm / liveswitch / Message

    Class: Message

    fm.liveswitch.Message

    A message.

    Hierarchy

    • Dynamic

      ↳ Message

    Table of contents

    Constructors

    • constructor

    Methods

    • clone
    • fmliveswitchMessageInit
    • getApiServiceId
    • getApiVersion
    • getApplicationId
    • getChannelId
    • getChannelReports
    • getClientId
    • getClientProtocol
    • getClientReports
    • getClientRoles
    • getClientTag
    • getConnectionId
    • getConnectionTag
    • getConnectionType
    • getConnectorId
    • getDeviceAlias
    • getDeviceId
    • getDynamicProperties
    • getDynamicValue
    • getMediaId
    • getMediaServerId
    • getPayload
    • getPreferredMediaServerId
    • getRecordingMonitorId
    • getRecordingMoverId
    • getRecordingMuxerId
    • getRegion
    • getRemoteClientId
    • getRemoteConnectionId
    • getRemoteDeviceId
    • getRemoteMediaId
    • getRemoteUserId
    • getTimestamp
    • getToken
    • getTransactionId
    • getType
    • getTypeString
    • getUserAlias
    • getUserId
    • isError
    • setApiServiceId
    • setApiVersion
    • setApplicationId
    • setChannelId
    • setChannelReports
    • setClientId
    • setClientProtocol
    • setClientReports
    • setClientRoles
    • setClientTag
    • setConnectionId
    • setConnectionTag
    • setConnectionType
    • setConnectorId
    • setDeviceAlias
    • setDeviceId
    • setDynamicValue
    • setMediaId
    • setMediaServerId
    • setPayload
    • setPreferredMediaServerId
    • setRecordingMonitorId
    • setRecordingMoverId
    • setRecordingMuxerId
    • setRegion
    • setRemoteClientId
    • setRemoteConnectionId
    • setRemoteDeviceId
    • setRemoteMediaId
    • setRemoteUserId
    • setTimestamp
    • setToken
    • setTransactionId
    • setType
    • setUserAlias
    • setUserId
    • toJson
    • unsetDynamicValue
    • createBitrateNotificationMessage
    • createBitrateRequestMessage
    • createCancelInviteMessage
    • createCandidateMessage
    • createCloseMessage
    • createDtmfTonesMessage
    • createErrorMessage
    • createEventMessage
    • createIceServersMessage
    • createInviteMessage
    • createJoinMessage
    • createKeyFrameRequestMessage
    • createKickMessage
    • createLeaveMessage
    • createMcuOfferMessage
    • createMessageMessage
    • createPeerAnswerMessage
    • createPeerCandidateMessage
    • createPeerCloseMessage
    • createPeerOfferMessage
    • createPeerRejectMessage
    • createRegisterMessage
    • createRtcpDataChannelSignallingActivationMessage
    • createSfuOfferMessage
    • createUnregisterMessage
    • createUpdateMessage
    • fromJson
    • fromJsonArray
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new Message(): Message

    Returns: Message

    Inherited from: Dynamic

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

    + new Message(type: string): Message

    Parameters:

    Name Type
    type string

    Returns: Message

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

    Methods

    clone

    ▸ clone(): Message

    Creates a copy of the Message.

    Returns: Message

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


    fmliveswitchMessageInit

    ▸ PrivatefmliveswitchMessageInit(): void

    Returns: void

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


    getApiServiceId

    ▸ getApiServiceId(): string

    Gets the API Service identifier.

    Returns: string

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


    getApiVersion

    ▸ getApiVersion(): string

    Gets the API Version.

    Returns: string

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


    getApplicationId

    ▸ getApplicationId(): string

    Gets the application identifier.

    Returns: string

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


    getChannelId

    ▸ getChannelId(): string

    Gets the channel identifier.

    Returns: string

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


    getChannelReports

    ▸ getChannelReports(): ChannelReport[]

    Gets the channel reports.

    Returns: ChannelReport[]

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


    getClientId

    ▸ getClientId(): string

    Gets the client identifier.

    Returns: string

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


    getClientProtocol

    ▸ getClientProtocol(): string

    Gets the client protocol.

    Returns: string

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


    getClientReports

    ▸ getClientReports(): ClientReport[]

    Gets the client reports.

    Returns: ClientReport[]

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


    getClientRoles

    ▸ getClientRoles(): string[]

    Gets the client roles.

    Returns: string[]

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


    getClientTag

    ▸ getClientTag(): string

    Gets the client tag.

    Returns: string

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


    getConnectionId

    ▸ getConnectionId(): string

    Gets the connection identifier.

    Returns: string

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


    getConnectionTag

    ▸ getConnectionTag(): string

    Gets the connection tag.

    Returns: string

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


    getConnectionType

    ▸ getConnectionType(): string

    Gets the connection type.

    Returns: string

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


    getConnectorId

    ▸ getConnectorId(): string

    Gets the Connector identifer.

    Returns: string

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


    getDeviceAlias

    ▸ getDeviceAlias(): string

    Gets the device alias.

    Returns: string

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


    getDeviceId

    ▸ getDeviceId(): string

    Gets the device identifier.

    Returns: string

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


    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


    getMediaId

    ▸ getMediaId(): string

    Gets the broadcast identifier.

    Returns: string

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


    getMediaServerId

    ▸ getMediaServerId(): string

    Gets the Media Server identifier.

    Returns: string

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


    getPayload

    ▸ getPayload(): string

    Gets the payload.

    Returns: string

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


    getPreferredMediaServerId

    ▸ getPreferredMediaServerId(): string

    Gets the preferred Media Server identifier.

    Returns: string

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


    getRecordingMonitorId

    ▸ getRecordingMonitorId(): string

    Gets the Recording Monitor identifer.

    Returns: string

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


    getRecordingMoverId

    ▸ getRecordingMoverId(): string

    Gets the Recording Mover identifer.

    Returns: string

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


    getRecordingMuxerId

    ▸ getRecordingMuxerId(): string

    Gets the Recording Muxer identifer.

    Returns: string

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


    getRegion

    ▸ getRegion(): string

    Gets the region.

    Returns: string

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


    getRemoteClientId

    ▸ getRemoteClientId(): string

    Gets the remote client identifier.

    Returns: string

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


    getRemoteConnectionId

    ▸ getRemoteConnectionId(): string

    Gets the remote connection identifier.

    Returns: string

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


    getRemoteDeviceId

    ▸ getRemoteDeviceId(): string

    Gets the remote device identifier.

    Returns: string

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


    getRemoteMediaId

    ▸ getRemoteMediaId(): string

    Gets the remote broadcast identifier.

    Returns: string

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


    getRemoteUserId

    ▸ getRemoteUserId(): string

    Gets the remote user identifier.

    Returns: string

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


    getTimestamp

    ▸ getTimestamp(): number

    Gets the message timestamp.

    Returns: number

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


    getToken

    ▸ getToken(): string

    Gets the token.

    Returns: string

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


    getTransactionId

    ▸ getTransactionId(): string

    Gets the transaction identifier.

    Returns: string

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


    getType

    ▸ getType(): string

    Gets the type.

    Returns: string

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


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


    getUserId

    ▸ getUserId(): string

    Gets the user identifier.

    Returns: string

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


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


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


    setApiVersion

    ▸ setApiVersion(value: string): void

    Sets the API Version.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setApplicationId

    ▸ setApplicationId(value: string): void

    Sets the application identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setChannelId

    ▸ setChannelId(value: string): void

    Sets the channel identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setChannelReports

    ▸ setChannelReports(value: ChannelReport[]): void

    Sets the channel reports.

    Parameters:

    Name Type
    value ChannelReport[]

    Returns: void

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


    setClientId

    ▸ setClientId(value: string): void

    Sets the client identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setClientProtocol

    ▸ setClientProtocol(value: string): void

    Sets the client protocol.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setClientReports

    ▸ setClientReports(value: ClientReport[]): void

    Sets the client reports.

    Parameters:

    Name Type
    value ClientReport[]

    Returns: void

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


    setClientRoles

    ▸ setClientRoles(value: string[]): void

    Sets the client roles.

    Parameters:

    Name Type
    value string[]

    Returns: void

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


    setClientTag

    ▸ setClientTag(value: string): void

    Sets the client tag.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setConnectionId

    ▸ setConnectionId(value: string): void

    Sets the connection identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setConnectionTag

    ▸ setConnectionTag(value: string): void

    Sets the connection tag.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setConnectionType

    ▸ setConnectionType(value: string): void

    Sets the connection type.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setConnectorId

    ▸ setConnectorId(value: string): void

    Sets the Connector identifer.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setDeviceAlias

    ▸ setDeviceAlias(value: string): void

    Sets the device alias.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setDeviceId

    ▸ setDeviceId(value: string): void

    Sets the device identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    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


    setMediaId

    ▸ setMediaId(value: string): void

    Sets the broadcast identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


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


    setPayload

    ▸ setPayload(value: string): void

    Sets the payload.

    Parameters:

    Name Type
    value string

    Returns: void

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


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


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


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


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


    setRegion

    ▸ setRegion(value: string): void

    Sets the region.

    Parameters:

    Name Type
    value string

    Returns: void

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


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


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


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


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


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


    setTimestamp

    ▸ setTimestamp(value: number): void

    Sets the message timestamp.

    Parameters:

    Name Type
    value number

    Returns: void

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


    setToken

    ▸ setToken(value: string): void

    Sets the token.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setTransactionId

    ▸ setTransactionId(value: string): void

    Sets the transaction identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setType

    ▸ setType(value: string): void

    Sets the type.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setUserAlias

    ▸ setUserAlias(value: string): void

    Sets the user alias.

    Parameters:

    Name Type
    value string

    Returns: void

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


    setUserId

    ▸ setUserId(value: string): void

    Sets the user identifier.

    Parameters:

    Name Type
    value string

    Returns: void

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


    toJson

    ▸ toJson(): string

    Serializes this instance to JSON.

    Returns: string

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


    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


    createBitrateNotificationMessage

    ▸ StaticcreateBitrateNotificationMessage(bitrateNotification: BitrateNotification): Message

    Creates a "bitrateNotification" message.

    Parameters:

    Name Type
    bitrateNotification BitrateNotification

    Returns: Message

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

    ▸ StaticcreateBitrateNotificationMessage(bitrateNotifications: BitrateNotification[]): Message

    Creates a "bitrateNotification" message.

    Parameters:

    Name Type
    bitrateNotifications BitrateNotification[]

    Returns: Message

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


    createBitrateRequestMessage

    ▸ StaticcreateBitrateRequestMessage(bitrateRequest: BitrateRequest): Message

    Creates a "bitrateRequest" message.

    Parameters:

    Name Type
    bitrateRequest BitrateRequest

    Returns: Message

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

    ▸ StaticcreateBitrateRequestMessage(bitrateRequests: BitrateRequest[]): Message

    Creates a "bitrateRequest" message.

    Parameters:

    Name Type
    bitrateRequests BitrateRequest[]

    Returns: Message

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


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


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


    createCloseMessage

    ▸ StaticcreateCloseMessage(): Message

    Creates a "close" message.

    Returns: Message

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


    createDtmfTonesMessage

    ▸ StaticcreateDtmfTonesMessage(dtmfTones: Tone[]): Message

    Creates a "dtmfTones" message.

    Parameters:

    Name Type
    dtmfTones Tone[]

    Returns: Message

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


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

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


    createEventMessage

    ▸ StaticcreateEventMessage(eventInfoJson: string): Message

    Creates an "event" message.

    Parameters:

    Name Type
    eventInfoJson string

    Returns: Message

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


    createIceServersMessage

    ▸ StaticcreateIceServersMessage(): Message

    Creates an "iceServers" message.

    Returns: Message

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


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


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


    createKeyFrameRequestMessage

    ▸ StaticcreateKeyFrameRequestMessage(synchronizationSources: number[]): Message

    Creates a "keyFrameRequest" message.

    Parameters:

    Name Type
    synchronizationSources number[]

    Returns: Message

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


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

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


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


    createMcuOfferMessage

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


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

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

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

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


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


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


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


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


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


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


    createRtcpDataChannelSignallingActivationMessage

    ▸ StaticcreateRtcpDataChannelSignallingActivationMessage(supportedMessageTypes: RtcpDataChannelSignallingActivation): Message

    Creates a "activateInbandSignalling" message.

    Parameters:

    Name Type
    supportedMessageTypes RtcpDataChannelSignallingActivation

    Returns: Message

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


    createSfuOfferMessage

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

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

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


    createUnregisterMessage

    ▸ StaticcreateUnregisterMessage(): Message

    Creates an "unregister" message.

    Returns: Message

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

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


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

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

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


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


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


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

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


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

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6