/ fm / liveswitch / PluginVideoStream

Class: PluginVideoStream

fm.liveswitch.PluginVideoStream

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new PluginVideoStream(external: IExternalVideoStream, localTrack: PluginVideoTrack, remoteTrack: PluginVideoTrack): PluginVideoStream

Parameters:

Name Type
external IExternalVideoStream
localTrack PluginVideoTrack
remoteTrack PluginVideoTrack

Returns: PluginVideoStream

Inherited from: PluginMediaStream

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

Properties

_state

• Private _state: StreamState

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

Methods

addOnDirectionChange

▸ addOnDirectionChange(callback: Object): void

Parameters:

Name Type
callback Object

Returns: void

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:223

addOnDiscardBitrateNotification

▸ addOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:323

addOnDiscardBitrateRequest

▸ addOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:313

addOnDiscardKeyFrameRequest

▸ addOnDiscardKeyFrameRequest(value: IAction1<number[]>): void

Parameters:

Name Type
value IAction1<number[]>

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:303

addOnLocalEncodingDisabled

▸ addOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:289

addOnLocalEncodingEnabled

▸ addOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:292

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:101

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:139

getCachedLocalDirection

▸ getCachedLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:172

getCodecDisabled

▸ getCodecDisabled(name: string): boolean

Parameters:

Name Type
name string

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:236

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:285

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:142

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: PluginMediaStream

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

getDynamicValue

▸ getDynamicValue(key: string): Object

Gets a property value from the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: Object

The stored value, if found; otherwise null.

Inherited from: PluginMediaStream

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

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:157

getH264Disabled

▸ getH264Disabled(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:249

getH265Disabled

▸ getH265Disabled(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:252

getHandle

▸ getHandle(): number

Returns: number

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:135

getId

▸ getId(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:154

getInfo

▸ getInfo(): MediaStreamInfo

Returns: MediaStreamInfo

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:108

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:190

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:163

getLocalBandwidth

▸ getLocalBandwidth(): number

Returns: number

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:166

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:146

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:169

getLocalMuted

▸ getLocalMuted(): boolean

Returns: boolean

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:178

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:112

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:115

getLocalTrack

▸ getLocalTrack(): PluginVideoTrack

Returns: PluginVideoTrack

Inherited from: PluginMediaStream

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

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Returns: number

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:339

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Returns: number

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:333

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:193

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:196

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Returns: string[]

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:230

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Returns: number

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:199

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:150

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:131

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Returns: EncodingInfo

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:268

getRemoteMuted

▸ getRemoteMuted(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:184

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:118

getRemoteRequestedDeactivation

▸ getRemoteRequestedDeactivation(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:175

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:121

getRemoteTrack

▸ getRemoteTrack(): PluginVideoTrack

Returns: PluginVideoTrack

Inherited from: PluginMediaStream

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

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:275

getState

▸ getState(): StreamState

Returns: StreamState

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:98

getTag

▸ getTag(): string

Returns: string

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:202

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:282

getType

▸ getType(): StreamType

Returns: StreamType

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:205

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginMediaStream

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

getVp8Disabled

▸ getVp8Disabled(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:243

getVp9Disabled

▸ getVp9Disabled(): boolean

Returns: boolean

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:246

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:329

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: boolean

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:319

raiseKeyFrameRequest

▸ raiseKeyFrameRequest(synchronizationSources: number[]): void

Parameters:

Name Type
synchronizationSources number[]

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:309

removeOnDirectionChange

▸ removeOnDirectionChange(callback: Object): void

Parameters:

Name Type
callback Object

Returns: void

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:226

removeOnDiscardBitrateNotification

▸ removeOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:326

removeOnDiscardBitrateRequest

▸ removeOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:316

removeOnDiscardKeyFrameRequest

▸ removeOnDiscardKeyFrameRequest(value: IAction1<number[]>): void

Parameters:

Name Type
value IAction1<number[]>

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:306

removeOnLocalEncodingDisabled

▸ removeOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:296

removeOnLocalEncodingEnabled

▸ removeOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:299

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:104

setCodecDisabled

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

Parameters:

Name Type
name string
disabled boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:239

setDynamicValue

▸ setDynamicValue(key: string, value: Object): void

Sets a property value in the local cache.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
value Object The property value. This can be any object that needs to be stored for future use.

Returns: void

Inherited from: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:160

setH264Disabled

▸ setH264Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:261

setH265Disabled

▸ setH265Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:264

setInputMuted

▸ setInputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:214

setLocalBandwidth

▸ setLocalBandwidth(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:211

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:208

setLocalMuted

▸ setLocalMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:181

setLocalReceive

▸ setLocalReceive(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:124

setLocalSend

▸ setLocalSend(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:127

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:342

setMaxSendBitrate

▸ setMaxSendBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:336

setOutputMuted

▸ setOutputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:217

setPreferredCodecs

▸ setPreferredCodecs(names: string[]): void

Parameters:

Name Type
names string[]

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:233

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Parameters:

Name Type
value EncodingInfo

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:271

setRemoteMuted

▸ setRemoteMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:187

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name Type
value SimulcastMode

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:278

setTag

▸ setTag(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IInternalVideoStream

Overrides: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:220

setVp8Disabled

▸ setVp8Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:255

setVp9Disabled

▸ setVp9Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IInternalVideoStream

Defined in: Generated/TypeScript/fm.liveswitch/PluginVideoStream.ts:258

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

Parameters:

Name Type Description
key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: PluginMediaStream

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122