/ fm / liveswitch / IPluginLocalMedia

Interface: IPluginLocalMedia

fm.liveswitch.IPluginLocalMedia

An interface for COM usage.

Table of contents

Methods

• AttachView
• ChangeAudioSourceInput
• ChangeVideoSourceInput
• Destroy
• GetAudioEncoding
• GetAudioEncodings
• GetAudioGain
• GetAudioMuted
• GetAudioSimulcastDisabled
• GetAudioSimulcastEncodingCount
• GetAudioSimulcastPreferredBitrate
• GetAudioSourceInput
• GetAudioSourceInputs
• GetAudioVolume
• GetHandle
• GetId
• GetState
• GetVideoEncoding
• GetVideoEncodings
• GetVideoMuted
• GetVideoSimulcastBitsPerPixel
• GetVideoSimulcastDegradationPreference
• GetVideoSimulcastDisabled
• GetVideoSimulcastEncodingCount
• GetVideoSimulcastPreferredBitrate
• GetVideoSize
• GetVideoSourceInput
• GetVideoSourceInputs
• GrabVideoFrame
• Initialize
• SetAudioEncodings
• SetAudioGain
• SetAudioMuted
• SetAudioSimulcastDisabled
• SetAudioSimulcastEncodingCount
• SetAudioSimulcastPreferredBitrate
• SetAudioSourceInput
• SetAudioVolume
• SetId
• SetOnAudioDestroyed
• SetOnAudioLevel
• SetOnAudioStarted
• SetOnAudioStopped
• SetOnVideoDestroyed
• SetOnVideoSize
• SetOnVideoStarted
• SetOnVideoStopped
• SetVideoEncodings
• SetVideoMuted
• SetVideoSimulcastBitsPerPixel
• SetVideoSimulcastDegradationPreference
• SetVideoSimulcastDisabled
• SetVideoSimulcastEncodingCount
• SetVideoSimulcastPreferredBitrate
• SetVideoSourceInput
• Start
• Stop

Methods

AttachView

▸ AttachView(viewHandle: number): void

Parameters:

Name	Type
viewHandle	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:7

---

ChangeAudioSourceInput

▸ ChangeAudioSourceInput(promise: Object, audioSourceInput: string): void

Parameters:

Name	Type
promise	Object
audioSourceInput	string

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:8

---

ChangeVideoSourceInput

▸ ChangeVideoSourceInput(promise: Object, videoSourceInput: string): void

Parameters:

Name	Type
promise	Object
videoSourceInput	string

Returns: void

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

---

Destroy

▸ Destroy(): void

Returns: void

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

---

GetAudioEncoding

▸ GetAudioEncoding(): string

Returns: string

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

---

GetAudioEncodings

▸ GetAudioEncodings(): string

Returns: string

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

---

GetAudioGain

▸ GetAudioGain(): number

Returns: number

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

---

GetAudioMuted

▸ GetAudioMuted(): boolean

Returns: boolean

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

---

GetAudioSimulcastDisabled

▸ GetAudioSimulcastDisabled(): boolean

Returns: boolean

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

---

GetAudioSimulcastEncodingCount

▸ GetAudioSimulcastEncodingCount(): number

Returns: number

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

---

GetAudioSimulcastPreferredBitrate

▸ GetAudioSimulcastPreferredBitrate(): number

Returns: number

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

---

GetAudioSourceInput

▸ GetAudioSourceInput(): string

Returns: string

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

---

GetAudioSourceInputs

▸ GetAudioSourceInputs(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

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

---

GetAudioVolume

▸ GetAudioVolume(): number

Returns: number

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

---

GetHandle

▸ GetHandle(): number

Returns: number

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

---

GetId

▸ GetId(): string

Returns: string

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

---

GetState

▸ GetState(): number

Returns: number

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

---

GetVideoEncoding

▸ GetVideoEncoding(): string

Returns: string

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

---

GetVideoEncodings

▸ GetVideoEncodings(): string

Returns: string

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

---

GetVideoMuted

▸ GetVideoMuted(): boolean

Returns: boolean

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

---

GetVideoSimulcastBitsPerPixel

▸ GetVideoSimulcastBitsPerPixel(): number

Returns: number

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

---

GetVideoSimulcastDegradationPreference

▸ GetVideoSimulcastDegradationPreference(): number

Returns: number

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

---

GetVideoSimulcastDisabled

▸ GetVideoSimulcastDisabled(): boolean

Returns: boolean

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

---

GetVideoSimulcastEncodingCount

▸ GetVideoSimulcastEncodingCount(): number

Returns: number

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

---

GetVideoSimulcastPreferredBitrate

▸ GetVideoSimulcastPreferredBitrate(): number

Returns: number

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

---

GetVideoSize

▸ GetVideoSize(): string

Returns: string

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

---

GetVideoSourceInput

▸ GetVideoSourceInput(): string

Returns: string

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

---

GetVideoSourceInputs

▸ GetVideoSourceInputs(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

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

---

GrabVideoFrame

▸ GrabVideoFrame(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

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

---

Initialize

▸ Initialize(disableAudio: boolean, disableVideo: boolean, isScreenShare: boolean): void

Parameters:

Name	Type
disableAudio	boolean
disableVideo	boolean
isScreenShare	boolean

Returns: void

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

---

SetAudioEncodings

▸ SetAudioEncodings(valueJson: string): void

Parameters:

Name	Type
valueJson	string

Returns: void

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

---

SetAudioGain

▸ SetAudioGain(gain: number): void

Parameters:

Name	Type
gain	number

Returns: void

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

---

SetAudioMuted

▸ SetAudioMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

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

---

SetAudioSimulcastDisabled

▸ SetAudioSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

SetAudioSimulcastEncodingCount

▸ SetAudioSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

SetAudioSimulcastPreferredBitrate

▸ SetAudioSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

SetAudioSourceInput

▸ SetAudioSourceInput(value: string): void

Parameters:

Name	Type
value	string

Returns: void

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

---

SetAudioVolume

▸ SetAudioVolume(volume: number): void

Parameters:

Name	Type
volume	number

Returns: void

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

---

SetId

▸ SetId(idValue: string): void

Parameters:

Name	Type
idValue	string

Returns: void

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

---

SetOnAudioDestroyed

▸ SetOnAudioDestroyed(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnAudioLevel

▸ SetOnAudioLevel(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnAudioStarted

▸ SetOnAudioStarted(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnAudioStopped

▸ SetOnAudioStopped(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnVideoDestroyed

▸ SetOnVideoDestroyed(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnVideoSize

▸ SetOnVideoSize(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnVideoStarted

▸ SetOnVideoStarted(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnVideoStopped

▸ SetOnVideoStopped(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetVideoEncodings

▸ SetVideoEncodings(valueJson: string): void

Parameters:

Name	Type
valueJson	string

Returns: void

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

---

SetVideoMuted

▸ SetVideoMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

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

---

SetVideoSimulcastBitsPerPixel

▸ SetVideoSimulcastBitsPerPixel(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

SetVideoSimulcastDegradationPreference

▸ SetVideoSimulcastDegradationPreference(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

SetVideoSimulcastDisabled

▸ SetVideoSimulcastDisabled(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:58

---

SetVideoSimulcastEncodingCount

▸ SetVideoSimulcastEncodingCount(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:59

---

SetVideoSimulcastPreferredBitrate

▸ SetVideoSimulcastPreferredBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

SetVideoSourceInput

▸ SetVideoSourceInput(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:61

---

Start

▸ Start(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:62

---

Stop

▸ Stop(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/IPluginLocalMedia.ts:63