/ fm / liveswitch / WebRtcDomAudioSink

Class: WebRtcDomAudioSink

fm.liveswitch.WebRtcDomAudioSink

Hierarchy

• Dynamic

  ↳ WebRtcDomAudioSink

Implements

• IInternalDomAudioSink

Table of contents

Constructors

• constructor

Methods

• destroy
• doRetry
• getAudio
• getDynamicProperties
• getDynamicValue
• getLocal
• getMuted
• getTrack
• getTypeString
• getVolume
• playAudio
• retry
• setDynamicValue
• setMuted
• setTrack
• setVolume
• unsetDynamicValue

Constructors

constructor

+ new WebRtcDomAudioSink(external: DomAudioSink, track: WebRtcAudioTrack): WebRtcDomAudioSink

Parameters:

Name	Type
external	DomAudioSink
track	WebRtcAudioTrack

Returns: WebRtcDomAudioSink

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:50

Methods

destroy

▸ destroy(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:44

---

doRetry

▸ PrivatedoRetry<T>(attempt: number, retries: number, interval: number, action: () => Promise<T>, promise: Promise<T>): void

Type parameters:

Name
T

Parameters:

Name	Type
attempt	number
retries	number
interval	number
action	() => Promise<T>
promise	Promise<T>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:120

---

getAudio

▸ getAudio(): HTMLAudioElement

Returns: HTMLAudioElement

Implementation of: IInternalDomAudioSink

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:29

---

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/WebRtcDomAudioSink.ts:26

---

getMuted

▸ getMuted(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:38

---

getTrack

▸ getTrack(): WebRtcAudioTrack

Returns: WebRtcAudioTrack

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:23

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

getVolume

▸ getVolume(): number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:32

---

playAudio

▸ PrivateplayAudio(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:97

---

retry

▸ Privateretry<T>(retries: number, interval: number, action: () => Promise<T>): Future<T>

Type parameters:

Name
T

Parameters:

Name	Type
retries	number
interval	number
action	() => Promise<T>

Returns: Future<T>

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:112

---

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

---

setMuted

▸ setMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:41

---

setTrack

▸ setTrack(track: WebRtcAudioTrack): boolean

Parameters:

Name	Type
track	WebRtcAudioTrack

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:61

---

setVolume

▸ setVolume(volume: number): void

Parameters:

Name	Type
volume	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcDomAudioSink.ts:35

---

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