Search Results for

    / fm / liveswitch / WebRtcMediaStreamBase

    Class: WebRtcMediaStreamBase

    fm.liveswitch.WebRtcMediaStreamBase

    Media stream base properties/methods.

    Hierarchy

    • WebRtcStream

      ↳ WebRtcMediaStreamBase

      ↳↳ WebRtcMediaStream

    Table of contents

    Constructors

    • constructor

    Methods

    • addOnDirectionChange
    • addOnLocalEncodingDisabled
    • addOnLocalEncodingEnabled
    • addOnStateChange
    • changeDirection
    • fmliveswitchWebRtcMediaStreamBaseInit
    • getCachedLocalDirection
    • getCanonicalName
    • getCodecDisabled
    • getConnectedTimestamp
    • getConnection
    • getConnectionId
    • getControlTransportInfo
    • getDirection
    • getDynamicProperties
    • getDynamicValue
    • getExternalId
    • getId
    • getInfo
    • getInputContent
    • getInputMuted
    • getIsTerminated
    • getIsTerminating
    • getIsTerminatingOrTerminated
    • getLabel
    • getLocalBandwidth
    • getLocalCanonicalName
    • getLocalDirection
    • getLocalMuted
    • getLocalReceive
    • getLocalSend
    • getMaxReceiveBitrate
    • getMaxSendBitrate
    • getMediaDescriptionId
    • getMuted
    • getOutputContent
    • getOutputMuted
    • getPreferredCodecs
    • getRemoteBandwidth
    • getRemoteCanonicalName
    • getRemoteDirection
    • getRemoteEncoding
    • getRemoteMuted
    • getRemoteReceive
    • getRemoteRequestedDeactivation
    • getRemoteSend
    • getRenegotiationPending
    • getSimulcastMode
    • getState
    • getTag
    • getTransportInfo
    • getType
    • getTypeString
    • populateInfo
    • processStateChange
    • processStateLockChange
    • raiseBitrateRequest
    • raiseLocalEncodingDisabled
    • raiseLocalEncodingEnabled
    • removeOnDirectionChange
    • removeOnLocalEncodingDisabled
    • removeOnLocalEncodingEnabled
    • removeOnStateChange
    • setCodecDisabled
    • setConnection
    • setDynamicValue
    • setExternalId
    • setInputContent
    • setInputMuted
    • setLocalBandwidth
    • setLocalDirection
    • setLocalMuted
    • setLocalReceive
    • setLocalSend
    • setMaxReceiveBitrate
    • setMaxSendBitrate
    • setMuted
    • setOutputContent
    • setOutputMuted
    • setPreferredCodecs
    • setRemoteBandwidth
    • setRemoteEncoding
    • setRemoteMuted
    • setRenegotiationPending
    • setSimulcastMode
    • setTag
    • setTransportInfo
    • toString
    • unsetDynamicValue

    Constructors

    constructor

    + new WebRtcMediaStreamBase(type: StreamType): WebRtcMediaStreamBase

    Initializes a new instance of the [[fm.liveswitch.mediaStreamBase]] class.

    Parameters:

    Name Type Description
    type StreamType The type.

    Returns: WebRtcMediaStreamBase

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:73

    Methods

    addOnDirectionChange

    ▸ addOnDirectionChange(value: IAction0): void

    Adds a handler that is raised when the stream direction changes.
    Stream direction indicates the direction of media flow. For example:

    • A stream in an SFU upstream connection has a direction of SendOnly.
    • A stream in an SFU downstream connection has a direction of ReceiveOnly.
    • A stream in an MCU connection has a direction of SendReceive if it is attached to both local and remote media. If it is only attached to local media, it has a direction of SendOnly. If it is only attached to remote media, it has a direction of ReceiveOnly.
    The direction of a stream can change over its lifecycle. For example:
    • An update to an SFU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the direction of the stream changes to Inactive.
    • An update to an SFU downstream connection might cause it to stop receiving audio or video frames. In this case, the direction of the stream changes to Inactive.
    • An update to an MCU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the following occurs:

      • If the direction of the stream was SendOnly, then the direction changes to Inactive.
      • If the direction of the stream was ReceiveOnly, then the direction changes to SendReceive.
    • An update to an MCU upstream connection might instruct it to stop receiving audio or video frames. In this case, the following occurs:
      • If the direction of the stream was ReceiveOnly, then the direction changes to Inactive.
      • If the direction of the stream was SendReceive, then the direction changes to SendOnly.
    An event handler bound to the change in direction can be used to update the UI accordingly so the user is aware of the change in the state of the application.

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: WebRtcStream

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


    addOnLocalEncodingDisabled

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

    Adds a handler that is raised when a local encoding is disabled.

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:110


    addOnLocalEncodingEnabled

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

    Adds a handler that is raised when a local encoding is enabled.

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

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


    addOnStateChange

    ▸ addOnStateChange(value: IAction0): void

    Adds a handler that is raised when the connection state changes.
    This method can track the state of the connection and can be used to display the current status of the connection to the user, add or remove media views in the UI, and handle retry logic if the connection fails.

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: WebRtcStream

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


    changeDirection

    ▸ changeDirection(newDirection: StreamDirection): Error

    Records the pending direction of this stream. The LocalDirection of this stream will be updated when the connection renegotiation commences.

    Parameters:

    Name Type
    newDirection StreamDirection

    Returns: Error

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:134


    fmliveswitchWebRtcMediaStreamBaseInit

    ▸ PrivatefmliveswitchWebRtcMediaStreamBaseInit(): void

    Returns: void

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


    getCachedLocalDirection

    ▸ getCachedLocalDirection(): StreamDirection

    Gets Cached Local Direction for this Media Stream. Internal use.

    Returns: StreamDirection

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


    getCanonicalName

    ▸ getCanonicalName(): string

    Gets the canonical name.

    deprecated Use LocalCanonicalName instead.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:197


    getCodecDisabled

    ▸ getCodecDisabled(name: string): boolean

    Gets whether a codec is disabled.

    Parameters:

    Name Type Description
    name string The codec name.

    Returns: boolean

    Whether the codec is disabled.

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


    getConnectedTimestamp

    ▸ ProtectedgetConnectedTimestamp(): number

    Gets the ManagedStopwatch.GetTimestamp() value representing the ticks that passed when this stream's connection state changed to connected.

    Returns: number

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:114


    getConnection

    ▸ getConnection(): WebRtcConnection

    Returns: WebRtcConnection

    Inherited from: WebRtcStream

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


    getConnectionId

    ▸ getConnectionId(): string

    Gets the connection identifier.

    Returns: string

    Inherited from: WebRtcStream

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


    getControlTransportInfo

    ▸ AbstractgetControlTransportInfo(): TransportInfo

    Gets control transport info.

    Returns: TransportInfo

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:224


    getDirection

    ▸ getDirection(): StreamDirection

    Returns: StreamDirection

    The Media Direction as a StreamDirection enumerator.

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:232


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: WebRtcStream

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

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


    getExternalId

    ▸ getExternalId(): string

    Gets the external identifier.

    Returns: string

    Inherited from: WebRtcStream

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


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:158


    getInfo

    ▸ getInfo(): MediaStreamInfo

    Gets the media stream info.

    Returns: MediaStreamInfo

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:265


    getInputContent

    ▸ getInputContent(): string

    Gets the input content descriptor.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:287


    getInputMuted

    ▸ AbstractgetInputMuted(): boolean

    Gets whether the input track is muted.

    Returns: boolean

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


    getIsTerminated

    ▸ getIsTerminated(): boolean

    Gets a value indicating whether the stream is currently closed or failed.

    Returns: boolean

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:170


    getIsTerminating

    ▸ getIsTerminating(): boolean

    Gets a value indicating whether the stream is currently closing or failing.

    Returns: boolean

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:182


    getIsTerminatingOrTerminated

    ▸ getIsTerminatingOrTerminated(): boolean

    Gets a value indicating whether the stream is currently closing, failing, closed, or failed.

    Returns: boolean

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:194


    getLabel

    ▸ getLabel(): string

    Gets a label that identifies this class.

    Returns: string

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:305


    getLocalBandwidth

    ▸ getLocalBandwidth(): number

    Gets the local bandwidth, in kbps. This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use [[fm.liveswitch.mediaStreamBase.maxReceiveBitrate]] to control inbound media bitrate once the session has been negotiated.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:335


    getLocalCanonicalName

    ▸ getLocalCanonicalName(): string

    Gets the local canonical end-point identifier (CNAME) used by RTCP.
    The CNAME is a unique identifier for endpoints across an application instance and can be used for third-party monitoring.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:348


    getLocalDirection

    ▸ getLocalDirection(): StreamDirection

    Gets current direction indicated by the local description.

    Returns: StreamDirection

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:360


    getLocalMuted

    ▸ getLocalMuted(): boolean

    Gets a value indicating whether the local stream is muted.
    A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:374


    getLocalReceive

    ▸ getLocalReceive(): boolean

    Gets a value indicating whether the local peer supports receiving media on this stream.
    Use this method to determine if a stream is used for sending media or only receiving media.

    Returns: boolean

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:219


    getLocalSend

    ▸ getLocalSend(): boolean

    Gets a value indicating whether the local peer on this stream supports sending media on this stream.
    Use this property to determine if a stream is used for sending media or only receiving media.

    Returns: boolean

    Inherited from: WebRtcStream

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


    getMaxReceiveBitrate

    ▸ getMaxReceiveBitrate(): number

    Gets the maximum bitrate that the connection receives in Kbps. Call this method after the downstream connection is opened and its state is connected.
    This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.localBandwidth]].

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:387


    getMaxSendBitrate

    ▸ getMaxSendBitrate(): number

    Gets the maximum bitrate that the upstream connection sends in Kbps. This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.remoteBandwidth]].

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:400


    getMediaDescriptionId

    ▸ getMediaDescriptionId(): string

    Gets the media description ID of this stream.
    The media description ID is only available once a connection is opened with this stream, because it is obtained from the local SDP description of this stream.

    Returns: string

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:247


    getMuted

    ▸ getMuted(): boolean

    Gets whether the stream is muted.
    A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
    Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:414


    getOutputContent

    ▸ getOutputContent(): string

    Gets the output content descriptor.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:426


    getOutputMuted

    ▸ AbstractgetOutputMuted(): boolean

    Gets whether the output track is muted.
    A muted stream does not show or play media, but the source is not disabled and its data continues to flow through the processing pipeline.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:439


    getPreferredCodecs

    ▸ getPreferredCodecs(): string[]

    Gets any preferred codecs, in order of preference.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:453


    getRemoteBandwidth

    ▸ getRemoteBandwidth(): number

    Gets the remote bandwidth in Kbps.
    This value is signalled in the remote session description received from the remote endpoint.
    Use [[fm.liveswitch.mediaStreamBase.maxSendBitrate]] to control outbound media bitrate once the session has been negotiated.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:467


    getRemoteCanonicalName

    ▸ getRemoteCanonicalName(): string

    Gets the remote canonical name.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:479


    getRemoteDirection

    ▸ getRemoteDirection(): StreamDirection

    Gets current direction indicated by the remote description.

    Returns: StreamDirection

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:491


    getRemoteEncoding

    ▸ getRemoteEncoding(): EncodingInfo

    Gets the remote encoding.

    Returns: EncodingInfo

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:503


    getRemoteMuted

    ▸ getRemoteMuted(): boolean

    Gets a value indicating if remote is muted.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:515


    getRemoteReceive

    ▸ getRemoteReceive(): boolean

    Gets a value indicating whether receiving media is supported by the remote peer on this stream. Returns false if the remote stream direction has not been received.

    Returns: boolean

    Inherited from: WebRtcStream

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


    getRemoteRequestedDeactivation

    ▸ getRemoteRequestedDeactivation(): boolean

    Gets Boolean value set when the server is currently requesting a 0 bitrate. This is to highlight the difference between when a stream is deactivated locally or by a control mechanism on the server. Internal Use

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:527


    getRemoteSend

    ▸ getRemoteSend(): boolean

    Gets a value indicating whether sending media is supported by the remote peer on this stream. Returns false if the remote stream direction has not been received.

    Returns: boolean

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:288


    getRenegotiationPending

    ▸ ProtectedgetRenegotiationPending(): boolean

    Gets whether there exist changes that are pending SDP renegotiation.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:539


    getSimulcastMode

    ▸ AbstractgetSimulcastMode(): SimulcastMode

    Gets the simulcast mode.

    Returns: SimulcastMode

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:551


    getState

    ▸ getState(): StreamState

    Gets the state of the stream.

    Returns: StreamState

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:301


    getTag

    ▸ getTag(): string

    Gets optional data to associate with this instance.

    Returns: string

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:321


    getTransportInfo

    ▸ getTransportInfo(): TransportInfo

    Returns: TransportInfo

    Inherited from: WebRtcStream

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


    getType

    ▸ getType(): StreamType

    Gets the type.

    Returns: StreamType

    Inherited from: WebRtcStream

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: WebRtcStream

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


    populateInfo

    ▸ Protected AbstractpopulateInfo(info: MediaStreamInfo): void

    Populates the media stream info.

    Parameters:

    Name Type
    info MediaStreamInfo

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:558


    processStateChange

    ▸ ProtectedprocessStateChange(): void

    Processes a state change.

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:363


    processStateLockChange

    ▸ ProtectedprocessStateLockChange(): void

    Processes a state lock change.

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:374


    raiseBitrateRequest

    ▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

    Raises a bitrate request to the local track.

    Parameters:

    Name Type Description
    bitrateRequest BitrateRequest The bitrate request.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:577


    raiseLocalEncodingDisabled

    ▸ ProtectedraiseLocalEncodingDisabled(encoding: EncodingInfo): void

    Raises the OnLocalEncodingDisabled event.

    Parameters:

    Name Type Description
    encoding EncodingInfo The encoding.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:594


    raiseLocalEncodingEnabled

    ▸ ProtectedraiseLocalEncodingEnabled(encoding: EncodingInfo): void

    Raises the OnLocalEncodingEnabled event.

    Parameters:

    Name Type Description
    encoding EncodingInfo The encoding.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:610


    removeOnDirectionChange

    ▸ removeOnDirectionChange(value: IAction0): void

    Removes a handler that is raised when the stream direction changes.
    Stream direction indicates the direction of media flow. For example:

    • A stream in an SFU upstream connection has a direction of SendOnly.
    • A stream in an SFU downstream connection has a direction of ReceiveOnly.
    • A stream in an MCU connection has a direction of SendReceive if it is attached to both local and remote media. If it is only attached to local media, it has a direction of SendOnly. If it is only attached to remote media, it has a direction of ReceiveOnly.
    The direction of a stream can change over its lifecycle. For example:
    • An update to an SFU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the direction of the stream changes to Inactive.
    • An update to an SFU downstream connection might cause it to stop receiving audio or video frames. In this case, the direction of the stream changes to Inactive.
    • An update to an MCU upstream connection might instruct the stream to stop sending audio or video frames. In this case, the following occurs:

      • If the direction of the stream was SendOnly, then the direction changes to Inactive.
      • If the direction of the stream was ReceiveOnly, then the direction changes to SendReceive.
    • An update to an MCU upstream connection might instruct it to stop receiving audio or video frames. In this case, the following occurs:
      • If the direction of the stream was ReceiveOnly, then the direction changes to Inactive.
      • If the direction of the stream was SendReceive, then the direction changes to SendOnly.
    An event handler bound to the change in direction can be used to update the UI accordingly so the user is aware of the change in the state of the application.

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:429


    removeOnLocalEncodingDisabled

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

    Removes a handler that is raised when a local encoding is disabled.

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:625


    removeOnLocalEncodingEnabled

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

    Removes a handler that is raised when a local encoding is enabled.

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:637


    removeOnStateChange

    ▸ removeOnStateChange(value: IAction0): void

    Removes a handler that is raised when the connection state changes.
    This method can track the state of the connection and can be used to display the current status of the connection to the user, add or remove media views in the UI, and handle retry logic if the connection fails.

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:442


    setCodecDisabled

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

    Sets whether a codec is disabled.

    Parameters:

    Name Type Description
    name string The codec name.
    disabled boolean Whether to disable the codec.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:659


    setConnection

    ▸ setConnection(remoteTrack: WebRtcConnection): void

    Parameters:

    Name Type
    remoteTrack WebRtcConnection

    Returns: void

    Inherited from: WebRtcStream

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


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

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


    setExternalId

    ▸ setExternalId(value: string): void

    Sets the external identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:471


    setInputContent

    ▸ ProtectedsetInputContent(value: string): void

    Sets the input content descriptor.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:676


    setInputMuted

    ▸ AbstractsetInputMuted(value: boolean): void

    Sets whether the input track is muted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:688


    setLocalBandwidth

    ▸ setLocalBandwidth(value: number): void

    Sets the local bandwidth, in kbps. This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use [[fm.liveswitch.mediaStreamBase.maxReceiveBitrate]] to control inbound media bitrate once the session has been negotiated.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:698


    setLocalDirection

    ▸ setLocalDirection(value: StreamDirection): void

    Sets current direction indicated by the local description.

    Parameters:

    Name Type
    value StreamDirection

    Returns: void

    Overrides: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:719


    setLocalMuted

    ▸ setLocalMuted(value: boolean): void

    Sets a value indicating whether the local stream is muted.
    A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline. Alias for [[fm.liveswitch.mediaStreamBase.muted]].

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:737


    setLocalReceive

    ▸ setLocalReceive(value: boolean): void

    Sets a value indicating whether the local peer supports receiving media on this stream.
    Use this method to determine if a stream is used for sending media or only receiving media.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:490


    setLocalSend

    ▸ setLocalSend(value: boolean): void

    Sets a value indicating whether the local peer on this stream supports sending media on this stream.
    Use this property to determine if a stream is used for sending media or only receiving media.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:529


    setMaxReceiveBitrate

    ▸ setMaxReceiveBitrate(value: number): void

    Sets the maximum bitrate that the connection receives in Kbps. Call this method after the downstream connection is opened and its state is connected.
    This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.localBandwidth]].

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:750


    setMaxSendBitrate

    ▸ setMaxSendBitrate(value: number): void

    Sets the maximum bitrate that the upstream connection sends in Kbps. This value must be less than or equal to [[fm.liveswitch.mediaStreamBase.remoteBandwidth]].

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:771


    setMuted

    ▸ setMuted(value: boolean): void

    Sets whether the stream is muted.
    A muted stream does not show or play media, but the stream is not disabled and its data continues to flow through the processing pipeline.
    Alias for [[fm.liveswitch.mediaStreamBase.inputMuted]].

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:793


    setOutputContent

    ▸ ProtectedsetOutputContent(value: string): void

    Sets the output content descriptor.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:805


    setOutputMuted

    ▸ AbstractsetOutputMuted(value: boolean): void

    Sets whether the output track is muted.
    A muted stream does not show or play media, but the source is not disabled and its data continues to flow through the processing pipeline.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:818


    setPreferredCodecs

    ▸ setPreferredCodecs(value: string[]): void

    Sets any preferred codecs, in order of preference.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:832


    setRemoteBandwidth

    ▸ ProtectedsetRemoteBandwidth(value: number): void

    Sets the remote bandwidth in Kbps.
    This value is signalled in the remote session description received from the remote endpoint.
    Use [[fm.liveswitch.mediaStreamBase.maxSendBitrate]] to control outbound media bitrate once the session has been negotiated.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:846


    setRemoteEncoding

    ▸ setRemoteEncoding(value: EncodingInfo): void

    Sets the remote encoding.

    Parameters:

    Name Type
    value EncodingInfo

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:879


    setRemoteMuted

    ▸ setRemoteMuted(value: boolean): void

    Sets a value indicating if remote is muted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:891


    setRenegotiationPending

    ▸ ProtectedsetRenegotiationPending(value: boolean): void

    Sets whether there exist changes that are pending SDP renegotiation.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:911


    setSimulcastMode

    ▸ AbstractsetSimulcastMode(value: SimulcastMode): void

    Sets the simulcast mode.

    Parameters:

    Name Type
    value SimulcastMode

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStreamBase.ts:923


    setTag

    ▸ setTag(value: string): void

    Sets optional data to associate with this instance.

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:617


    setTransportInfo

    ▸ setTransportInfo(transportInfo: TransportInfo): void

    Parameters:

    Name Type
    transportInfo TransportInfo

    Returns: void

    Inherited from: WebRtcStream

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


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    Inherited from: WebRtcStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcStreamBase.ts:637


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

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

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0