/ fm / liveswitch / ConnectionInfo

Class: ConnectionInfo

fm.liveswitch.ConnectionInfo

Connection information.

Hierarchy

  • Info

    ↳ ConnectionInfo

Table of contents

Constructors

Methods

Constructors

constructor

+ new ConnectionInfo(): ConnectionInfo

Initializes a new instance of the [[fm.liveswitch.connectionInfo]] class.

Returns: ConnectionInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:83

+ new ConnectionInfo(idValue: string, applicationId: string, channelId: string, userId: string, deviceId: string, clientId: string): ConnectionInfo

Parameters:

Name Type
idValue string
applicationId string
channelId string
userId string
deviceId string
clientId string

Returns: ConnectionInfo

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

+ new ConnectionInfo(userId: string, deviceId: string, clientId: string, idValue: string, tag: string, type: string, mediaId: string, localAudioMuted: boolean, localVideoMuted: boolean, audioDirection: string, videoDirection: string, dataDirection: string, audioFormats: FormatInfo[], videoFormats: FormatInfo[]): ConnectionInfo

Initializes a new instance of the [[fm.liveswitch.connectionInfo]] class.

Parameters:

Name Type Description
userId string The user identifier.
deviceId string The device identifier.
clientId string The client identifier.
idValue string The connection identifier.
tag string The connection tag.
type string The connection type.
mediaId string The media identifier.
localAudioMuted boolean The audio muted boolean.
localVideoMuted boolean The video muted boolean.
audioDirection string The audio direction.
videoDirection string The video direction.
dataDirection string The data direction.
audioFormats FormatInfo[] The audio formats.
videoFormats FormatInfo[] The video formats.

Returns: ConnectionInfo

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

+ new ConnectionInfo(userId: string, userAlias: string, deviceId: string, deviceAlias: string, clientId: string, clientTag: string, clientRoles: string[], clientProtocol: string, idValue: string, tag: string, type: string, mediaId: string, localAudioMuted: boolean, localVideoMuted: boolean, audioDirection: string, videoDirection: string, dataDirection: string, audioFormats: FormatInfo[], videoFormats: FormatInfo[], layoutZone: string, layoutPriority: number): ConnectionInfo

Initializes a new instance of the [[fm.liveswitch.connectionInfo]] class.

Parameters:

Name Type Description
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.
clientProtocol string The client protocol.
idValue string The connection identifier.
tag string The connection tag.
type string The connection type.
mediaId string The media identifier.
localAudioMuted boolean The audio muted boolean.
localVideoMuted boolean The video muted boolean.
audioDirection string The audio direction.
videoDirection string The video direction.
dataDirection string The data direction.
audioFormats FormatInfo[] The audio formats.
videoFormats FormatInfo[] The video formats.
layoutZone string The layout zone.
layoutPriority number The layout priority.

Returns: ConnectionInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:110

Methods

createClientInfo

▸ createClientInfo(): ClientInfo

Creates a client info object with details from this connection info object.

Returns: ClientInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:353

deserializeProperties

▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

Deserializes the properties.

Parameters:

Name Type Description
key string The key.
valueJson string The value in JSON format.

Returns: void

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:367

fmliveswitchConnectionInfoInit

▸ PrivatefmliveswitchConnectionInfoInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:76

getApplicationId

▸ getApplicationId(): string

Gets the application identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:488

getAudioDirection

▸ getAudioDirection(): string

Gets the audio stream direction.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:500

getAudioFormats

▸ getAudioFormats(): FormatInfo[]

Gets the audio formats, if applicable.

Returns: FormatInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:516

getAudioStream

▸ getAudioStream(): MediaStreamInfo

Gets the first connection audio stream.

Returns: MediaStreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:564

getAudioStreams

▸ getAudioStreams(): MediaStreamInfo[]

Gets the connection audio streams.

Returns: MediaStreamInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:576

getChannelId

▸ getChannelId(): string

Gets the channel identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:588

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:600

getClientProtocol

▸ getClientProtocol(): string

Gets the client protocol.

Returns: string

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

getClientRoles

▸ getClientRoles(): string[]

Gets the client roles.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:624

getClientTag

▸ getClientTag(): string

Gets the client tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:636

getDataDirection

▸ getDataDirection(): string

Gets the data stream direction. Obsolete.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:649

getDataStream

