/ fm / liveswitch / PluginAudioStream

Class: PluginAudioStream

fm.liveswitch.PluginAudioStream

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new PluginAudioStream(external: IExternalAudioStream, localTrack: PluginAudioTrack, remoteTrack: PluginAudioTrack): PluginAudioStream

Parameters:

Name Type
external IExternalAudioStream
localTrack PluginAudioTrack
remoteTrack PluginAudioTrack

Returns: PluginAudioStream

Inherited from: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:45

Properties

_state

• Private _state: StreamState

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:45

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:240

addOnDiscardBitrateNotification

▸ addOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:361

addOnDiscardBitrateRequest

▸ addOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:351

addOnLocalEncodingDisabled

▸ addOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:337

addOnLocalEncodingEnabled

▸ addOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

addOnReceiveDtmfTone

▸ addOnReceiveDtmfTone(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:247

addOnReceiveDtmfToneChange

▸ addOnReceiveDtmfToneChange(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:250

addOnSendDtmfTone

▸ addOnSendDtmfTone(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

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

addOnSendDtmfToneChange

▸ addOnSendDtmfToneChange(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:256

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:128

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:165

getCodecDisabled

▸ getCodecDisabled(name: string): boolean

Parameters:

Name Type
name string

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:168

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: PluginMediaStream

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

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

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getG722Disabled

▸ getG722Disabled(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:294

getHandle

▸ getHandle(): number

Returns: number

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:161

getId

▸ getId(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getInfo

▸ getInfo(): MediaStreamInfo

Returns: MediaStreamInfo

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:135

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:201

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:180

getLocalBandwidth

▸ getLocalBandwidth(): number

Returns: number

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:183

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:204

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:186

getLocalMuted

▸ getLocalMuted(): boolean

Returns: boolean

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:189

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:139

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:142

getLocalTrack

▸ getLocalTrack(): PluginAudioTrack

Returns: PluginAudioTrack

Inherited from: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaStream.ts:13

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Returns: number

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:377

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Returns: number

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:371

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:210

getOpusDisabled

▸ getOpusDisabled(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:291

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getPcmaDisabled

▸ getPcmaDisabled(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:300

getPcmuDisabled

▸ getPcmuDisabled(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:297

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Returns: string[]

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:278

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Returns: number

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:216

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:213

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:158

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Returns: EncodingInfo

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getRemoteMuted

▸ getRemoteMuted(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:145

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:148

getRemoteTrack

▸ getRemoteTrack(): PluginAudioTrack

Returns: PluginAudioTrack

Inherited from: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginMediaStream.ts:19

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:323

getState

▸ getState(): StreamState

Returns: StreamState

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:125

getTag

▸ getTag(): string

Returns: string

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:219

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:330

getType

▸ getType(): StreamType

Returns: StreamType

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:222

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginMediaStream

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

insertDtmfTone

▸ insertDtmfTone(dtmfTone: Tone): boolean

Parameters:

Name Type
dtmfTone Tone

Returns: boolean

Implementation of: IInternalAudioStream

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

insertDtmfTones

▸ insertDtmfTones(dtmfTones: Tone[]): boolean

Parameters:

Name Type
dtmfTones Tone[]

Returns: boolean

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:262

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: boolean

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:357

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

removeOnDiscardBitrateNotification

▸ removeOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

removeOnDiscardBitrateRequest

▸ removeOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:354

removeOnLocalEncodingDisabled

▸ removeOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:344

removeOnLocalEncodingEnabled

▸ removeOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:347

removeOnReceiveDtmfTone

▸ removeOnReceiveDtmfTone(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:265

removeOnReceiveDtmfToneChange

▸ removeOnReceiveDtmfToneChange(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:268

removeOnSendDtmfTone

▸ removeOnSendDtmfTone(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:271

removeOnSendDtmfToneChange

▸ removeOnSendDtmfToneChange(value: IAction1<Tone>): void

Parameters:

Name Type
value IAction1<Tone>

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:274

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

setCodecDisabled

▸ setCodecDisabled(name: string, disabled: boolean): void

Parameters:

Name Type
name string
disabled boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:287

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

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

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

setG722Disabled

▸ setG722Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:306

setInputMuted

▸ setInputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:231

setLocalBandwidth

▸ setLocalBandwidth(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:228

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:225

setLocalMuted

▸ setLocalMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:192

setLocalReceive

▸ setLocalReceive(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:151

setLocalSend

▸ setLocalSend(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:154

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:380

setMaxSendBitrate

▸ setMaxSendBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

setOpusDisabled

▸ setOpusDisabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:303

setOutputMuted

▸ setOutputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:234

setPcmaDisabled

▸ setPcmaDisabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:312

setPcmuDisabled

▸ setPcmuDisabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:309

setPreferredCodecs

▸ setPreferredCodecs(names: string[]): void

Parameters:

Name Type
names string[]

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

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

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Parameters:

Name Type
value EncodingInfo

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:319

setRemoteMuted

▸ setRemoteMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:198

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name Type
value SimulcastMode

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:326

setTag

▸ setTag(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalAudioStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioStream.ts:237

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

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