/ fm / liveswitch / IRemoteMedia

Interface: IRemoteMedia<TIAudioTrack, TIVideoTrack>

fm.liveswitch.IRemoteMedia

Remote media interface.

Type parameters

Name	Type
TIAudioTrack	IAudioTrack
TIVideoTrack	IVideoTrack

Hierarchy

• IMedia<TIAudioTrack, TIVideoTrack>

  ↳ IRemoteMedia

  ↳↳ IExternalRemoteMedia

  ↳↳ IInternalRemoteMedia

Implemented by

• PluginRemoteMedia
• RemoteMedia
• WebRtcRemoteMedia

Table of contents

Methods

• addOnAudioDestroyed
• addOnAudioLevel
• addOnVideoDestroyed
• addOnVideoSize
• addOnVideoSizeChange
• changeAudioSinkOutput
• changeVideoSinkOutput
• destroy
• getAudioGain
• getAudioLevelInterval
• getAudioMuted
• getAudioSinkOutput
• getAudioSinkOutputs
• getAudioTrack
• getAudioTracks
• getAudioVolume
• getId
• getVideoMuted
• getVideoSinkOutput
• getVideoSinkOutputs
• getVideoSize
• getVideoTrack
• getVideoTracks
• grabVideoFrame
• removeOnAudioDestroyed
• removeOnAudioLevel
• removeOnVideoDestroyed
• removeOnVideoSize
• removeOnVideoSizeChange
• setAudioGain
• setAudioLevelInterval
• setAudioMuted
• setAudioSinkOutput
• setAudioVolume
• setId
• setVideoMuted
• setVideoSinkOutput

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

---

addOnVideoDestroyed

▸ addOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

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

---

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

---

changeAudioSinkOutput

▸ changeAudioSinkOutput(audioSinkOutput: SinkOutput): Future<Object>

Parameters:

Name	Type
audioSinkOutput	SinkOutput

Returns: Future<Object>

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

---

changeVideoSinkOutput

▸ changeVideoSinkOutput(videoSinkOutput: SinkOutput): Future<Object>

Parameters:

Name	Type
videoSinkOutput	SinkOutput

Returns: Future<Object>

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

---

destroy

▸ destroy(): void

Returns: void

Inherited from: IMedia

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

---

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

---

getAudioSinkOutput

▸ getAudioSinkOutput(): SinkOutput

Returns: SinkOutput

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

---

getAudioSinkOutputs

▸ getAudioSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

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

---

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

---

getVideoMuted

▸ getVideoMuted(): boolean

Returns: boolean

Inherited from: IMedia

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

---

getVideoSinkOutput

▸ getVideoSinkOutput(): SinkOutput

Returns: SinkOutput

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

---

getVideoSinkOutputs

▸ getVideoSinkOutputs(): Future<SinkOutput[]>

Returns: Future<SinkOutput[]>

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

---

getVideoSize

▸ getVideoSize(): Size

Returns: Size

Inherited from: IMedia

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

---

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

---

removeOnVideoDestroyed

▸ removeOnVideoDestroyed(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IMedia

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

---

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

---

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

---

setAudioSinkOutput

▸ setAudioSinkOutput(value: SinkOutput): void

Parameters:

Name	Type
value	SinkOutput

Returns: void

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

---

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

---

setVideoMuted

▸ setVideoMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IMedia

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

---

setVideoSinkOutput

▸ setVideoSinkOutput(value: SinkOutput): void

Parameters:

Name	Type
value	SinkOutput

Returns: void

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