/ fm / liveswitch / IMediaStream

Interface: IMediaStream

fm.liveswitch.IMediaStream

Media stream interface.

Hierarchy

• IStream

  ↳ IMediaStream

  ↳↳ IExternalMediaStream

  ↳↳ IInternalMediaStream

  ↳↳ IAudioStream

  ↳↳ IVideoStream

Implemented by

• MediaStream
• PluginMediaStream
• WebRtcMediaStream

Table of contents

Methods

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

Methods

addOnDirectionChange

▸ addOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IStream

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

---

addOnDiscardBitrateNotification

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

Parameters:

Name	Type
value	IAction1<BitrateNotification>

Returns: void

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

---

addOnDiscardBitrateRequest

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

Parameters:

Name	Type
value	IAction1<BitrateRequest>

Returns: void

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

---

addOnLocalEncodingDisabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

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

---

addOnLocalEncodingEnabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

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

---

addOnStateChange

▸ addOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IStream

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

---

changeDirection

▸ changeDirection(newDirection: StreamDirection): Error

Parameters:

Name	Type
newDirection	StreamDirection

Returns: Error

Inherited from: IStream

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

---

getCachedLocalDirection

▸ getCachedLocalDirection(): StreamDirection

Returns: StreamDirection

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

---

getCodecDisabled

▸ getCodecDisabled(name: string): boolean

Parameters:

Name	Type
name	string

Returns: boolean

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

---

getControlTransportInfo

▸ getControlTransportInfo(): TransportInfo

Returns: TransportInfo

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

---

getDirection

▸ getDirection(): StreamDirection

Returns: StreamDirection

Inherited from: IStream

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

---

getExternalId

▸ getExternalId(): string

Returns: string

Inherited from: IStream

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

---

getId

▸ getId(): string

Returns: string

Inherited from: IStream

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

---

getInfo

▸ getInfo(): MediaStreamInfo

Returns: MediaStreamInfo

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

---

getInputMuted

▸ getInputMuted(): boolean

Returns: boolean

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

---

getLabel

▸ getLabel(): string

Returns: string

Inherited from: IStream

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

---

getLocalBandwidth

▸ getLocalBandwidth(): number

Returns: number

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

---

getLocalCanonicalName

▸ getLocalCanonicalName(): string

Returns: string

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

---

getLocalDirection

▸ getLocalDirection(): StreamDirection

Returns: StreamDirection

Inherited from: IStream

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

---

getLocalReceive

▸ getLocalReceive(): boolean

Returns: boolean

Inherited from: IStream

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

---

getLocalSend

▸ getLocalSend(): boolean

Returns: boolean

Inherited from: IStream

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

---

getMaxReceiveBitrate

▸ getMaxReceiveBitrate(): number

Returns: number

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

---

getMaxSendBitrate

▸ getMaxSendBitrate(): number

Returns: number

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

---

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Returns: string

Inherited from: IStream

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

---

getOutputMuted

▸ getOutputMuted(): boolean

Returns: boolean

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

---

getPreferredCodecs

▸ getPreferredCodecs(): string[]

Returns: string[]

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

---

getRemoteBandwidth

▸ getRemoteBandwidth(): number

Returns: number

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

---

getRemoteCanonicalName

▸ getRemoteCanonicalName(): string

Returns: string

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

---

getRemoteDirection

▸ getRemoteDirection(): StreamDirection

Returns: StreamDirection

Inherited from: IStream

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

---

getRemoteEncoding

▸ getRemoteEncoding(): EncodingInfo

Returns: EncodingInfo

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

---

getRemoteMuted

▸ getRemoteMuted(): boolean

Returns: boolean

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

---

getRemoteReceive

▸ getRemoteReceive(): boolean

Returns: boolean

Inherited from: IStream

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

---

getRemoteRequestedDeactivation

▸ getRemoteRequestedDeactivation(): boolean

Returns: boolean

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

---

getRemoteSend

▸ getRemoteSend(): boolean

Returns: boolean

Inherited from: IStream

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

---

getSimulcastMode

▸ getSimulcastMode(): SimulcastMode

Returns: SimulcastMode

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

---

getState

▸ getState(): StreamState

Returns: StreamState

Inherited from: IStream

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

---

getTag

▸ getTag(): string

Returns: string

Inherited from: IStream

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

---

getTransportInfo

▸ getTransportInfo(): TransportInfo

Returns: TransportInfo

Inherited from: IStream

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

---

getType

▸ getType(): StreamType

Returns: StreamType

Inherited from: IStream

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

---

raiseBitrateNotification

▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

Parameters:

Name	Type
bitrateNotification	BitrateNotification

Returns: boolean

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

---

raiseBitrateRequest

▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

Parameters:

Name	Type
bitrateRequest	BitrateRequest

Returns: boolean

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

---

removeOnDirectionChange

▸ removeOnDirectionChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IStream

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

---

removeOnDiscardBitrateNotification

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

Parameters:

Name	Type
value	IAction1<BitrateNotification>

Returns: void

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

---

removeOnDiscardBitrateRequest

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

Parameters:

Name	Type
value	IAction1<BitrateRequest>

Returns: void

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

---

removeOnLocalEncodingDisabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

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

---

removeOnLocalEncodingEnabled

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

Parameters:

Name	Type
value	IAction1<EncodingInfo>

Returns: void

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

---

removeOnStateChange

▸ removeOnStateChange(value: IAction0): void

Parameters:

Name	Type
value	IAction0

Returns: void

Inherited from: IStream

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

---

setCodecDisabled

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

Parameters:

Name	Type
name	string
disabled	boolean

Returns: void

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

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Inherited from: IStream

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

---

setInputMuted

▸ setInputMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setLocalBandwidth

▸ setLocalBandwidth(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

setLocalDirection

▸ setLocalDirection(value: StreamDirection): void

Parameters:

Name	Type
value	StreamDirection

Returns: void

Inherited from: IStream

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

---

setLocalReceive

▸ setLocalReceive(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IStream

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

---

setLocalSend

▸ setLocalSend(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IStream

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

---

setMaxReceiveBitrate

▸ setMaxReceiveBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

setMaxSendBitrate

▸ setMaxSendBitrate(value: number): void

Parameters:

Name	Type
value	number

Returns: void

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

---

setOutputMuted

▸ setOutputMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setPreferredCodecs

▸ setPreferredCodecs(value: string[]): void

Parameters:

Name	Type
value	string[]

Returns: void

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

---

setRemoteEncoding

▸ setRemoteEncoding(value: EncodingInfo): void

Parameters:

Name	Type
value	EncodingInfo

Returns: void

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

---

setRemoteMuted

▸ setRemoteMuted(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

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

---

setSimulcastMode

▸ setSimulcastMode(value: SimulcastMode): void

Parameters:

Name	Type
value	SimulcastMode

Returns: void

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

---

setTag

▸ setTag(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Inherited from: IStream

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