/ fm / liveswitch / ILocalMedia

Interface: ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack>

fm.liveswitch.ILocalMedia

Local media interface.

Type parameters

Name	Type
TLocalMedia	-
TIAudioTrack	IAudioTrack
TIVideoTrack	IVideoTrack

Hierarchy

• IMedia<TIAudioTrack, TIVideoTrack>

  ↳ ILocalMedia

  ↳↳ IExternalLocalMedia

  ↳↳ IInternalLocalMedia

Implemented by

• LocalMedia
• PluginLocalMedia
• WebRtcLocalMedia

Table of contents

Methods

• addOnAudioDestroyed
• addOnAudioLevel
• addOnAudioMuted
• addOnAudioStarted
• addOnAudioStopped
• addOnAudioUnmuted
• addOnVideoDestroyed
• addOnVideoMuted
• addOnVideoSize
• addOnVideoSizeChange
• addOnVideoStarted
• addOnVideoStopped
• addOnVideoUnmuted
• changeAudioSourceInput
• changeVideoSourceInput
• destroy
• getAudioEncoding
• getAudioEncodings
• getAudioGain
• getAudioLevelInterval
• getAudioMuted
• getAudioSimulcastDisabled
• getAudioSimulcastEncodingCount
• getAudioSimulcastPreferredBitrate
• getAudioSourceInput
• getAudioSourceInputs
• getAudioTrack
• getAudioTracks
• getAudioVolume
• getId
• getState
• getVideoEncoding
• getVideoEncodings
• getVideoMuted
• getVideoSimulcastBitsPerPixel
• getVideoSimulcastDegradationPreference
• getVideoSimulcastDisabled
• getVideoSimulcastEncodingCount
• getVideoSimulcastPreferredBitrate
• getVideoSize
• getVideoSourceInput
• getVideoSourceInputs
• getVideoTrack
• getVideoTracks
• grabVideoFrame
• removeOnAudioDestroyed
• removeOnAudioLevel
• removeOnAudioMuted
• removeOnAudioStarted
• removeOnAudioStopped
• removeOnAudioUnmuted
• removeOnVideoDestroyed
• removeOnVideoMuted
• removeOnVideoSize
• removeOnVideoSizeChange
• removeOnVideoStarted
• removeOnVideoStopped
• removeOnVideoUnmuted
• setAudioEncodings
• setAudioGain
• setAudioLevelInterval
• setAudioMuted
• setAudioSimulcastDisabled
• setAudioSimulcastEncodingCount
• setAudioSimulcastPreferredBitrate
• setAudioSourceInput
• setAudioVolume
• setId
• setVideoEncodings
• setVideoMuted
• setVideoSimulcastBitsPerPixel
• setVideoSimulcastDegradationPreference
• setVideoSimulcastDisabled
• setVideoSimulcastEncodingCount
• setVideoSimulcastPreferredBitrate
• setVideoSourceInput
• start
• stop

Methods

addOnAudioDestroyed

▸ addOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:9

---

addOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:10

---

addOnAudioMuted

▸ addOnAudioMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:9

---

addOnAudioStarted

▸ addOnAudioStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:10

---

addOnAudioStopped

▸ addOnAudioStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:11

---

addOnAudioUnmuted

▸ addOnAudioUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:12

---

addOnVideoDestroyed

▸ addOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:11

---

addOnVideoMuted

▸ addOnVideoMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:13

---

addOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:12

---

addOnVideoSizeChange

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:13

---

addOnVideoStarted

▸ addOnVideoStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:14

---

addOnVideoStopped

▸ addOnVideoStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:15

---

addOnVideoUnmuted

▸ addOnVideoUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:16

---

changeAudioSourceInput

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

Parameters:

Name	Type
audioSourceInput	SourceInput

Returns: Future<Object>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:17

---

changeVideoSourceInput

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

Parameters:

Name	Type
videoSourceInput	SourceInput

Returns: Future<Object>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:18

---

destroy

▸ destroy(): void

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:14

---

getAudioEncoding

▸ getAudioEncoding(): AudioEncodingConfig

Returns: AudioEncodingConfig

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:19

---

getAudioEncodings

▸ getAudioEncodings(): AudioEncodingConfig[]

Returns: AudioEncodingConfig[]

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:20

---

getAudioGain

▸ getAudioGain(): number

Returns: number

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:15

---

getAudioLevelInterval

▸ getAudioLevelInterval(): number

Returns: number

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:16

---

getAudioMuted

▸ getAudioMuted(): boolean

Returns: boolean

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:17

---

getAudioSimulcastDisabled