▸ getDataStream(): DataStreamInfo

Gets the connection data stream.

Returns: DataStreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:664

getDeviceAlias

▸ getDeviceAlias(): string

Gets the device alias.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:676

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:688

getError

▸ getError(): Error

Gets the connection error, if an error exists.

Returns: Error

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:700

getExternalId

▸ getExternalId(): string

Gets the connection external identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:712

getHasAudio

▸ getHasAudio(): boolean

Gets a value indicating whether the connection has an audio stream.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:725

getHasData

▸ getHasData(): boolean

Gets a value indicating whether the connection has a data stream.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:738

getHasVideo

▸ getHasVideo(): boolean

Gets a value indicating whether the connection has a video stream.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:751

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336

getIsSip

▸ getIsSip(): boolean

Gets whether the client is connected via SIP.

Returns: boolean

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

getLayoutPriority

▸ getLayoutPriority(): number

Gets the layout priority.

Returns: number

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

getLayoutZone

▸ getLayoutZone(): string

Gets the layout zone.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:787

getLocalAudioDisabled

▸ getLocalAudioDisabled(): boolean

Gets if local audio is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:799

getLocalAudioMuted

▸ getLocalAudioMuted(): boolean

Gets whether the local audio is muted. Returns true if the local audio is muted and false otherwise.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:815

getLocalAudioUnmuteDisabled

▸ getLocalAudioUnmuteDisabled(): boolean

Gets whether the local audio cannot be unmuted. Returns true if the local audio cannot be unmuted and false otherwise.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:831

getLocalVideoDisabled

▸ getLocalVideoDisabled(): boolean

Gets if local video is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:847

getLocalVideoMuted

▸ getLocalVideoMuted(): boolean

Gets whether the local video is muted. Returns true if the local video is muted and false otherwise.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:863

getLocalVideoUnmuteDisabled

▸ getLocalVideoUnmuteDisabled(): boolean

Gets whether the local video cannot be unmuted. Returns true if the local video cannot be unmuted and false otherwise.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:879

getMediaId

▸ getMediaId(): string

Gets the media identifier, for MCU or SFU upstream connections.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:895

getRecording

▸ getRecording(): boolean

Gets whether the connection is recording.

Returns: boolean

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

getRecordingMode

▸ getRecordingMode(): string

Gets the connection recording mode.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:919

getRecordingTag

▸ getRecordingTag(): string

Gets the connection recording tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:931

getRemoteAudioDisabled

▸ getRemoteAudioDisabled(): boolean

Gets if remote audio is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:943

getRemoteAudioMuted

▸ getRemoteAudioMuted(): boolean

Gets if remote audio is muted.

Returns: boolean

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

getRemoteConnectionId

▸ getRemoteConnectionId(): string

Gets the remote connection identifier, for peer or SFU downstream connections.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:971

getRemoteMediaId

▸ getRemoteMediaId(): string

Gets the remote media identifier, for SFU downstream connections.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:983

getRemoteVideoDisabled

▸ getRemoteVideoDisabled(): boolean

Gets if remote video is disabled.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:995

getRemoteVideoMuted

▸ getRemoteVideoMuted(): boolean

Gets if remote video is muted.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1011

getState

▸ getState(): string

Gets the connection state.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1031

getTag

▸ getTag(): string

Gets the connection tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1043

getTransports

▸ getTransports(): TransportInfo[]

Gets the connection transport information. This will be null if BUNDLE is inactive.

Returns: TransportInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1056

getType

▸ getType(): string

Gets the connection type.

Returns: string

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

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

getUseWebSocketsForMedia

▸ getUseWebSocketsForMedia(): boolean

Gets if we should use websockets for sending media.

Returns: boolean

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

getUserAlias

▸ getUserAlias(): string

Gets the user alias.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1080

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

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

getVideoDirection

▸ getVideoDirection(): string

Gets the video stream direction.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1116

getVideoFormats

▸ getVideoFormats(): FormatInfo[]

Gets the video formats, if applicable.

Returns: FormatInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1132

getVideoStream

▸ getVideoStream(): MediaStreamInfo

Gets the first connection video stream.

Returns: MediaStreamInfo

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1180

getVideoStreams

▸ getVideoStreams(): MediaStreamInfo[]

Gets the connection video streams.

Returns: MediaStreamInfo[]

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1192

