/ fm / liveswitch / MediaStreamInfo
Class: MediaStreamInfo
fm.liveswitch.MediaStreamInfo
Media stream information.
Hierarchy
-
↳ MediaStreamInfo
Table of contents
Constructors
Methods
- deserializeProperties
- fmliveswitchMediaStreamInfoInit
- getControlTransportId
- getDirection
- getId
- getLocalBandwidth
- getMaxFrameHeight
- getMaxFrameWidth
- getReceiveContent
- getReceiveDisabled
- getReceiveEncodings
- getReceiveFormats
- getReceiver
- getReceivers
- getRemoteBandwidth
- getSendContent
- getSendDisabled
- getSendEncodings
- getSendFormats
- getSendMuted
- getSendUnmuteDisabled
- getSender
- getSenders
- getTag
- getTransportId
- getTypeString
- serializeProperties
- setControlTransportId
- setDirection
- setId
- setLocalBandwidth
- setMaxFrameHeight
- setMaxFrameWidth
- setReceiveContent
- setReceiveDisabled
- setReceiveEncodings
- setReceiveFormats
- setReceivers
- setRemoteBandwidth
- setSendContent
- setSendDisabled
- setSendEncodings
- setSendFormats
- setSendMuted
- setSendUnmuteDisabled
- setSenders
- setTag
- setTransportId
- toJson
- fromJson
- fromJsonArray
- processArray
- processBoolean
- processBooleanArray
- processDouble
- processFloat
- processFloatArray
- processInteger
- processIntegerArray
- processLong
- processLongArray
- processObject
- processShort
- processShortArray
- processString
- toJson
- toJsonArray
Constructors
constructor
+ new MediaStreamInfo(): MediaStreamInfo
Returns: MediaStreamInfo
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:58
Methods
deserializeProperties
▸ Protected
deserializeProperties(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:146
fmliveswitchMediaStreamInfoInit
▸ Private
fmliveswitchMediaStreamInfoInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:48
getControlTransportId
▸ getControlTransportId(): string
Gets the control transport id.
This will be null
if BUNDLE is active.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:244
getDirection
▸ getDirection(): string
Gets the media stream direction.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:256
getId
▸ getId(): string
Gets the identifier.
Returns: string
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336
getLocalBandwidth
▸ getLocalBandwidth(): number
Gets the media stream's local bandwidth.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:269
getMaxFrameHeight
▸ getMaxFrameHeight(): number
Gets the media stream's maximum frame height.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:281
getMaxFrameWidth
▸ getMaxFrameWidth(): number
Gets the media stream's maximum frame width.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:293
getReceiveContent
▸ getReceiveContent(): string
Gets the media stream's receive content.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:305
getReceiveDisabled
▸ getReceiveDisabled(): boolean
Gets whether the media stream has the receive direction disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:317
getReceiveEncodings
▸ getReceiveEncodings(): EncodingInfo[]
Gets the media stream receive encodings.
Returns: EncodingInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:329
getReceiveFormats
▸ getReceiveFormats(): FormatInfo[]
Gets the media stream receive formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:341
getReceiver
▸ getReceiver(): MediaReceiverInfo
Gets the first media stream receiver information.
Returns: MediaReceiverInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:353
getReceivers
▸ getReceivers(): MediaReceiverInfo[]
Gets the media stream receivers information.
Returns: MediaReceiverInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:365
getRemoteBandwidth
▸ getRemoteBandwidth(): number
Gets the media stream's remote bandwidth.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:377
getSendContent
▸ getSendContent(): string
Gets the media stream's send content.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:389
getSendDisabled
▸ getSendDisabled(): boolean
Gets whether the media stream has the send direction disabled.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:401
getSendEncodings
▸ getSendEncodings(): EncodingInfo[]
Gets the media stream send encodings.
Returns: EncodingInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:413
getSendFormats
▸ getSendFormats(): FormatInfo[]
Gets the media stream send formats.
Returns: FormatInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:449
getSendMuted
▸ getSendMuted(): boolean
Gets whether the sender is muted. Returns true if the sender is muted and false otherwise.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:461
getSendUnmuteDisabled
▸ getSendUnmuteDisabled(): boolean
Gets whether the sender cannot be unmuted. Returns true if the sender cannot be unmuted and false otherwise.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:473
getSender
▸ getSender(): MediaSenderInfo
Gets the first media stream sender information.
Returns: MediaSenderInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:425
getSenders
▸ getSenders(): MediaSenderInfo[]
Gets the media stream senders information.
Returns: MediaSenderInfo[]
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:437
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:58
getTransportId
▸ getTransportId(): string
Gets the transport id.
Returns: string
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:70
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:10
serializeProperties
▸ Protected
serializeProperties(jsonObject
: Hash<string, string>): void
Serializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
jsonObject |
Hash<string, string> | The JSON object. |
Returns: void
Overrides: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:523
setControlTransportId
▸ setControlTransportId(value
: string): void
Sets the control transport id.
This will be null
if BUNDLE is active.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:587
setDirection
▸ setDirection(value
: string): void
Sets the media stream direction.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:599
setId
▸ setId(value
: string): void
Sets the identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363
setLocalBandwidth
▸ setLocalBandwidth(value
: number): void
Sets the media stream's local bandwidth.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:612
setMaxFrameHeight
▸ setMaxFrameHeight(value
: number): void
Sets the media stream's maximum frame height.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:625
setMaxFrameWidth
▸ setMaxFrameWidth(value
: number): void
Sets the media stream's maximum frame width.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:638
setReceiveContent
▸ setReceiveContent(value
: string): void
Sets the media stream's receive content.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:651
setReceiveDisabled
▸ setReceiveDisabled(value
: boolean): void
Sets whether the media stream has the receive direction disabled.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:663
setReceiveEncodings
▸ setReceiveEncodings(value
: EncodingInfo[]): void
Sets the media stream receive encodings.
Parameters:
Name | Type |
---|---|
value |
EncodingInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:675
setReceiveFormats
▸ setReceiveFormats(value
: FormatInfo[]): void
Sets the media stream receive formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:687
setReceivers
▸ setReceivers(value
: MediaReceiverInfo[]): void
Sets the media stream receivers information.
Parameters:
Name | Type |
---|---|
value |
MediaReceiverInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:699
setRemoteBandwidth
▸ setRemoteBandwidth(value
: number): void
Sets the media stream's remote bandwidth.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:711
setSendContent
▸ setSendContent(value
: string): void
Sets the media stream's send content.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:724
setSendDisabled
▸ setSendDisabled(value
: boolean): void
Sets whether the media stream has the send direction disabled.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:736
setSendEncodings
▸ setSendEncodings(value
: EncodingInfo[]): void
Sets the media stream send encodings.
Parameters:
Name | Type |
---|---|
value |
EncodingInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:748
setSendFormats
▸ setSendFormats(value
: FormatInfo[]): void
Sets the media stream send formats.
Parameters:
Name | Type |
---|---|
value |
FormatInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:772
setSendMuted
▸ setSendMuted(value
: boolean): void
Sets whether the sender is muted. Returns true if the sender is muted and false otherwise.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:784
setSendUnmuteDisabled
▸ setSendUnmuteDisabled(value
: boolean): void
Sets whether the sender cannot be unmuted. Returns true if the sender cannot be unmuted and false otherwise.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:796
setSenders
▸ setSenders(value
: MediaSenderInfo[]): void
Sets the media stream senders information.
Parameters:
Name | Type |
---|---|
value |
MediaSenderInfo[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:760
setTag
▸ setTag(value
: string): void
Sets the tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:101
setTransportId
▸ setTransportId(value
: string): void
Sets the transport id.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/StreamInfo.ts:113
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:808
fromJson
▸ Static
fromJson(mediaStreamInfoJson
: string): MediaStreamInfo
Deserializes an instance from JSON.
Parameters:
Name | Type | Description |
---|---|---|
mediaStreamInfoJson |
string | The serialized JSON. |
Returns: MediaStreamInfo
The deserialized instance.
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:80
fromJsonArray
▸ Static
fromJsonArray(mediaStreamInfosJson
: string): MediaStreamInfo[]
Deserializes an array from JSON.
Parameters:
Name | Type | Description |
---|---|---|
mediaStreamInfosJson |
string | The serialized JSON. |
Returns: MediaStreamInfo[]
The deserialized array.
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:98
processArray
▸ Static
processArray<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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34
processBoolean
▸ Static
processBoolean(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60
processBooleanArray
▸ Static
processBooleanArray(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75
processDouble
▸ Static
processDouble(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101
processFloat
▸ Static
processFloat(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116
processFloatArray
▸ Static
processFloatArray(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131
processInteger
▸ Static
processInteger(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157
processIntegerArray
▸ Static
processIntegerArray(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174
processLong
▸ Static
processLong(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200
processLongArray
▸ Static
processLongArray(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217
processObject
▸ Static
processObject<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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243
processShort
▸ Static
processShort(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264
processShortArray
▸ Static
processShortArray(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281
processString
▸ Static
processString(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: StreamInfo
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307
toJson
▸ Static
toJson(mediaStreamInfo
: MediaStreamInfo): string
Serializes an instance to JSON.
Parameters:
Name | Type | Description |
---|---|---|
mediaStreamInfo |
MediaStreamInfo | The instance to serialize. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:116
toJsonArray
▸ Static
toJsonArray(mediaStreamInfos
: MediaStreamInfo[]): string
Serializes an array to JSON.
Parameters:
Name | Type | Description |
---|---|---|
mediaStreamInfos |
MediaStreamInfo[] | The array to serialize. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/MediaStreamInfo.ts:132