/ fm / liveswitch / PluginMediaStream

Class: PluginMediaStream<TTrack>

fm.liveswitch.PluginMediaStream

Type parameters

Name	Type
TTrack	PluginMediaTrack

Hierarchy

• PluginStream

  ↳ PluginMediaStream

  ↳↳ PluginAudioStream

  ↳↳ PluginVideoStream

Implements

• IMediaStream
• IInternalMediaStream

Table of contents

Constructors

• constructor

Methods

• addOnDirectionChange
• addOnDiscardBitrateNotification
• addOnDiscardBitrateRequest
• addOnLocalEncodingDisabled
• addOnLocalEncodingEnabled
• addOnStateChange
• changeDirection
• getCodecDisabled
• getControlTransportInfo
• getDirection
• getDynamicProperties
• getDynamicValue
• getExternalId
• getHandle
• getId
• getInfo
• getInputMuted
• getLabel
• getLocalBandwidth
• getLocalCanonicalName
• getLocalDirection
• getLocalMuted
• getLocalReceive
• getLocalSend
• getLocalTrack
• getMaxReceiveBitrate
• getMaxSendBitrate
• getMediaDescriptionId
• getOutputMuted
• getPreferredCodecs
• getRemoteBandwidth
• getRemoteCanonicalName
• getRemoteDirection
• getRemoteEncoding
• getRemoteMuted
• getRemoteReceive
• getRemoteSend
• getRemoteTrack
• getSimulcastMode
• getState
• getTag
• getTransportInfo
• getType
• getTypeString
• raiseBitrateNotification
• raiseBitrateRequest
• removeOnDirectionChange
• removeOnDiscardBitrateNotification
• removeOnDiscardBitrateRequest
• removeOnLocalEncodingDisabled
• removeOnLocalEncodingEnabled
• removeOnStateChange
• setCodecDisabled
• setDynamicValue
• setExternalId
• setInputMuted
• setLocalBandwidth
• setLocalDirection
• setLocalMuted
• setLocalReceive
• setLocalSend
• setMaxReceiveBitrate
• setMaxSendBitrate
• setOutputMuted
• setPreferredCodecs
• setRemoteEncoding
• setRemoteMuted
• setSimulcastMode
• setTag
• unsetDynamicValue

Constructors

constructor

+ new PluginMediaStream<TTrack>(localTrack: TTrack, remoteTrack: TTrack): PluginMediaStream<TTrack>

Type parameters:

Name	Type
TTrack	PluginMediaTrack<TTrack>

Parameters:

Name	Type
localTrack	TTrack
remoteTrack	TTrack

Returns: PluginMediaStream<TTrack>

Inherited from: PluginStream

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

Methods

addOnDirectionChange

▸ AbstractaddOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

addOnDiscardBitrateNotification

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

Parameters:

Name	Type
value	IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

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

---

addOnDiscardBitrateRequest

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

Parameters:

Name	Type
value	IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

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

---

addOnLocalEncodingDisabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

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

---

addOnLocalEncodingEnabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

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

---

addOnStateChange

▸ AbstractaddOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

changeDirection

▸ AbstractchangeDirection(newDirection: StreamDirection): Error

Parameters:

Name	Type
newDirection	StreamDirection

Returns: Error

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getCodecDisabled

▸ AbstractgetCodecDisabled(name: string): boolean

Parameters:

Name	Type
name	string

Returns: boolean

Implementation of: IInternalMediaStream

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

---

getControlTransportInfo

▸ AbstractgetControlTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

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

---

getDirection

▸ AbstractgetDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: PluginStream

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

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

---

getExternalId

▸ AbstractgetExternalId(): string

Returns: string

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getHandle

▸ AbstractgetHandle(): number

Returns: number

Inherited from: PluginStream

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

---

getId

▸ AbstractgetId(): string

Returns: string

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getInfo

▸ AbstractgetInfo(): MediaStreamInfo

Returns: MediaStreamInfo

Implementation of: IInternalMediaStream

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

---

getInputMuted

▸ AbstractgetInputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

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

---

getLabel

▸ AbstractgetLabel(): string

Returns: string

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getLocalBandwidth

▸ AbstractgetLocalBandwidth(): number

Returns: number

Implementation of: IInternalMediaStream

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

---

getLocalCanonicalName

▸ AbstractgetLocalCanonicalName(): string

Returns: string

Implementation of: IInternalMediaStream

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

---

getLocalDirection

▸ AbstractgetLocalDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getLocalMuted

▸ AbstractgetLocalMuted(): boolean

Returns: boolean

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

---

getLocalReceive

