Search Results for

    / fm / liveswitch / WebRtcAudioStream

    Class: WebRtcAudioStream

    fm.liveswitch.WebRtcAudioStream

    Hierarchy

    • WebRtcMediaStream<WebRtcAudioTrack>

      ↳ WebRtcAudioStream

    Implements

    • IAudioStream
    • IInternalAudioStream

    Table of contents

    Constructors

    • constructor

    Methods

    • addOnDirectionChange
    • addOnDiscardBitrateNotification
    • addOnDiscardBitrateRequest
    • addOnLocalEncodingDisabled
    • addOnLocalEncodingEnabled
    • addOnReceiveDtmfTone
    • addOnReceiveDtmfToneChange
    • addOnSendDtmfTone
    • addOnSendDtmfToneChange
    • addOnStateChange
    • changeDirection
    • getCachedLocalDirection
    • getCanonicalName
    • getCodecDisabled
    • getConnectedTimestamp
    • getConnection
    • getConnectionId
    • getControlTransportInfo
    • getDirection
    • getDirectionCapabilities
    • getDynamicProperties
    • getDynamicValue
    • getExternalId
    • getG722Disabled
    • getId
    • getInfo
    • getInputContent
    • getInputMuted
    • getIsTerminated
    • getIsTerminating
    • getIsTerminatingOrTerminated
    • getLabel
    • getLocalBandwidth
    • getLocalCanonicalName
    • getLocalDirection
    • getLocalMuted
    • getLocalReceive
    • getLocalSend
    • getLocalTrack
    • getMaxReceiveBitrate
    • getMaxSendBitrate
    • getMediaDescriptionId
    • getMuted
    • getOpusDisabled
    • getOutputContent
    • getOutputMuted
    • getPcmaDisabled
    • getPcmuDisabled
    • getPreferredCodecs
    • getRelatedMediaDescription
    • getRemoteBandwidth
    • getRemoteCanonicalName
    • getRemoteDirection
    • getRemoteEncoding
    • getRemoteMuted
    • getRemoteReceive
    • getRemoteRequestedDeactivation
    • getRemoteSend
    • getRemoteTrack
    • getRenegotiationPending
    • getSimulcastMode
    • getState
    • getTag
    • getTransportInfo
    • getType
    • getTypeString
    • insertDtmfTone
    • insertDtmfTones
    • populateInfo
    • processCachedChanges
    • processSdpContentAttribute
    • processSdpMediaDescription
    • processStateChange
    • processStateLockChange
    • raiseBitrateNotification
    • raiseBitrateRequest
    • raiseLocalEncodingDisabled
    • raiseLocalEncodingEnabled
    • removeOnDirectionChange
    • removeOnDiscardBitrateNotification
    • removeOnDiscardBitrateRequest
    • removeOnLocalEncodingDisabled
    • removeOnLocalEncodingEnabled
    • removeOnReceiveDtmfTone
    • removeOnReceiveDtmfToneChange
    • removeOnSendDtmfTone
    • removeOnSendDtmfToneChange
    • removeOnStateChange
    • resetRemoteDirection
    • setCodecDisabled
    • setControlTransportInfo
    • setDynamicValue
    • setExternalId
    • setG722Disabled
    • setInputContent
    • setInputMuted
    • setLocalBandwidth
    • setLocalDirection
    • setLocalMuted
    • setLocalReceive
    • setLocalSend
    • setLocalTrack
    • setMaxReceiveBitrate
    • setMaxSendBitrate
    • setMuted
    • setOpusDisabled
    • setOutputContent
    • setOutputMuted
    • setPcmaDisabled
    • setPcmuDisabled
    • setPreferredCodecs
    • setRelatedMediaDescription
    • setRemoteBandwidth
    • setRemoteEncoding
    • setRemoteMuted
    • setRemoteTrack
    • setRenegotiationPending
    • setSimulcastMode
    • setTag
    • setTransportInfo
    • toString
    • unsetDynamicValue

    Constructors

    constructor

    + new WebRtcAudioStream(external: IExternalAudioStream, localTrack: WebRtcAudioTrack, remoteTrack: WebRtcAudioTrack): WebRtcAudioStream

    Parameters:

    Name Type
    external IExternalAudioStream
    localTrack WebRtcAudioTrack
    remoteTrack WebRtcAudioTrack

    Returns: WebRtcAudioStream

    Inherited from: WebRtcMediaStream

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

    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    addOnDiscardBitrateNotification

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

    Parameters:

    Name Type
    value IAction1<BitrateNotification>

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:756


    addOnDiscardBitrateRequest

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

    Parameters:

    Name Type
    value IAction1<BitrateRequest>

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:584


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    addOnReceiveDtmfTone

    ▸ addOnReceiveDtmfTone(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    addOnReceiveDtmfToneChange

    ▸ addOnReceiveDtmfToneChange(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    addOnSendDtmfTone

    ▸ addOnSendDtmfTone(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcAudioStream.ts:61


    addOnSendDtmfToneChange

    ▸ addOnSendDtmfToneChange(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getCachedLocalDirection

    ▸ getCachedLocalDirection(): StreamDirection

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

    Returns: StreamDirection

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getCanonicalName

    ▸ getCanonicalName(): string

    Gets the canonical name.

    deprecated Use LocalCanonicalName instead.

    Returns: string

    Inherited from: WebRtcMediaStream

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


    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.

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


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

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


    getConnection

    ▸ getConnection(): WebRtcConnection

    Returns: WebRtcConnection

    Inherited from: WebRtcMediaStream

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


    getConnectionId

    ▸ getConnectionId(): string

    Gets the connection identifier.

    Returns: string

    Inherited from: WebRtcMediaStream

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


    getControlTransportInfo

    ▸ getControlTransportInfo(): TransportInfo

    Returns: TransportInfo

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:571


    getDirection

    ▸ getDirection(): StreamDirection

    Returns: StreamDirection

    The Media Direction as a StreamDirection enumerator.

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getDirectionCapabilities

    ▸ getDirectionCapabilities(): StreamDirection

    Returns: StreamDirection

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:561


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: WebRtcMediaStream

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

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


    getExternalId

    ▸ getExternalId(): string

    Gets the external identifier.

    Returns: string

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getG722Disabled

    ▸ getG722Disabled(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

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


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getInfo

    ▸ getInfo(): MediaStreamInfo

    Gets the media stream info.

    Returns: MediaStreamInfo

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getInputContent

    ▸ getInputContent(): string

    Gets the input content descriptor.

    Returns: string

    Inherited from: WebRtcMediaStream

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


    getInputMuted

    ▸ getInputMuted(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getIsTerminated

    ▸ getIsTerminated(): boolean

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

    Returns: boolean

    Inherited from: WebRtcMediaStream

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


    getIsTerminating

    ▸ getIsTerminating(): boolean

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

    Returns: boolean

    Inherited from: WebRtcMediaStream

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


    getIsTerminatingOrTerminated

    ▸ getIsTerminatingOrTerminated(): boolean

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

    Returns: boolean

    Inherited from: WebRtcMediaStream

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


    getLabel

    ▸ getLabel(): string

    Gets a label that identifies this class.

    Returns: string

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getLocalDirection

    ▸ getLocalDirection(): StreamDirection

    Gets current direction indicated by the local description.

    Returns: StreamDirection

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getLocalTrack

    ▸ getLocalTrack(): WebRtcAudioTrack

    Returns: WebRtcAudioTrack

    Inherited from: WebRtcMediaStream

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


    getMaxReceiveBitrate

    ▸ getMaxReceiveBitrate(): number

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

    Returns: number

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Inherited from: WebRtcMediaStream

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


    getOpusDisabled

    ▸ getOpusDisabled(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

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


    getOutputContent

    ▸ getOutputContent(): string

    Gets the output content descriptor.

    Returns: string

    Inherited from: WebRtcMediaStream

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


    getOutputMuted

    ▸ getOutputMuted(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getPcmaDisabled

    ▸ getPcmaDisabled(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcAudioStream.ts:120


    getPcmuDisabled

    ▸ getPcmuDisabled(): boolean

    Returns: boolean

    Implementation of: IInternalAudioStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcAudioStream.ts:117


    getPreferredCodecs

    ▸ getPreferredCodecs(): string[]

    Gets any preferred codecs, in order of preference.

    Returns: string[]

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRelatedMediaDescription

    ▸ ProtectedgetRelatedMediaDescription(): MediaDescription

    Gets related SDP Media Description

    Returns: MediaDescription

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRemoteCanonicalName

    ▸ getRemoteCanonicalName(): string

    Gets the remote canonical name.

    Returns: string

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRemoteDirection

    ▸ getRemoteDirection(): StreamDirection

    Gets current direction indicated by the remote description.

    Returns: StreamDirection

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRemoteEncoding

    ▸ getRemoteEncoding(): EncodingInfo

    Gets the remote encoding.

    Returns: EncodingInfo

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRemoteMuted

    ▸ getRemoteMuted(): boolean

    Gets a value indicating if remote is muted.

    Returns: boolean

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getRemoteTrack

    ▸ getRemoteTrack(): WebRtcAudioTrack

    Returns: WebRtcAudioTrack

    Inherited from: WebRtcMediaStream

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


    getRenegotiationPending

    ▸ ProtectedgetRenegotiationPending(): boolean

    Gets whether there exist changes that are pending SDP renegotiation.

    Returns: boolean

    Inherited from: WebRtcMediaStream

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


    getSimulcastMode

    ▸ getSimulcastMode(): SimulcastMode

    Returns: SimulcastMode

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getState

    ▸ getState(): StreamState

    Gets the state of the stream.

    Returns: StreamState

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getTag

    ▸ getTag(): string

    Gets optional data to associate with this instance.

    Returns: string

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getTransportInfo

    ▸ getTransportInfo(): TransportInfo

    Returns: TransportInfo

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getType

    ▸ getType(): StreamType

    Gets the type.

    Returns: StreamType

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: WebRtcMediaStream

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


    insertDtmfTone

    ▸ insertDtmfTone(dtmfTone: Tone): boolean

    Parameters:

    Name Type
    dtmfTone Tone

    Returns: boolean

    Implementation of: IInternalAudioStream

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


    insertDtmfTones

    ▸ insertDtmfTones(dtmfTones: Tone[]): boolean

    Parameters:

    Name Type
    dtmfTones Tone[]

    Returns: boolean

    Implementation of: IInternalAudioStream

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


    populateInfo

    ▸ populateInfo(info: MediaStreamInfo): void

    Parameters:

    Name Type
    info MediaStreamInfo

    Returns: void

    Inherited from: WebRtcMediaStream

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


    processCachedChanges

    ▸ processCachedChanges(): void

    Returns: void

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:511


    processSdpContentAttribute

    ▸ ProtectedprocessSdpContentAttribute(sdpContentAttribute: ContentAttribute, isLocalDescription: boolean): void

    Parameters:

    Name Type
    sdpContentAttribute ContentAttribute
    isLocalDescription boolean

    Returns: void

    Overrides: WebRtcMediaStream

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


    processSdpMediaDescription

    ▸ processSdpMediaDescription(sdpMessage: Message, sdpMediaDescription: MediaDescription, index: number, isLocalDescription: boolean, isOffer: boolean, isRenegotiation: boolean): Error

    Parameters:

    Name Type
    sdpMessage Message
    sdpMediaDescription MediaDescription
    index number
    isLocalDescription boolean
    isOffer boolean
    isRenegotiation boolean

    Returns: Error

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:524


    processStateChange

    ▸ ProtectedprocessStateChange(): void

    Processes a state change.

    Returns: void

    Inherited from: WebRtcMediaStream

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


    processStateLockChange

    ▸ ProtectedprocessStateLockChange(): void

    Processes a state lock change.

    Returns: void

    Inherited from: WebRtcMediaStream

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


    raiseBitrateNotification

    ▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

    Parameters:

    Name Type
    bitrateNotification BitrateNotification

    Returns: boolean

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:773


    raiseBitrateRequest

    ▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

    Parameters:

    Name Type
    bitrateRequest BitrateRequest

    Returns: boolean

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:620


    raiseLocalEncodingDisabled

    ▸ ProtectedraiseLocalEncodingDisabled(encoding: EncodingInfo): void

    Raises the OnLocalEncodingDisabled event.

    Parameters:

    Name Type Description
    encoding EncodingInfo The encoding.

    Returns: void

    Inherited from: WebRtcMediaStream

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


    raiseLocalEncodingEnabled

    ▸ ProtectedraiseLocalEncodingEnabled(encoding: EncodingInfo): void

    Raises the OnLocalEncodingEnabled event.

    Parameters:

    Name Type Description
    encoding EncodingInfo The encoding.

    Returns: void

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    removeOnDiscardBitrateNotification

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

    Parameters:

    Name Type
    value IAction1<BitrateNotification>

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:759


    removeOnDiscardBitrateRequest

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

    Parameters:

    Name Type
    value IAction1<BitrateRequest>

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:587


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    removeOnReceiveDtmfTone

    ▸ removeOnReceiveDtmfTone(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    removeOnReceiveDtmfToneChange

    ▸ removeOnReceiveDtmfToneChange(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    removeOnSendDtmfTone

    ▸ removeOnSendDtmfTone(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    removeOnSendDtmfToneChange

    ▸ removeOnSendDtmfToneChange(value: IAction1<Tone>): void

    Parameters:

    Name Type
    value IAction1<Tone>

    Returns: void

    Implementation of: IInternalAudioStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    resetRemoteDirection

    ▸ resetRemoteDirection(): void

    Returns: void

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:518


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setControlTransportInfo

    ▸ setControlTransportInfo(info: TransportInfo): void

    Parameters:

    Name Type
    info TransportInfo

    Returns: void

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:567


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

    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setG722Disabled

    ▸ setG722Disabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioStream

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


    setInputContent

    ▸ ProtectedsetInputContent(value: string): void

    Sets the input content descriptor.

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: WebRtcMediaStream

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


    setInputMuted

    ▸ setInputMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setLocalDirection

    ▸ setLocalDirection(value: StreamDirection): void

    Sets current direction indicated by the local description.

    Parameters:

    Name Type
    value StreamDirection

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    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

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setLocalTrack

    ▸ setLocalTrack(localTrack: WebRtcAudioTrack): void

    Parameters:

    Name Type
    localTrack WebRtcAudioTrack

    Returns: void

    Inherited from: WebRtcMediaStream

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


    setMaxReceiveBitrate

    ▸ setMaxReceiveBitrate(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:817


    setMaxSendBitrate

    ▸ setMaxSendBitrate(value: number): Future<object>

    Parameters:

    Name Type
    value number

    Returns: Future<object>

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:778


    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

    Inherited from: WebRtcMediaStream

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


    setOpusDisabled

    ▸ setOpusDisabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcAudioStream.ts:123


    setOutputContent

    ▸ ProtectedsetOutputContent(value: string): void

    Sets the output content descriptor.

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: WebRtcMediaStream

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


    setOutputMuted

    ▸ setOutputMuted(muted: boolean): void

    Parameters:

    Name Type
    muted boolean

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setPcmaDisabled

    ▸ setPcmaDisabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioStream

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


    setPcmuDisabled

    ▸ setPcmuDisabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioStream

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


    setPreferredCodecs

    ▸ setPreferredCodecs(value: string[]): void

    Sets any preferred codecs, in order of preference.

    Parameters:

    Name Type
    value string[]

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setRelatedMediaDescription

    ▸ ProtectedsetRelatedMediaDescription(value: MediaDescription): void

    Sets related SDP Media Description

    Parameters:

    Name Type
    value MediaDescription

    Returns: void

    Inherited from: WebRtcMediaStream

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


    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

    Inherited from: WebRtcMediaStream

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


    setRemoteEncoding

    ▸ setRemoteEncoding(value: EncodingInfo): void

    Sets the remote encoding.

    Parameters:

    Name Type
    value EncodingInfo

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setRemoteMuted

    ▸ setRemoteMuted(value: boolean): void

    Sets a value indicating if remote is muted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setRemoteTrack

    ▸ setRemoteTrack(remoteTrack: WebRtcAudioTrack): void

    Parameters:

    Name Type
    remoteTrack WebRtcAudioTrack

    Returns: void

    Inherited from: WebRtcMediaStream

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


    setRenegotiationPending

    ▸ ProtectedsetRenegotiationPending(value: boolean): void

    Sets whether there exist changes that are pending SDP renegotiation.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: WebRtcMediaStream

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


    setSimulcastMode

    ▸ setSimulcastMode(value: SimulcastMode): void

    Parameters:

    Name Type
    value SimulcastMode

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaStream.ts:580


    setTag

    ▸ setTag(value: string): void

    Sets optional data to associate with this instance.

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalAudioStream

    Inherited from: WebRtcMediaStream

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


    setTransportInfo

    ▸ setTransportInfo(transportInfo: TransportInfo): void

    Parameters:

    Name Type
    transportInfo TransportInfo

    Returns: void

    Inherited from: WebRtcMediaStream

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


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    Inherited from: WebRtcMediaStream

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


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

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