/ fm / liveswitch / PluginLocalMedia

Class: PluginLocalMedia

fm.liveswitch.PluginLocalMedia

Hierarchy

• PluginMedia

  ↳ PluginLocalMedia

Implements

• ILocalMedia<PluginLocalMedia, PluginAudioTrack, PluginVideoTrack>
• IInternalLocalMedia

Table of contents

Constructors

• constructor

Properties

• _videoSink

Methods

• addOnAudioDestroyed
• addOnAudioLevel
• addOnAudioStarted
• addOnAudioStopped
• addOnVideoDestroyed
• addOnVideoSize
• addOnVideoStarted
• addOnVideoStopped
• changeAudioSourceInput
• changeVideoSourceInput
• checkifLoaded
• destroy
• getAudio
• getAudioEncoding
• getAudioEncodings
• getAudioGain
• getAudioMuted
• getAudioSimulcastDisabled
• getAudioSimulcastEncodingCount
• getAudioSimulcastPreferredBitrate
• getAudioSink
• getAudioSourceInput
• getAudioSourceInputs
• getAudioTrack
• getAudioTracks
• getAudioVolume
• getDynamicProperties
• getDynamicValue
• getHandle
• getId
• getScreen
• getState
• getTypeString
• getVideo
• getVideoEncoding
• getVideoEncodings
• getVideoMuted
• getVideoSimulcastBitsPerPixel
• getVideoSimulcastDegradationPreference
• getVideoSimulcastDisabled
• getVideoSimulcastEncodingCount
• getVideoSimulcastPreferredBitrate
• getVideoSink
• getVideoSize
• getVideoSourceInput
• getVideoSourceInputs
• getVideoTrack
• getVideoTracks
• getView
• getViewSink
• grabVideoFrame
• removeOnAudioDestroyed
• removeOnAudioLevel
• removeOnAudioStarted
• removeOnAudioStopped
• removeOnVideoDestroyed
• removeOnVideoSize
• removeOnVideoStarted
• removeOnVideoStopped
• setAudio
• setAudioEncodings
• setAudioGain
• setAudioMuted
• setAudioSimulcastDisabled
• setAudioSimulcastEncodingCount
• setAudioSimulcastPreferredBitrate
• setAudioSourceInput
• setAudioVolume
• setDynamicValue
• setId
• setScreen
• setVideo
• setVideoEncodings
• setVideoMuted
• setVideoSimulcastBitsPerPixel
• setVideoSimulcastDegradationPreference
• setVideoSimulcastDisabled
• setVideoSimulcastEncodingCount
• setVideoSimulcastPreferredBitrate
• setVideoSourceInput
• start
• stop
• unsetDynamicValue

Constructors

constructor

+ new PluginLocalMedia(external: IExternalLocalMedia, audio: any, video: any, screen?: boolean): PluginLocalMedia

Parameters:

Name	Type
external	IExternalLocalMedia
audio	any
video	any
screen?	boolean

Returns: PluginLocalMedia

Inherited from: PluginMedia

Properties

_videoSink

• Protected _videoSink: PluginDomVideoSink= null

Inherited from: PluginMedia._videoSink

Methods

addOnAudioDestroyed

▸ addOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

addOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

addOnAudioStarted

▸ addOnAudioStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

addOnAudioStopped

▸ addOnAudioStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

addOnVideoDestroyed

▸ addOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

addOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

addOnVideoStarted

▸ addOnVideoStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

addOnVideoStopped

▸ addOnVideoStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

changeAudioSourceInput

▸ changeAudioSourceInput(audioSourceInput: SourceInput): Future<Object>

Parameters:

Name	Type
audioSourceInput	SourceInput

Returns: Future<Object>

Implementation of: IInternalLocalMedia

---

changeVideoSourceInput

▸ changeVideoSourceInput(videoSourceInput: SourceInput): Future<Object>

Parameters:

Name	Type
videoSourceInput	SourceInput

Returns: Future<Object>

Implementation of: IInternalLocalMedia

---

checkifLoaded

▸ PrivatecheckifLoaded(object: LocalMediaActiveXObject): void

Parameters:

Name	Type
object	LocalMediaActiveXObject

Returns: void

---

destroy

▸ destroy(): void

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

getAudio

▸ getAudio(): any

Returns: any

Inherited from: PluginMedia

---

getAudioEncoding

▸ getAudioEncoding(): AudioEncodingConfig

Returns: AudioEncodingConfig

Implementation of: IInternalLocalMedia

---

getAudioEncodings

▸ getAudioEncodings(): AudioEncodingConfig[]

Returns: AudioEncodingConfig[]

Implementation of: IInternalLocalMedia

---

getAudioGain

▸ getAudioGain(): number

Returns: number

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

getAudioMuted

▸ getAudioMuted(): boolean

Returns: boolean

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

getAudioSimulcastDisabled

▸ getAudioSimulcastDisabled(): boolean

Returns: boolean

Implementation of: IInternalLocalMedia

---

getAudioSimulcastEncodingCount

▸ getAudioSimulcastEncodingCount(): number

Returns: number

Implementation of: IInternalLocalMedia

---

getAudioSimulcastPreferredBitrate

▸ getAudioSimulcastPreferredBitrate(): number

Returns: number

Implementation of: IInternalLocalMedia

---

getAudioSink

▸ getAudioSink(): PluginDomAudioSink

Returns: PluginDomAudioSink

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getAudioSourceInput

▸ getAudioSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IInternalLocalMedia

---

getAudioSourceInputs

▸ getAudioSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IInternalLocalMedia

---

getAudioTrack

▸ getAudioTrack(): PluginAudioTrack

Returns: PluginAudioTrack

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getAudioTracks