▸ getAudioSimulcastDisabled(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:21

---

getAudioSimulcastEncodingCount

▸ getAudioSimulcastEncodingCount(): number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:22

---

getAudioSimulcastPreferredBitrate

▸ getAudioSimulcastPreferredBitrate(): number

Returns: number

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

---

getAudioSourceInput

▸ getAudioSourceInput(): SourceInput

Returns: SourceInput

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

---

getAudioSourceInputs

▸ getAudioSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:25

---

getAudioTrack

▸ getAudioTrack(): TIAudioTrack

Returns: TIAudioTrack

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:18

---

getAudioTracks

▸ getAudioTracks(): TIAudioTrack[]

Returns: TIAudioTrack[]

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:19

---

getAudioVolume

▸ getAudioVolume(): number

Returns: number

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:20

---

getId

▸ getId(): string

Returns: string

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:21

---

getState

▸ getState(): LocalMediaState

Returns: LocalMediaState

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:26

---

getVideoEncoding

▸ getVideoEncoding(): VideoEncodingConfig

Returns: VideoEncodingConfig

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:27

---

getVideoEncodings

▸ getVideoEncodings(): VideoEncodingConfig[]

Returns: VideoEncodingConfig[]

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:28

---

getVideoMuted

▸ getVideoMuted(): boolean

Returns: boolean

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:22

---

getVideoSimulcastBitsPerPixel

▸ getVideoSimulcastBitsPerPixel(): number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:29

---

getVideoSimulcastDegradationPreference

▸ getVideoSimulcastDegradationPreference(): VideoDegradationPreference

Returns: VideoDegradationPreference

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:30

---

getVideoSimulcastDisabled

▸ getVideoSimulcastDisabled(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:31

---

getVideoSimulcastEncodingCount

▸ getVideoSimulcastEncodingCount(): number

Returns: number

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

---

getVideoSimulcastPreferredBitrate

▸ getVideoSimulcastPreferredBitrate(): number

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:33

---

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Inherited from: IMedia

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

---

getVideoSourceInput

▸ getVideoSourceInput(): SourceInput

Returns: SourceInput

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:34

---

getVideoSourceInputs

▸ getVideoSourceInputs(): Future<SourceInput[]>

Returns: Future<SourceInput[]>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:35

---

getVideoTrack

▸ getVideoTrack(): TIVideoTrack

Returns: TIVideoTrack

Inherited from: IMedia

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

---

getVideoTracks

▸ getVideoTracks(): TIVideoTrack[]

Returns: TIVideoTrack[]

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:25

---

grabVideoFrame

▸ grabVideoFrame(): Future<VideoBuffer>

Returns: Future<VideoBuffer>

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:26

---

removeOnAudioDestroyed

▸ removeOnAudioDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:27

---

removeOnAudioLevel

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

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:28

---

removeOnAudioMuted

▸ removeOnAudioMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:36

---

removeOnAudioStarted

▸ removeOnAudioStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:37

---

removeOnAudioStopped

▸ removeOnAudioStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

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

---

removeOnAudioUnmuted

▸ removeOnAudioUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:39

---

removeOnVideoDestroyed

▸ removeOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:29

---

removeOnVideoMuted

▸ removeOnVideoMuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:40

---

removeOnVideoSize

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:30

---

removeOnVideoSizeChange

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

Parameters:

Name	Type
value	IAction1<Size>

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:31

---

removeOnVideoStarted

▸ removeOnVideoStarted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:41

---

removeOnVideoStopped

▸ removeOnVideoStopped(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

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

---

removeOnVideoUnmuted

▸ removeOnVideoUnmuted(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

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

---

setAudioEncodings

▸ setAudioEncodings(value: AudioEncodingConfig[]): void

Parameters:

Name	Type
value	AudioEncodingConfig[]

Returns: void

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

---

setAudioGain

▸ setAudioGain(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Inherited from: IMedia

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

---

setAudioLevelInterval

▸ setAudioLevelInterval(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:33

---

setAudioMuted

▸ setAudioMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:34

---

setAudioSimulcastDisabled

▸ setAudioSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setAudioSimulcastEncodingCount

▸ setAudioSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:46

---

setAudioSimulcastPreferredBitrate

▸ setAudioSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

setAudioSourceInput

▸ setAudioSourceInput(value: SourceInput): void

Parameters:

Name	Type
value	SourceInput

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:48

---

setAudioVolume

▸ setAudioVolume(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:35

---

setId

▸ setId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:36

---

setVideoEncodings

▸ setVideoEncodings(value: VideoEncodingConfig[]): void

Parameters:

Name	Type
value	VideoEncodingConfig[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:49

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IMedia

Defined in: Generated/TypeScript/fm.liveswitch/IMedia.ts:37

---

setVideoSimulcastBitsPerPixel

▸ setVideoSimulcastBitsPerPixel(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

setVideoSimulcastDegradationPreference

▸ setVideoSimulcastDegradationPreference(value: VideoDegradationPreference): void

Parameters:

Name	Type
value	VideoDegradationPreference

Returns: void

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

---

setVideoSimulcastDisabled

▸ setVideoSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:52

---

setVideoSimulcastEncodingCount

▸ setVideoSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:53

---

setVideoSimulcastPreferredBitrate

▸ setVideoSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:54

---

setVideoSourceInput

▸ setVideoSourceInput(value: SourceInput): void

Parameters:

Name	Type
value	SourceInput

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:55

---

start

▸ start(): Future<TLocalMedia>

Returns: Future<TLocalMedia>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:56

---

stop

▸ stop(): Future<TLocalMedia>

Returns: Future<TLocalMedia>

Defined in: Generated/TypeScript/fm.liveswitch/ILocalMedia.ts:57