▸ AbstractgetLocalReceive(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getLocalSend

▸ AbstractgetLocalSend(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getLocalTrack

▸ getLocalTrack(): TTrack

Returns: TTrack

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

---

getMaxReceiveBitrate

▸ AbstractgetMaxReceiveBitrate(): number

Returns: number

Implementation of: IInternalMediaStream

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

---

getMaxSendBitrate

▸ AbstractgetMaxSendBitrate(): number

Returns: number

Implementation of: IInternalMediaStream

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

---

getMediaDescriptionId

▸ AbstractgetMediaDescriptionId(): string

Returns: string

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getOutputMuted

▸ AbstractgetOutputMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

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

---

getPreferredCodecs

▸ AbstractgetPreferredCodecs(): string[]

Returns: string[]

Implementation of: IInternalMediaStream

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

---

getRemoteBandwidth

▸ AbstractgetRemoteBandwidth(): number

Returns: number

Implementation of: IInternalMediaStream

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

---

getRemoteCanonicalName

▸ AbstractgetRemoteCanonicalName(): string

Returns: string

Implementation of: IInternalMediaStream

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

---

getRemoteDirection

▸ AbstractgetRemoteDirection(): StreamDirection

Returns: StreamDirection

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getRemoteEncoding

▸ AbstractgetRemoteEncoding(): EncodingInfo

Returns: EncodingInfo

Implementation of: IInternalMediaStream

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

---

getRemoteMuted

▸ AbstractgetRemoteMuted(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

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

---

getRemoteReceive

▸ AbstractgetRemoteReceive(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getRemoteSend

▸ AbstractgetRemoteSend(): boolean

Returns: boolean

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getRemoteTrack

▸ getRemoteTrack(): TTrack

Returns: TTrack

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

---

getSimulcastMode

▸ AbstractgetSimulcastMode(): SimulcastMode

Returns: SimulcastMode

Implementation of: IInternalMediaStream

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

---

getState

▸ AbstractgetState(): StreamState

Returns: StreamState

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getTag

▸ AbstractgetTag(): string

Returns: string

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getTransportInfo

▸ AbstractgetTransportInfo(): TransportInfo

Returns: TransportInfo

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getType

▸ AbstractgetType(): StreamType

Returns: StreamType

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: PluginStream

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

---

raiseBitrateNotification

▸ AbstractraiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name	Type
bitrateNotification	BitrateNotification

Returns: boolean

Implementation of: IInternalMediaStream

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

---

raiseBitrateRequest

▸ AbstractraiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name	Type
bitrateRequest	BitrateRequest

Returns: boolean

Implementation of: IInternalMediaStream

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

---

removeOnDirectionChange

▸ AbstractremoveOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

removeOnDiscardBitrateNotification

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

Parameters:

Name	Type
value	IAction1<BitrateNotification>

Returns: void

Implementation of: IInternalMediaStream

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

---

removeOnDiscardBitrateRequest

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

Parameters:

Name	Type
value	IAction1<BitrateRequest>

Returns: void

Implementation of: IInternalMediaStream

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

---

removeOnLocalEncodingDisabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

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

---

removeOnLocalEncodingEnabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

Implementation of: IInternalMediaStream

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

---

removeOnStateChange

▸ AbstractremoveOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

setCodecDisabled

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

Parameters:

Name	Type
name	string
disabled	boolean

Returns: void

Implementation of: IInternalMediaStream

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

---

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

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

---

setExternalId

▸ AbstractsetExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

setInputMuted

▸ AbstractsetInputMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

Implementation of: IInternalMediaStream

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

---

setLocalBandwidth

▸ AbstractsetLocalBandwidth(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMediaStream

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

---

setLocalDirection

▸ AbstractsetLocalDirection(value: StreamDirection): void

Parameters:

Name	Type
value	StreamDirection

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

setLocalMuted

▸ AbstractsetLocalMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setLocalReceive

▸ AbstractsetLocalReceive(localReceiveEnabled: boolean): void

Parameters:

Name	Type
localReceiveEnabled	boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

setLocalSend

▸ AbstractsetLocalSend(localSendEnabled: boolean): void

Parameters:

Name	Type
localSendEnabled	boolean

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

setMaxReceiveBitrate

▸ AbstractsetMaxReceiveBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMediaStream

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

---

setMaxSendBitrate

▸ AbstractsetMaxSendBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalMediaStream

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

---

setOutputMuted

▸ AbstractsetOutputMuted(muted: boolean): void

Parameters:

Name	Type
muted	boolean

Returns: void

Implementation of: IInternalMediaStream

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

---

setPreferredCodecs

▸ AbstractsetPreferredCodecs(names: string[]): void

Parameters:

Name	Type
names	string[]

Returns: void

Implementation of: IInternalMediaStream

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

---

setRemoteEncoding

▸ AbstractsetRemoteEncoding(value: EncodingInfo): void

Parameters:

Name	Type
value	EncodingInfo

Returns: void

Implementation of: IInternalMediaStream

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

---

setRemoteMuted

▸ AbstractsetRemoteMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalMediaStream

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

---

setSimulcastMode

▸ AbstractsetSimulcastMode(value: SimulcastMode): void

Parameters:

Name	Type
value	SimulcastMode

Returns: void

Implementation of: IInternalMediaStream

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

---

setTag

▸ AbstractsetTag(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalMediaStream

Inherited from: PluginStream

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

---

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

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