/ fm / liveswitch / VideoStream

Class: VideoStream

fm.liveswitch.VideoStream

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new VideoStream(localTrack: VideoTrack): VideoStream

Parameters:

Name Type
localTrack VideoTrack

Returns: VideoStream

Inherited from: MediaStream

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

+ new VideoStream(localTrack: VideoTrack, remoteTrack: VideoTrack): VideoStream

Parameters:

Name Type
localTrack VideoTrack
remoteTrack VideoTrack

Returns: VideoStream

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

+ new VideoStream(localMedia: LocalMedia): VideoStream

Parameters:

Name Type
localMedia LocalMedia

Returns: VideoStream

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

+ new VideoStream(localMedia: LocalMedia, remoteMedia: RemoteMedia): VideoStream

Parameters:

Name Type
localMedia LocalMedia
remoteMedia RemoteMedia

Returns: VideoStream

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

+ new VideoStream(remoteMedia: RemoteMedia): VideoStream

Parameters:

Name Type
remoteMedia RemoteMedia

Returns: VideoStream

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

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:99

addOnDiscardBitrateNotification

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

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:136

addOnDiscardBitrateRequest

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

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:126

addOnDiscardKeyFrameRequest

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

Parameters:

Name Type
value IAction1<number[]>

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:106

addOnLocalEncodingDisabled

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

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

addOnLocalEncodingEnabled

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

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name Type
newDirection StreamDirection

Returns: Error

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getCodecDisabled

▸ getCodecDisabled(name: string): boolean

Parameters:

Name Type
name string

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:100

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: MediaStream

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

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: MediaStream

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

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getH264Disabled

▸ getH264Disabled(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:87

getH265Disabled

▸ getH265Disabled(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:90

getId

▸ getId(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getInfo

▸ getInfo(): MediaStreamInfo

Returns: MediaStreamInfo

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:89

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalBandwidth

▸ getLocalBandwidth(): number

Returns: number

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalMedia

▸ getLocalMedia(): LocalMedia

Returns: LocalMedia

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

getLocalMuted

▸ getLocalMuted(): boolean

Returns: boolean

Inherited from: MediaStream

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

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getLocalTrack

▸ getLocalTrack(): VideoTrack

Returns: VideoTrack

Inherited from: MediaStream

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

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Returns: number

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:152

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Returns: number

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:75

getMuted

▸ getMuted(): boolean

Returns: boolean

Inherited from: MediaStream

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

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Returns: string[]

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Returns: number

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Returns: EncodingInfo

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:75

getRemoteMedia

▸ getRemoteMedia(): RemoteMedia

Returns: RemoteMedia

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

getRemoteMuted

▸ getRemoteMuted(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getRemoteTrack

▸ getRemoteTrack(): VideoTrack

Returns: VideoTrack

Inherited from: MediaStream

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

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:82

getState

▸ getState(): StreamState

Returns: StreamState

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

getTag

▸ getTag(): string

Returns: string

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:79

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:107

getType

▸ getType(): StreamType

Returns: StreamType

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:83

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:4

getVp8Disabled

▸ getVp8Disabled(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:81

getVp9Disabled

▸ getVp9Disabled(): boolean

Returns: boolean

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:84

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name Type
bitrateNotification BitrateNotification

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name Type
bitrateRequest BitrateRequest

Returns: boolean

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:132

raiseKeyFrameRequest

▸ raiseKeyFrameRequest(synchronizationSources: number[]): void

Parameters:

Name Type
synchronizationSources number[]

Returns: void

Implementation of: IExternalVideoStream

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

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:103

removeOnDiscardBitrateNotification

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

Parameters:

Name Type
value IAction1<BitrateNotification>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

removeOnDiscardBitrateRequest

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

Parameters:

Name Type
value IAction1<BitrateRequest>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:129

removeOnDiscardKeyFrameRequest

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

Parameters:

Name Type
value IAction1<number[]>

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:109

removeOnLocalEncodingDisabled

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

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:119

removeOnLocalEncodingEnabled

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

Parameters:

Name Type
value IAction1<EncodingInfo>

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name Type
value IAction0

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setCodecDisabled

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

Parameters:

Name Type
name string
disabled boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

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: MediaStream

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

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:87

setH264Disabled

▸ setH264Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:99

setH265Disabled

▸ setH265Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:102

setInputMuted

▸ setInputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setLocalBandwidth

▸ setLocalBandwidth(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name Type
value StreamDirection

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/Stream.ts:91

setLocalMuted

▸ setLocalMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaStream

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

setLocalReceive

▸ setLocalReceive(receiveEnabled: boolean): void

Parameters:

Name Type
receiveEnabled boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setLocalSend

▸ setLocalSend(sendEnabled: boolean): void

Parameters:

Name Type
sendEnabled boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:155

setMaxSendBitrate

▸ setMaxSendBitrate(value: number): void

Parameters:

Name Type
value number

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:149

setMuted

▸ setMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Inherited from: MediaStream

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

setOutputMuted

▸ setOutputMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setPreferredCodecs

▸ setPreferredCodecs(names: string[]): void

Parameters:

Name Type
names string[]

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Parameters:

Name Type
value EncodingInfo

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:78

setRemoteMuted

▸ setRemoteMuted(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name Type
value SimulcastMode

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/MediaStream.ts:85

setTag

▸ setTag(value: string): void

Parameters:

Name Type
value string

Returns: void

Implementation of: IExternalVideoStream

Inherited from: MediaStream

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

setVp8Disabled

▸ setVp8Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:93

setVp9Disabled

▸ setVp9Disabled(value: boolean): void

Parameters:

Name Type
value boolean

Returns: void

Implementation of: IExternalVideoStream

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoStream.ts:96

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Unsets 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.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: MediaStream

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