isEquivalent

▸ isEquivalent(connectionInfo: ConnectionInfo): boolean

Tests for equivalency.

Parameters:

Name Type Description
connectionInfo ConnectionInfo The connection information.

Returns: boolean

true if equivalent; otherwise, false.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1229

▸ isEquivalent(userId: string, deviceId: string, clientId: string, idValue: string): boolean

Tests for equivalency.

Parameters:

Name Type Description
userId string The user identifier.
deviceId string The device identifier.
clientId string The client identifier.
idValue string The connection identifier.

Returns: boolean

true if equivalent; otherwise, false.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1241

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name Type Description
jsonObject Hash<string, string> The JSON object.

Returns: void

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1337

setApplicationId

▸ setApplicationId(value: string): void

Sets the application identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1456

setAudioStream

▸ setAudioStream(value: MediaStreamInfo): void

Sets the first connection audio stream.

Parameters:

Name Type
value MediaStreamInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1499

setAudioStreams

▸ setAudioStreams(value: MediaStreamInfo[]): void

Sets the connection audio streams.

Parameters:

Name Type
value MediaStreamInfo[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1511

setChannelId

▸ setChannelId(value: string): void

Sets the channel identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1523

setClientId

▸ setClientId(value: string): void

Sets the client identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1535

setClientProtocol

▸ setClientProtocol(value: string): void

Sets the client protocol.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1547

setClientRoles

▸ setClientRoles(value: string[]): void

Sets the client roles.

Parameters:

Name Type
value string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1559

setClientTag

▸ setClientTag(value: string): void

Sets the client tag.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1571

setDataStream

▸ setDataStream(value: DataStreamInfo): void

Sets the connection data stream.

Parameters:

Name Type
value DataStreamInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1598

setDeviceAlias

▸ setDeviceAlias(value: string): void

Sets the device alias.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1610

setDeviceId

▸ setDeviceId(value: string): void

Sets the device identifier.

Parameters:

Name Type
value string

Returns: void

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

setError

▸ setError(value: Error): void

Sets the connection error, if an error exists.

Parameters:

Name Type
value Error

Returns: void

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

setExternalId

▸ setExternalId(value: string): void

Sets the connection external identifier.

Parameters:

Name Type
value string

Returns: void

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

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name Type
value string

Returns: void

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363

setLayoutPriority

▸ setLayoutPriority(value: number): void

Sets the layout priority.

Parameters:

Name Type
value number

Returns: void

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

setLayoutZone

▸ setLayoutZone(value: string): void

Sets the layout zone.

Parameters:

Name Type
value string

Returns: void

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

setMediaId

▸ setMediaId(value: string): void

Sets the media identifier, for MCU or SFU upstream connections.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1760

setRecording

▸ setRecording(value: boolean): void

Sets whether the connection is recording.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1772

setRecordingMode

▸ setRecordingMode(value: string): void

Sets the connection recording mode.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1784

setRecordingTag

▸ setRecordingTag(value: string): void

Sets the connection recording tag.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1796

setRemoteAudioMuted

▸ setRemoteAudioMuted(value: boolean): void

Sets if remote audio is muted.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1821

setRemoteConnectionId

▸ setRemoteConnectionId(value: string): void

Sets the remote connection identifier, for peer or SFU downstream connections.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1833

setRemoteMediaId

▸ setRemoteMediaId(value: string): void

Sets the remote media identifier, for SFU downstream connections.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1845

setRemoteVideoMuted

▸ setRemoteVideoMuted(value: boolean): void

Sets if remote video is muted.

Parameters:

Name Type
value boolean

Returns: void

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

setState

▸ setState(value: string): void

Sets the connection state.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1890

setTag

▸ setTag(value: string): void

Sets the connection tag.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1902

setTransports

▸ setTransports(value: TransportInfo[]): void

Sets the connection transport information. This will be null if BUNDLE is inactive.

Parameters:

Name Type
value TransportInfo[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1915

setType

▸ setType(value: string): void

Sets the connection type.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1927

setUseWebSocketsForMedia

▸ setUseWebSocketsForMedia(value: boolean): void

Sets if we should use websockets for sending media.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1963

setUserAlias

▸ setUserAlias(value: string): void

Sets the user alias.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1939

setUserId

▸ setUserId(value: string): void

Sets the user identifier.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:1951

setVideoStream

▸ setVideoStream(value: MediaStreamInfo): void

Sets the first connection video stream.

Parameters:

Name Type
value MediaStreamInfo

Returns: void

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

setVideoStreams

▸ setVideoStreams(value: MediaStreamInfo[]): void

Sets the connection video streams.

Parameters:

Name Type
value MediaStreamInfo[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2018

shouldSerializeAudioDirection

▸ shouldSerializeAudioDirection(): boolean

Gets whether to serialize the legacy audio direction property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2038

shouldSerializeAudioFormats

▸ shouldSerializeAudioFormats(): boolean

Gets whether to serialize the legacy audio formats property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2050

shouldSerializeDataDirection

▸ shouldSerializeDataDirection(): boolean

Gets whether to serialize the legacy data direction property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2062

shouldSerializeLocalAudioMuted

▸ shouldSerializeLocalAudioMuted(): boolean

Gets whether to serialize the legacy local audio muted property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2074

shouldSerializeLocalVideoMuted

▸ shouldSerializeLocalVideoMuted(): boolean

Gets whether to serialize the legacy local video muted property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2086

shouldSerializeVideoDirection

▸ shouldSerializeVideoDirection(): boolean

Gets whether to serialize the legacy video direction property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2098

shouldSerializeVideoFormats

▸ shouldSerializeVideoFormats(): boolean

Gets whether to serialize the legacy video formats property.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2110

toJson

▸ toJson(): string

Serializes this instance to Json.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:2122

fromJson

▸ StaticfromJson(connectionInfoJson: string): ConnectionInfo

Deserializes Json to a ConnectionInfo.

Parameters:

Name Type Description
connectionInfoJson string The serialized Json.

Returns: ConnectionInfo

The deserialized ConnectionInfo.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:284

fromJsonArray

▸ StaticfromJsonArray(connectionInfosJson: string): ConnectionInfo[]

Deserializes an array of instances from JSON.

Parameters:

Name Type Description
connectionInfosJson string The JSON to deserialize.

Returns: ConnectionInfo[]

The deserialized connection infos.

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

processArray

▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

Processes an array for an info.

Type parameters:

Name Type
T IEquivalent<T, T>

Parameters:

Name Type Description
newValues T[] The new values.
oldValues T[] The old values.

Returns: T[]

The new values, if the new values are not equivalent to the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34

processBoolean

▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

Processes a boolean for an info.

Parameters:

Name Type Description
newValue boolean The new value.
oldValue boolean The old value.

Returns: boolean

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60

processBooleanArray

▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

Processes a boolean array for an info.

Parameters:

Name Type Description
newValues boolean[] The new values.
oldValues boolean[] The old values.

Returns: boolean[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75

processDouble

▸ StaticprocessDouble(newValue: number, oldValue: number): number

Processes a double for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101

processFloat

▸ StaticprocessFloat(newValue: number, oldValue: number): number

Processes a float for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116

processFloatArray

▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

Processes a float array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131

processInteger

▸ StaticprocessInteger(newValue: number, oldValue: number): number

Processes an integer for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157

processIntegerArray

▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

Processes a integer array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174

processLong

▸ StaticprocessLong(newValue: number, oldValue: number): number

Processes a long for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200

processLongArray

▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

Processes a long array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217

processObject

▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

Processes an object for an info.

Type parameters:

Name Type
T Object & IEquivalent<T, T>

Parameters:

Name Type Description
newValue T The new value.
oldValue T The old value.

Returns: T

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243

processShort

▸ StaticprocessShort(newValue: number, oldValue: number): number

Processes a short for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264

processShortArray

▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

Processes a short array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281

processString

▸ StaticprocessString(newValue: string, oldValue: string): string

Processes a string for an info.

Parameters:

Name Type Description
newValue string The new value.
oldValue string The old value.

Returns: string

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307

toJson

▸ StatictoJson(connectionInfo: ConnectionInfo): string

Serializes an instance to Json.

Parameters:

Name Type Description
connectionInfo ConnectionInfo The instance to serialize.

Returns: string

Serialized Json.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:322

toJsonArray

▸ StatictoJsonArray(connectionInfos: ConnectionInfo[]): string

Serializes an array of instances to JSON.

Parameters:

Name Type Description
connectionInfos ConnectionInfo[] The connection infos to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ConnectionInfo.ts:340