/ fm / liveswitch / WebRtcMedia

Class: WebRtcMedia<TAudioTrack, TVideoTrack>

fm.liveswitch.WebRtcMedia

Type parameters

Name Type
TAudioTrack WebRtcAudioTrack
TVideoTrack WebRtcVideoTrack

Hierarchy

Implements

Table of contents

Constructors

Methods

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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:120

Methods

_setAudioMediaStream

▸ Protected_setAudioMediaStream(audioMediaStream: MediaStream): boolean

Parameters:

Name Type
audioMediaStream MediaStream

Returns: boolean

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

_setVideoMediaStream

▸ Protected_setVideoMediaStream(videoMediaStream: MediaStream): boolean

Parameters:

Name Type
videoMediaStream MediaStream

Returns: boolean

Defined in: fm/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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:148

addOnAudioLevel

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

Parameters:

Name Type
value IAction1<number>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

addOnVideoDestroyed

▸ addOnVideoDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

addOnVideoSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

destroy

▸ destroy(): void

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

destroyAudioContext

▸ ProtecteddestroyAudioContext(): void

Returns: void

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

getAudio

▸ getAudio(): any

Returns: any

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

getAudioGain

▸ getAudioGain(): number

Returns: number

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

getAudioMuted

▸ getAudioMuted(): boolean

Gets a value indicating whether the first audio track is muted.

Returns: boolean

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

getAudioSink

▸ getAudioSink(): WebRtcDomAudioSink

Returns: WebRtcDomAudioSink

Implementation of: IInternalMedia

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

getAudioTrack

▸ getAudioTrack(): WebRtcAudioTrack

Gets the first audio track.

Returns: WebRtcAudioTrack

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

getAudioTracks

▸ getAudioTracks(): WebRtcAudioTrack[]

Returns: WebRtcAudioTrack[]

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

getAudioVolume

▸ getAudioVolume(): number

Returns: number

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: WebRtcMediaBase

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getId

▸ getId(): string

Gets the identifier.

Returns: string

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebRtcMediaBase

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

getVideo

▸ getVideo(): any

Returns: any

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

getVideoMuted

▸ getVideoMuted(): boolean

Gets a value indicating whether the first video track is muted.

Returns: boolean

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

getVideoSink

▸ getVideoSink(): WebRtcDomVideoSink

Returns: WebRtcDomVideoSink

Implementation of: IInternalMedia

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

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

getVideoTrack

▸ getVideoTrack(): WebRtcVideoTrack

Gets the first video track.

Returns: WebRtcVideoTrack

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

getVideoTracks

▸ getVideoTracks(): WebRtcVideoTrack[]

Returns: WebRtcVideoTrack[]

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

getView

▸ getView(): HTMLElement

Returns: HTMLElement

Implementation of: IInternalMedia

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

getViewSink

▸ getViewSink(): WebRtcDomVideoSink

Returns: WebRtcDomVideoSink

Implementation of: IInternalMedia

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

grabVideoFrame

▸ grabVideoFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

initializeAudioContext

▸ ProtectedinitializeAudioContext(): void

Returns: void

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

removeOnAudioDestroyed

▸ removeOnAudioDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

removeOnAudioLevel

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

Parameters:

Name Type
value IAction1<number>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

removeOnVideoDestroyed

▸ removeOnVideoDestroyed(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

removeOnVideoSize

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

Parameters:

Name Type
value IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

setAudio

▸ setAudio(audio: any): void

Parameters:

Name Type
audio any

Returns: void

Defined in: fm/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: fm/Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:269

setAudioMuted

▸ setAudioMuted(value: boolean): void

Sets a value indicating whether the first audio track is muted.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

setAudioVolume

▸ setAudioVolume(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalMedia

Overrides: WebRtcMediaBase

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

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

setVideo

▸ setVideo(video: any): void

Parameters:

Name Type
video any

Returns: void

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

setVideoMuted

▸ setVideoMuted(value: boolean): void

Sets a value indicating whether the first video track is muted.

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalMedia

Inherited from: WebRtcMediaBase

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

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets 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.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: WebRtcMediaBase

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