/ fm / liveswitch / IPluginRemoteMedia

Interface: IPluginRemoteMedia

fm.liveswitch.IPluginRemoteMedia

An interface for COM usage.

Table of contents

Methods

• AttachView
• ChangeAudioSinkOutput
• ChangeVideoSinkOutput
• Destroy
• GetAudioGain
• GetAudioMuted
• GetAudioSinkOutput
• GetAudioSinkOutputs
• GetAudioVolume
• GetHandle
• GetId
• GetVideoMuted
• GetVideoSinkOutput
• GetVideoSinkOutputs
• GetVideoSize
• GrabVideoFrame
• Initialize
• SetAudioGain
• SetAudioMuted
• SetAudioSinkOutput
• SetAudioVolume
• SetId
• SetOnAudioDestroyed
• SetOnAudioLevel
• SetOnVideoDestroyed
• SetOnVideoSize
• SetVideoMuted
• SetVideoSinkOutput

Methods

AttachView

▸ AttachView(viewHandle: number): void

Parameters:

Name	Type
viewHandle	number

Returns: void

---

ChangeAudioSinkOutput

▸ ChangeAudioSinkOutput(promise: Object, audioSinkOutput: string): void

Parameters:

Name	Type
promise	Object
audioSinkOutput	string

Returns: void

---

ChangeVideoSinkOutput

▸ ChangeVideoSinkOutput(promise: Object, videoSinkOutput: string): void

Parameters:

Name	Type
promise	Object
videoSinkOutput	string

Returns: void

---

Destroy

▸ Destroy(): void

Returns: void

---

GetAudioGain

▸ GetAudioGain(): number

Returns: number

---

GetAudioMuted

▸ GetAudioMuted(): boolean

Returns: boolean

---

GetAudioSinkOutput

▸ GetAudioSinkOutput(): string

Returns: string

---

GetAudioSinkOutputs

▸ GetAudioSinkOutputs(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

---

GetAudioVolume

▸ GetAudioVolume(): number

Returns: number

---

GetHandle

▸ GetHandle(): number

Returns: number

---

GetId

▸ GetId(): string

Returns: string

---

GetVideoMuted

▸ GetVideoMuted(): boolean

Returns: boolean

---

GetVideoSinkOutput

▸ GetVideoSinkOutput(): string

Returns: string

---

GetVideoSinkOutputs

▸ GetVideoSinkOutputs(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

---

GetVideoSize

▸ GetVideoSize(): string

Returns: string

---

GrabVideoFrame

▸ GrabVideoFrame(promise: Object): void

Parameters:

Name	Type
promise	Object

Returns: void

---

Initialize

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

Parameters:

Name	Type
disableAudio	boolean
disableVideo	boolean

Returns: void

---

SetAudioGain

▸ SetAudioGain(gain: number): void

Parameters:

Name	Type
gain	number

Returns: void

---

SetAudioMuted

▸ SetAudioMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

---

SetAudioSinkOutput

▸ SetAudioSinkOutput(value: string): void

Parameters:

Name	Type
value	string

Returns: void

---

SetAudioVolume

▸ SetAudioVolume(volume: number): void

Parameters:

Name	Type
volume	number

Returns: void

---

SetId

▸ SetId(idValue: string): void

Parameters:

Name	Type
idValue	string

Returns: void

---

SetOnAudioDestroyed

▸ SetOnAudioDestroyed(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

---

SetOnAudioLevel

▸ SetOnAudioLevel(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

---

SetOnVideoDestroyed

▸ SetOnVideoDestroyed(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

---

SetOnVideoSize

▸ SetOnVideoSize(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

---

SetVideoMuted

▸ SetVideoMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

---

SetVideoSinkOutput

▸ SetVideoSinkOutput(value: string): void

Parameters:

Name	Type
value	string

Returns: void