/ fm / liveswitch / PluginMedia

Class: PluginMedia

fm.liveswitch.PluginMedia

Hierarchy

• Dynamic

  ↳ PluginMedia

  ↳↳ PluginLocalMedia

  ↳↳ PluginRemoteMedia

Implements

• IMedia<PluginAudioTrack, PluginVideoTrack>
• IInternalMedia

Table of contents

Constructors

• constructor

Properties

• _videoSink

Methods

• addOnAudioDestroyed
• addOnAudioLevel
• addOnVideoDestroyed
• addOnVideoSize
• destroy
• getAudio
• getAudioGain
• getAudioMuted
• getAudioSink
• getAudioTrack
• getAudioTracks
• getAudioVolume
• getDynamicProperties
• getDynamicValue
• getHandle
• getId
• getTypeString
• getVideo
• getVideoMuted
• getVideoSink
• getVideoSize
• getVideoTrack
• getVideoTracks
• getView
• getViewSink
• grabVideoFrame
• removeOnAudioDestroyed
• removeOnAudioLevel
• removeOnVideoDestroyed
• removeOnVideoSize
• setAudio
• setAudioGain
• setAudioMuted
• setAudioVolume
• setDynamicValue
• setId
• setVideo
• setVideoMuted
• unsetDynamicValue

Constructors

constructor

+ new PluginMedia(external: IExternalMedia): PluginMedia

Parameters:

Name	Type
external	IExternalMedia

Returns: PluginMedia

Inherited from: Dynamic

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:202

Properties

_videoSink

• Protected _videoSink: PluginDomVideoSink= null

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:202

Methods

addOnAudioDestroyed

▸ AbstractaddOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:42

---

addOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalMedia

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

---

addOnVideoDestroyed

▸ AbstractaddOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:43

---

addOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:60

---

destroy

▸ destroy(): void

Returns: void

Implementation of: IInternalMedia

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

---

getAudio

▸ getAudio(): any

Returns: any

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:182

---

getAudioGain

▸ getAudioGain(): number

Returns: number

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:71

---

getAudioMuted

▸ getAudioMuted(): boolean

Returns: boolean

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:74

---

getAudioSink

▸ getAudioSink(): PluginDomAudioSink

Returns: PluginDomAudioSink

Implementation of: IInternalMedia

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

---

getAudioTrack

▸ getAudioTrack(): PluginAudioTrack

Returns: PluginAudioTrack

Implementation of: IInternalMedia

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

---

getAudioTracks

▸ getAudioTracks(): PluginAudioTrack[]

Returns: PluginAudioTrack[]

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:83

---

getAudioVolume

▸ getAudioVolume(): number

Returns: number

Implementation of: IInternalMedia

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

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

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

---

getHandle

▸ getHandle(): number

Returns: number

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

---

getId

▸ getId(): string

Returns: string

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:92

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

getVideo

▸ getVideo(): any

Returns: any

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:190

---

getVideoMuted

▸ getVideoMuted(): boolean

Returns: boolean

Implementation of: IInternalMedia

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

---

getVideoSink

▸ getVideoSink(): PluginDomVideoSink

Returns: PluginDomVideoSink

Implementation of: IInternalMedia

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

---

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:98

---

getVideoTrack

▸ getVideoTrack(): PluginVideoTrack

Returns: PluginVideoTrack

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:101

---

getVideoTracks

▸ getVideoTracks(): PluginVideoTrack[]

Returns: PluginVideoTrack[]

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:107

---

getView

▸ getView(): HTMLElement

Returns: HTMLElement

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:167

---

getViewSink

▸ getViewSink(): PluginDomVideoSink

Returns: PluginDomVideoSink

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:173

---

grabVideoFrame

▸ grabVideoFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:113

---

removeOnAudioDestroyed

▸ AbstractremoveOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

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

---

removeOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:126

---

removeOnVideoDestroyed

▸ AbstractremoveOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMedia

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

---

removeOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:132

---

setAudio

▸ setAudio(audio: any): void

Parameters:

Name	Type
audio	any

Returns: void

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

---

setAudioGain

▸ setAudioGain(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:138

---

setAudioMuted

▸ setAudioMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:141

---

setAudioVolume

▸ setAudioVolume(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:144

---

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

---

setId

▸ setId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:147

---

setVideo

▸ setVideo(video: any): void

Parameters:

Name	Type
video	any

Returns: void

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

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMedia

Defined in: fm/Generated/TypeScript/fm.liveswitch/PluginMedia.ts:150

---

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

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