/ fm / liveswitch / IPluginVideoStream

Interface: IPluginVideoStream

fm.liveswitch.IPluginVideoStream

An interface for COM usage.

Table of contents

Methods

• ChangeDirection
• GetCodecDisabled
• GetControlTransportInfo
• GetDirection
• GetExternalId
• GetH264Disabled
• GetH265Disabled
• GetHandle
• GetId
• GetInfo
• GetInputMuted
• GetLabel
• GetLocalBandwidth
• GetLocalCanonicalName
• GetLocalDirection
• GetLocalReceive
• GetLocalSend
• GetMaxReceiveBitrate
• GetMaxSendBitrate
• GetMediaDescriptionId
• GetOutputMuted
• GetPreferredCodecs
• GetRemoteBandwidth
• GetRemoteCanonicalName
• GetRemoteDirection
• GetRemoteEncoding
• GetRemoteMuted
• GetRemoteReceive
• GetRemoteSend
• GetSimulcastMode
• GetTag
• GetTransportInfo
• GetVp8Disabled
• GetVp9Disabled
• Initialize
• RaiseBitrateNotification
• RaiseBitrateRequest
• RaiseKeyFrameRequest
• SetCodecDisabled
• SetExternalId
• SetH264Disabled
• SetH265Disabled
• SetInputMuted
• SetLocalBandwidth
• SetLocalDirection
• SetLocalReceive
• SetLocalSend
• SetMaxReceiveBitrate
• SetMaxSendBitrate
• SetOnDirectionChange
• SetOnDiscardBitrateNotification
• SetOnDiscardBitrateRequest
• SetOnDiscardKeyFrameRequest
• SetOnLocalEncodingDisabled
• SetOnLocalEncodingEnabled
• SetOnStateChange
• SetOutputMuted
• SetPreferredCodecs
• SetRemoteEncoding
• SetRemoteMuted
• SetSimulcastMode
• SetTag
• SetVp8Disabled
• SetVp9Disabled

Methods

ChangeDirection

▸ ChangeDirection(newDirection: number): string

Parameters:

Name	Type
newDirection	number

Returns: string

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

---

GetCodecDisabled

▸ GetCodecDisabled(name: string): boolean

Parameters:

Name	Type
name	string

Returns: boolean

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

---

GetControlTransportInfo

▸ GetControlTransportInfo(): string

Returns: string

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

---

GetDirection

▸ GetDirection(): number

Returns: number

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

---

GetExternalId

▸ GetExternalId(): string

Returns: string

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

---

GetH264Disabled

▸ GetH264Disabled(): boolean

Returns: boolean

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

---

GetH265Disabled

▸ GetH265Disabled(): boolean

Returns: boolean

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

---

GetHandle

▸ GetHandle(): number

Returns: number

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

---

GetId

▸ GetId(): string

Returns: string

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

---

GetInfo

▸ GetInfo(): string

Returns: string

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

---

GetInputMuted

▸ GetInputMuted(): boolean

Returns: boolean

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

---

GetLabel

▸ GetLabel(): string

Returns: string

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

---

GetLocalBandwidth

▸ GetLocalBandwidth(): number

Returns: number

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

---

GetLocalCanonicalName

▸ GetLocalCanonicalName(): string

Returns: string

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

---

GetLocalDirection

▸ GetLocalDirection(): number

Returns: number

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

---

GetLocalReceive

▸ GetLocalReceive(): boolean

Returns: boolean

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

---

GetLocalSend

▸ GetLocalSend(): boolean

Returns: boolean

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

---

GetMaxReceiveBitrate

▸ GetMaxReceiveBitrate(): number

Returns: number

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

---

GetMaxSendBitrate

▸ GetMaxSendBitrate(): number

Returns: number

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

---

GetMediaDescriptionId

▸ GetMediaDescriptionId(): string

Returns: string

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

---

GetOutputMuted

▸ GetOutputMuted(): boolean

Returns: boolean

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

---

GetPreferredCodecs

▸ GetPreferredCodecs(): string[]

Returns: string[]

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

---

GetRemoteBandwidth

▸ GetRemoteBandwidth(): number

Returns: number

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

---

GetRemoteCanonicalName

▸ GetRemoteCanonicalName(): string

Returns: string

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

---

GetRemoteDirection

▸ GetRemoteDirection(): number

Returns: number

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

---

GetRemoteEncoding

▸ GetRemoteEncoding(): string

Returns: string

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

---

GetRemoteMuted

▸ GetRemoteMuted(): boolean

Returns: boolean

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

---

GetRemoteReceive

▸ GetRemoteReceive(): boolean

Returns: boolean

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

---