▸ getAudioTracks(): PluginAudioTrack[]

Returns: PluginAudioTrack[]

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getAudioVolume

▸ getAudioVolume(): number

Returns: number

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: PluginMedia

---

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

---

getHandle

▸ getHandle(): number

Returns: number

Overrides: PluginMedia

---

getId

▸ getId(): string

Returns: string

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

getScreen

▸ getScreen(): boolean

Returns: boolean

---

getState

▸ getState(): LocalMediaState

Returns: LocalMediaState

Implementation of: IInternalLocalMedia

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginMedia

---

getVideo

▸ getVideo(): any

Returns: any

Inherited from: PluginMedia

---

getVideoEncoding

▸ getVideoEncoding(): VideoEncodingConfig

Returns: VideoEncodingConfig

Implementation of: IInternalLocalMedia

---

getVideoEncodings

▸ getVideoEncodings(): VideoEncodingConfig[]

Returns: VideoEncodingConfig[]

Implementation of: IInternalLocalMedia

---

getVideoMuted

▸ getVideoMuted(): boolean

Returns: boolean

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

getVideoSimulcastBitsPerPixel

▸ getVideoSimulcastBitsPerPixel(): number

Returns: number

Implementation of: IInternalLocalMedia

---

getVideoSimulcastDegradationPreference

▸ getVideoSimulcastDegradationPreference(): VideoDegradationPreference

Returns: VideoDegradationPreference

Implementation of: IInternalLocalMedia

---

getVideoSimulcastDisabled

▸ getVideoSimulcastDisabled(): boolean

Returns: boolean

Implementation of: IInternalLocalMedia

---

getVideoSimulcastEncodingCount

▸ getVideoSimulcastEncodingCount(): number

Returns: number

Implementation of: IInternalLocalMedia

---

getVideoSimulcastPreferredBitrate

▸ getVideoSimulcastPreferredBitrate(): number

Returns: number

Implementation of: IInternalLocalMedia

---

getVideoSink

▸ getVideoSink(): PluginDomVideoSink

Returns: PluginDomVideoSink

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getVideoSourceInput

▸ getVideoSourceInput(): SourceInput

Returns: SourceInput

Implementation of: IInternalLocalMedia

---

getVideoSourceInputs

▸ getVideoSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Implementation of: IInternalLocalMedia

---

getVideoTrack

▸ getVideoTrack(): PluginVideoTrack

Returns: PluginVideoTrack

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getVideoTracks

▸ getVideoTracks(): PluginVideoTrack[]

Returns: PluginVideoTrack[]

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getView

▸ getView(): HTMLElement

Returns: HTMLElement

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

getViewSink

▸ getViewSink(): PluginDomVideoSink

Returns: PluginDomVideoSink

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

grabVideoFrame

▸ grabVideoFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

removeOnAudioDestroyed

▸ removeOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

removeOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

removeOnAudioStarted

▸ removeOnAudioStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

removeOnAudioStopped

▸ removeOnAudioStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

removeOnVideoDestroyed

▸ removeOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

removeOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

removeOnVideoStarted

▸ removeOnVideoStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

removeOnVideoStopped

▸ removeOnVideoStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalLocalMedia

---

setAudio

▸ setAudio(audio: any): void

Parameters:

Name	Type
audio	any

Returns: void

Inherited from: PluginMedia

---

setAudioEncodings

▸ setAudioEncodings(value: AudioEncodingConfig[]): void

Parameters:

Name	Type
value	AudioEncodingConfig[]

Returns: void

Implementation of: IInternalLocalMedia

---

setAudioGain

▸ setAudioGain(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

setAudioMuted

▸ setAudioMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

setAudioSimulcastDisabled

▸ setAudioSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalLocalMedia

---

setAudioSimulcastEncodingCount

▸ setAudioSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

---

setAudioSimulcastPreferredBitrate

▸ setAudioSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

---

setAudioSourceInput

▸ setAudioSourceInput(value: SourceInput): void

Parameters:

Name	Type
value	SourceInput

Returns: void

Implementation of: IInternalLocalMedia

---

setAudioVolume

▸ setAudioVolume(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

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

---

setId

▸ setId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalLocalMedia

Inherited from: PluginMedia

---

setScreen

▸ setScreen(screen: boolean): void

Parameters:

Name	Type
screen	boolean

Returns: void

---

setVideo

▸ setVideo(video: any): void

Parameters:

Name	Type
video	any

Returns: void

Inherited from: PluginMedia

---

setVideoEncodings

▸ setVideoEncodings(value: VideoEncodingConfig[]): void

Parameters:

Name	Type
value	VideoEncodingConfig[]

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalLocalMedia

Overrides: PluginMedia

---

setVideoSimulcastBitsPerPixel

▸ setVideoSimulcastBitsPerPixel(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoSimulcastDegradationPreference

▸ setVideoSimulcastDegradationPreference(value: VideoDegradationPreference): void

Parameters:

Name	Type
value	VideoDegradationPreference

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoSimulcastDisabled

▸ setVideoSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoSimulcastEncodingCount

▸ setVideoSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoSimulcastPreferredBitrate

▸ setVideoSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalLocalMedia

---

setVideoSourceInput

▸ setVideoSourceInput(value: SourceInput): void

Parameters:

Name	Type
value	SourceInput

Returns: void

Implementation of: IInternalLocalMedia

---

start

▸ start(): Future<PluginLocalMedia>

Returns: Future<PluginLocalMedia>

Implementation of: IInternalLocalMedia

---

stop

▸ stop(): Future<PluginLocalMedia>

Returns: Future<PluginLocalMedia>

Implementation of: IInternalLocalMedia

---

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