/ fm / liveswitch / PluginDomAudioSink

Class: PluginDomAudioSink

fm.liveswitch.PluginDomAudioSink

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new PluginDomAudioSink(external: DomAudioSink, track: PluginAudioTrack): PluginDomAudioSink

Parameters:

Name Type
external DomAudioSink
track PluginAudioTrack

Returns: PluginDomAudioSink

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/PluginDomAudioSink.ts:28

Methods

getAudio

▸ getAudio(): HTMLAudioElement

Returns: HTMLAudioElement

Implementation of: IInternalDomAudioSink

Defined in: Generated/TypeScript/fm.liveswitch/PluginDomAudioSink.ts:26

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

getLocal

▸ getLocal(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/PluginDomAudioSink.ts:22

getTrack

▸ getTrack(): PluginAudioTrack

Returns: PluginAudioTrack

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/PluginDomAudioSink.ts:4

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

setTrack

▸ setTrack(track: PluginAudioTrack): boolean

Parameters:

Name Type
track PluginAudioTrack

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/PluginDomAudioSink.ts:49

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