GetRemoteSend

▸ GetRemoteSend(): boolean

Returns: boolean

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

---

GetSimulcastMode

▸ GetSimulcastMode(): number

Returns: number

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

---

GetTag

▸ GetTag(): string

Returns: string

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

---

GetTransportInfo

▸ GetTransportInfo(): string

Returns: string

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

---

GetVp8Disabled

▸ GetVp8Disabled(): boolean

Returns: boolean

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

---

GetVp9Disabled

▸ GetVp9Disabled(): boolean

Returns: boolean

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

---

Initialize

▸ Initialize(localMediaHandle: number, remoteMediaHandle: number): void

Parameters:

Name	Type
localMediaHandle	number
remoteMediaHandle	number

Returns: void

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

---

RaiseBitrateNotification

▸ RaiseBitrateNotification(bitrateNotificationJson: string): boolean

Parameters:

Name	Type
bitrateNotificationJson	string

Returns: boolean

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

---

RaiseBitrateRequest

▸ RaiseBitrateRequest(bitrateRequestJson: string): boolean

Parameters:

Name	Type
bitrateRequestJson	string

Returns: boolean

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

---

RaiseKeyFrameRequest

▸ RaiseKeyFrameRequest(synchronizationSources: number[]): void

Parameters:

Name	Type
synchronizationSources	number[]

Returns: void

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

---

SetCodecDisabled

▸ SetCodecDisabled(name: string, disabled: boolean): void

Parameters:

Name	Type
name	string
disabled	boolean

Returns: void

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

---

SetExternalId

▸ SetExternalId(externalId: string): void

Parameters:

Name	Type
externalId	string

Returns: void

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

---

SetH264Disabled

▸ SetH264Disabled(disabled: boolean): void

Parameters:

Name	Type
disabled	boolean

Returns: void

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

---

SetH265Disabled

▸ SetH265Disabled(disabled: boolean): void

Parameters:

Name	Type
disabled	boolean

Returns: void

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

---

SetInputMuted

▸ SetInputMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

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

---

SetLocalBandwidth

▸ SetLocalBandwidth(bandwidth: number): void

Parameters:

Name	Type
bandwidth	number

Returns: void

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

---

SetLocalDirection

▸ SetLocalDirection(direction: number): void

Parameters:

Name	Type
direction	number

Returns: void

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

---

SetLocalReceive

▸ SetLocalReceive(localReceiveEnabled: boolean): void

Parameters:

Name	Type
localReceiveEnabled	boolean

Returns: void

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

---

SetLocalSend

▸ SetLocalSend(localSendEnabled: boolean): void

Parameters:

Name	Type
localSendEnabled	boolean

Returns: void

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

---

SetMaxReceiveBitrate

▸ SetMaxReceiveBitrate(bandwidth: number): void

Parameters:

Name	Type
bandwidth	number

Returns: void

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

---

SetMaxSendBitrate

▸ SetMaxSendBitrate(bandwidth: number): void

Parameters:

Name	Type
bandwidth	number

Returns: void

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

---

SetOnDirectionChange

▸ SetOnDirectionChange(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnDiscardBitrateNotification

▸ SetOnDiscardBitrateNotification(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnDiscardBitrateRequest

▸ SetOnDiscardBitrateRequest(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnDiscardKeyFrameRequest

▸ SetOnDiscardKeyFrameRequest(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnLocalEncodingDisabled

▸ SetOnLocalEncodingDisabled(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnLocalEncodingEnabled

▸ SetOnLocalEncodingEnabled(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

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

---

SetOnStateChange

▸ SetOnStateChange(callback: Object): void

Parameters:

Name	Type
callback	Object

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:64

---

SetOutputMuted

▸ SetOutputMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:65

---

SetPreferredCodecs

▸ SetPreferredCodecs(names: string[]): void

Parameters:

Name	Type
names	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:66

---

SetRemoteEncoding

▸ SetRemoteEncoding(remoteEncodingJson: string): void

Parameters:

Name	Type
remoteEncodingJson	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:67

---

SetRemoteMuted

▸ SetRemoteMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:68

---

SetSimulcastMode

▸ SetSimulcastMode(simulcastMode: number): void

Parameters:

Name	Type
simulcastMode	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:69

---

SetTag

▸ SetTag(tag: string): void

Parameters:

Name	Type
tag	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:70

---

SetVp8Disabled

▸ SetVp8Disabled(disabled: boolean): void

Parameters:

Name	Type
disabled	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:71

---

SetVp9Disabled

▸ SetVp9Disabled(disabled: boolean): void

Parameters:

Name	Type
disabled	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IPluginVideoStream.ts:72