/ fm / liveswitch / PluginLocalMedia
Class: PluginLocalMedia
fm.liveswitch.PluginLocalMedia
Hierarchy
-
↳ PluginLocalMedia
Implements
Table of contents
Constructors
Properties
Methods
- addOnAudioDestroyed
- addOnAudioLevel
- addOnAudioMuted
- addOnAudioStarted
- addOnAudioStopped
- addOnAudioUnmuted
- addOnDeviceChange
- addOnVideoDestroyed
- addOnVideoMuted
- addOnVideoSize
- addOnVideoSizeChange
- addOnVideoStarted
- addOnVideoStopped
- addOnVideoUnmuted
- changeAudioSourceInput
- changeVideoSourceInput
- checkifLoaded
- destroy
- getAudio
- getAudioEncoding
- getAudioEncodings
- getAudioGain
- getAudioLevelInterval
- 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
- removeOnAudioMuted
- removeOnAudioStarted
- removeOnAudioStopped
- removeOnAudioUnmuted
- removeOnDeviceChange
- removeOnVideoDestroyed
- removeOnVideoMuted
- removeOnVideoSize
- removeOnVideoSizeChange
- removeOnVideoStarted
- removeOnVideoStopped
- removeOnVideoUnmuted
- setAudio
- setAudioEncodings
- setAudioGain
- setAudioLevelInterval
- 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
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:75
Properties
_videoSink
• Protected
_videoSink: PluginDomVideoSink= null
Inherited from: PluginMedia._videoSink
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:230
Methods
addOnAudioDestroyed
▸ addOnAudioDestroyed(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:193
addOnAudioLevel
▸ addOnAudioLevel(value
: IAction1<number>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<number> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:55
addOnAudioMuted
▸ addOnAudioMuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:169
addOnAudioStarted
▸ addOnAudioStarted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:181
addOnAudioStopped
▸ addOnAudioStopped(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:187
addOnAudioUnmuted
▸ addOnAudioUnmuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:175
addOnDeviceChange
▸ addOnDeviceChange(value
: IAction1<any>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<any> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:372
addOnVideoDestroyed
▸ addOnVideoDestroyed(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:196
addOnVideoMuted
▸ addOnVideoMuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:172
addOnVideoSize
▸ addOnVideoSize(value
: IAction1<Size>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<Size> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:65
addOnVideoSizeChange
▸ addOnVideoSizeChange(value
: IAction1<Size>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<Size> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:76
addOnVideoStarted
▸ addOnVideoStarted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:184
addOnVideoStopped
▸ addOnVideoStopped(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:190
addOnVideoUnmuted
▸ addOnVideoUnmuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:178
changeAudioSourceInput
▸ changeAudioSourceInput(audioSourceInput
: SourceInput): Future<Object>
Parameters:
Name | Type |
---|---|
audioSourceInput |
SourceInput |
Returns: Future<Object>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:249
changeVideoSourceInput
▸ changeVideoSourceInput(videoSourceInput
: SourceInput): Future<Object>
Parameters:
Name | Type |
---|---|
videoSourceInput |
SourceInput |
Returns: Future<Object>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:256
checkifLoaded
▸ Private
checkifLoaded(object
: LocalMediaActiveXObject): void
Parameters:
Name | Type |
---|---|
object |
LocalMediaActiveXObject |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:380
destroy
▸ destroy(): void
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:298
getAudio
▸ getAudio(): any
Returns: any
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:210
getAudioEncoding
▸ getAudioEncoding(): AudioEncodingConfig
Returns: AudioEncodingConfig
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:230
getAudioEncodings
▸ getAudioEncodings(): AudioEncodingConfig[]
Returns: AudioEncodingConfig[]
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:233
getAudioGain
▸ getAudioGain(): number
Returns: number
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:301
getAudioLevelInterval
▸ getAudioLevelInterval(): number
Returns: number
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:90
getAudioMuted
▸ getAudioMuted(): boolean
Returns: boolean
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:304
getAudioSimulcastDisabled
▸ getAudioSimulcastDisabled(): boolean
Returns: boolean
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:323
getAudioSimulcastEncodingCount
▸ getAudioSimulcastEncodingCount(): number
Returns: number
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:329
getAudioSimulcastPreferredBitrate
▸ getAudioSimulcastPreferredBitrate(): number
Returns: number
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:335
getAudioSink
▸ getAudioSink(): PluginDomAudioSink
Returns: PluginDomAudioSink
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:182
getAudioSourceInput
▸ getAudioSourceInput(): SourceInput
Returns: SourceInput
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:263
getAudioSourceInputs
▸ getAudioSourceInputs(): Future<SourceInput[]>
Returns: Future<SourceInput[]>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:266
getAudioTrack
▸ getAudioTrack(): PluginAudioTrack
Returns: PluginAudioTrack
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:96
getAudioTracks
▸ getAudioTracks(): PluginAudioTrack[]
Returns: PluginAudioTrack[]
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:102
getAudioVolume
▸ getAudioVolume(): number
Returns: number
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:108
getDynamicProperties
▸ getDynamicProperties(): Hash<string, Object>
Gets all dynamic properties on this instance.
Returns: Hash<string, Object>
Inherited from: PluginMedia
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: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58
getHandle
▸ getHandle(): number
Returns: number
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:165
getId
▸ getId(): string
Returns: string
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:307
getScreen
▸ getScreen(): boolean
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:66
getState
▸ getState(): LocalMediaState
Returns: LocalMediaState
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:73
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:7
getVideo
▸ getVideo(): any
Returns: any
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:218
getVideoEncoding
▸ getVideoEncoding(): VideoEncodingConfig
Returns: VideoEncodingConfig
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:239
getVideoEncodings
▸ getVideoEncodings(): VideoEncodingConfig[]
Returns: VideoEncodingConfig[]
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:242
getVideoMuted
▸ getVideoMuted(): boolean
Returns: boolean
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:310
getVideoSimulcastBitsPerPixel
▸ getVideoSimulcastBitsPerPixel(): number
Returns: number
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:359
getVideoSimulcastDegradationPreference
▸ getVideoSimulcastDegradationPreference(): VideoDegradationPreference
Returns: VideoDegradationPreference
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:365
getVideoSimulcastDisabled
▸ getVideoSimulcastDisabled(): boolean
Returns: boolean
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:341
getVideoSimulcastEncodingCount
▸ getVideoSimulcastEncodingCount(): number
Returns: number
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:347
getVideoSimulcastPreferredBitrate
▸ getVideoSimulcastPreferredBitrate(): number
Returns: number
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:353
getVideoSink
▸ getVideoSink(): PluginDomVideoSink
Returns: PluginDomVideoSink
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:188
getVideoSize
▸ getVideoSize(): Size
Returns: Size
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:117
getVideoSourceInput
▸ getVideoSourceInput(): SourceInput
Returns: SourceInput
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:277
getVideoSourceInputs
▸ getVideoSourceInputs(): Future<SourceInput[]>
Returns: Future<SourceInput[]>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:280
getVideoTrack
▸ getVideoTrack(): PluginVideoTrack
Returns: PluginVideoTrack
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:120
getVideoTracks
▸ getVideoTracks(): PluginVideoTrack[]
Returns: PluginVideoTrack[]
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:126
getView
▸ getView(): HTMLElement
Returns: HTMLElement
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:195
getViewSink
▸ getViewSink(): PluginDomVideoSink
Returns: PluginDomVideoSink
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:201
grabVideoFrame
▸ grabVideoFrame(): Future<VideoBuffer>
Returns: Future<VideoBuffer>
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:132
removeOnAudioDestroyed
▸ removeOnAudioDestroyed(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:223
removeOnAudioLevel
▸ removeOnAudioLevel(value
: IAction1<number>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<number> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:145
removeOnAudioMuted
▸ removeOnAudioMuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:199
removeOnAudioStarted
▸ removeOnAudioStarted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:211
removeOnAudioStopped
▸ removeOnAudioStopped(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:217
removeOnAudioUnmuted
▸ removeOnAudioUnmuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:205
removeOnDeviceChange
▸ removeOnDeviceChange(value
: IAction1<any>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<any> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:376
removeOnVideoDestroyed
▸ removeOnVideoDestroyed(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:226
removeOnVideoMuted
▸ removeOnVideoMuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:202
removeOnVideoSize
▸ removeOnVideoSize(value
: IAction1<Size>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<Size> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:151
removeOnVideoSizeChange
▸ removeOnVideoSizeChange(value
: IAction1<Size>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<Size> |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:157
removeOnVideoStarted
▸ removeOnVideoStarted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:214
removeOnVideoStopped
▸ removeOnVideoStopped(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:220
removeOnVideoUnmuted
▸ removeOnVideoUnmuted(value
: IAction0): void
Parameters:
Name | Type |
---|---|
value |
IAction0 |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:208
setAudio
▸ setAudio(audio
: any): void
Parameters:
Name | Type |
---|---|
audio |
any |
Returns: void
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:213
setAudioEncodings
▸ setAudioEncodings(value
: AudioEncodingConfig[]): void
Parameters:
Name | Type |
---|---|
value |
AudioEncodingConfig[] |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:236
setAudioGain
▸ setAudioGain(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:313
setAudioLevelInterval
▸ setAudioLevelInterval(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:166
setAudioMuted
▸ setAudioMuted(value
: boolean): void
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:316
setAudioSimulcastDisabled
▸ setAudioSimulcastDisabled(value
: boolean): void
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:326
setAudioSimulcastEncodingCount
▸ setAudioSimulcastEncodingCount(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:332
setAudioSimulcastPreferredBitrate
▸ setAudioSimulcastPreferredBitrate(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:338
setAudioSourceInput
▸ setAudioSourceInput(value
: SourceInput): void
Parameters:
Name | Type |
---|---|
value |
SourceInput |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:291
setAudioVolume
▸ setAudioVolume(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:172
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
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95
setId
▸ setId(value
: string): void
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IInternalLocalMedia
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:175
setScreen
▸ setScreen(screen
: boolean): void
Parameters:
Name | Type |
---|---|
screen |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:69
setVideo
▸ setVideo(video
: any): void
Parameters:
Name | Type |
---|---|
video |
any |
Returns: void
Inherited from: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginMedia.ts:221
setVideoEncodings
▸ setVideoEncodings(value
: VideoEncodingConfig[]): void
Parameters:
Name | Type |
---|---|
value |
VideoEncodingConfig[] |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:245
setVideoMuted
▸ setVideoMuted(value
: boolean): void
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalLocalMedia
Overrides: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:319
setVideoSimulcastBitsPerPixel
▸ setVideoSimulcastBitsPerPixel(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:362
setVideoSimulcastDegradationPreference
▸ setVideoSimulcastDegradationPreference(value
: VideoDegradationPreference): void
Parameters:
Name | Type |
---|---|
value |
VideoDegradationPreference |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:368
setVideoSimulcastDisabled
▸ setVideoSimulcastDisabled(value
: boolean): void
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:344
setVideoSimulcastEncodingCount
▸ setVideoSimulcastEncodingCount(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:350
setVideoSimulcastPreferredBitrate
▸ setVideoSimulcastPreferredBitrate(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:356
setVideoSourceInput
▸ setVideoSourceInput(value
: SourceInput): void
Parameters:
Name | Type |
---|---|
value |
SourceInput |
Returns: void
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:294
start
▸ start(): Future<PluginLocalMedia>
Returns: Future<PluginLocalMedia>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:141
stop
▸ stop(): Future<PluginLocalMedia>
Returns: Future<PluginLocalMedia>
Implementation of: IInternalLocalMedia
Defined in: Generated/TypeScript/fm.liveswitch/PluginLocalMedia.ts:156
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: PluginMedia
Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122