/ fm / liveswitch / WebRtcMedia

Class: WebRtcMedia<TAudioTrack, TVideoTrack>

fm.liveswitch.WebRtcMedia

Type parameters

Name	Type
TAudioTrack	WebRtcAudioTrack
TVideoTrack	WebRtcVideoTrack

Hierarchy

• WebRtcMediaBase<WebRtcAudioTrack, WebRtcVideoTrack>

  ↳ WebRtcMedia

  ↳↳ WebRtcLocalMediaBase

  ↳↳ WebRtcRemoteMedia

Implements

• IMedia<WebRtcAudioTrack, WebRtcVideoTrack>
• IInternalMedia

Table of contents

Constructors

• constructor

Properties

• _tryUseAudioWorklet

Methods

• _setAudioMediaStream
• _setVideoMediaStream
• addOnAudioDestroyed
• addOnAudioLevel
• addOnVideoDestroyed
• addOnVideoSize
• addOnVideoSizeChange
• destroy
• destroyAudioContext
• getAudio
• getAudioGain
• getAudioLevelInterval
• getAudioMuted
• getAudioSink
• getAudioTrack
• getAudioTracks
• getAudioVolume
• getDynamicProperties
• getDynamicValue
• getId
• getTypeString
• getVideo
• getVideoMuted
• getVideoSink
• getVideoSize
• getVideoTrack
• getVideoTracks
• getView
• getViewSink
• grabVideoFrame
• initializeAudioContext
• raiseOnVideoSize
• removeOnAudioDestroyed
• removeOnAudioLevel
• removeOnVideoDestroyed
• removeOnVideoSize
• removeOnVideoSizeChange
• setAudio
• setAudioGain
• setAudioLevelInterval
• setAudioMuted
• setAudioVolume
• setDynamicValue
• setId
• setVideo
• setVideoMuted
• tryAttachVideoSizeEvents
• unsetDynamicValue

Constructors

constructor

+ new WebRtcMedia<TAudioTrack, TVideoTrack>(external: any): WebRtcMedia<TAudioTrack, TVideoTrack>

Type parameters:

Name	Type
TAudioTrack	WebRtcAudioTrack<TAudioTrack>
TVideoTrack	WebRtcVideoTrack<TVideoTrack>

Parameters:

Name	Type
external	any

Returns: WebRtcMedia<TAudioTrack, TVideoTrack>

Inherited from: WebRtcMediaBase

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

Properties

_tryUseAudioWorklet

• Private _tryUseAudioWorklet: boolean= true

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

Methods

_setAudioMediaStream

▸ Protected_setAudioMediaStream(audioMediaStream: MediaStream): boolean

Parameters:

Name	Type
audioMediaStream	MediaStream

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:24

---

_setVideoMediaStream

▸ Protected_setVideoMediaStream(videoMediaStream: MediaStream): boolean

Parameters:

Name	Type
videoMediaStream	MediaStream

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:47

---

addOnAudioDestroyed

▸ addOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:162

---

addOnAudioLevel

▸ addOnAudioLevel(value: IAction1<number>): void

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:175

---

addOnVideoDestroyed

▸ addOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

addOnVideoSize

▸ addOnVideoSize(value: IAction1<Size>): void

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:179

---

addOnVideoSizeChange

▸ addOnVideoSizeChange(value: IAction1<Size>): void

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

destroy

▸ destroy(): void

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:214

---

destroyAudioContext

▸ ProtecteddestroyAudioContext(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:437

---

getAudio

▸ getAudio(): any

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:78

---

getAudioGain

▸ getAudioGain(): number

Returns: number

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:218

---

getAudioLevelInterval

▸ getAudioLevelInterval(): number

Returns: number

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

getAudioMuted

▸ getAudioMuted(): boolean

Gets a value indicating whether the audio is muted. This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

Returns: boolean

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

---

getAudioSink

▸ getAudioSink(): WebRtcDomAudioSink

Returns: WebRtcDomAudioSink

Implementation of: IInternalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:249

---

getAudioTrack

▸ getAudioTrack(): WebRtcAudioTrack

Gets the audio track from this media. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track. Returns null if there are no audio tracks.

Returns: WebRtcAudioTrack

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

---

getAudioTracks

▸ getAudioTracks(): WebRtcAudioTrack[]

Returns: WebRtcAudioTrack[]

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

getAudioVolume

▸ getAudioVolume(): number

Returns: number

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaBase

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

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

---

getId

▸ getId(): string

Gets the unique identifier of this media.

Returns: string

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:160

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:5

---

getVideo

▸ getVideo(): any

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:86

---

getVideoMuted

▸ getVideoMuted(): boolean

Gets a value indicating whether the video track is muted.
If the video track is muted, then remote users see a black frame instead of the local user’s video.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

Returns: boolean

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

---

getVideoSink

▸ getVideoSink(): WebRtcDomVideoSink

Returns: WebRtcDomVideoSink

Implementation of: IInternalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:255

---

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

getVideoTrack

▸ getVideoTrack(): WebRtcVideoTrack

Gets the video track from this media.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track. Returns null if there are no video tracks.

Returns: WebRtcVideoTrack

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:196

---

getVideoTracks

▸ getVideoTracks(): WebRtcVideoTrack[]

Returns: WebRtcVideoTrack[]

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

getView

▸ getView(): HTMLElement

Returns: HTMLElement

Implementation of: IInternalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:261

---

getViewSink

▸ getViewSink(): WebRtcDomVideoSink

Returns: WebRtcDomVideoSink

Implementation of: IInternalMedia

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:267

---

grabVideoFrame

▸ grabVideoFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:273

---

initializeAudioContext

▸ ProtectedinitializeAudioContext(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:327

---

raiseOnVideoSize

▸ PrivateraiseOnVideoSize(width: number, height: number): void

Parameters:

Name	Type
width	number
height	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:203

---

removeOnAudioDestroyed

▸ removeOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

removeOnAudioLevel

▸ removeOnAudioLevel(value: IAction1<number>): void

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:292

---

removeOnVideoDestroyed

▸ removeOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

removeOnVideoSize

▸ removeOnVideoSize(value: IAction1<Size>): void

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:298

---

removeOnVideoSizeChange

▸ removeOnVideoSizeChange(value: IAction1<Size>): void

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:301

---

setAudio

▸ setAudio(audio: any): void

Parameters:

Name	Type
audio	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:81

---

setAudioGain

▸ setAudioGain(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

---

setAudioLevelInterval

▸ setAudioLevelInterval(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:308

---

setAudioMuted

▸ setAudioMuted(value: boolean): void

Sets a value indicating whether the audio is muted. This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:288

---

setAudioVolume

▸ setAudioVolume(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:317

---

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

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

---

setId

▸ setId(value: string): void

Sets the unique identifier of this media.

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

---

setVideo

▸ setVideo(video: any): void

Parameters:

Name	Type
video	any

Returns: void

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

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Sets a value indicating whether the video track is muted.
If the video track is muted, then remote users see a black frame instead of the local user’s video.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

---

tryAttachVideoSizeEvents

▸ PrivatetryAttachVideoSizeEvents(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:187

---

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

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