Search Results for

    / fm / liveswitch / WebRtcLocalMedia

    Class: WebRtcLocalMedia

    fm.liveswitch.WebRtcLocalMedia

    Hierarchy

    • WebRtcLocalMediaBase<WebRtcLocalMedia, WebRtcAudioTrack, WebRtcVideoTrack>

      ↳ WebRtcLocalMedia

    Implements

    • ILocalMedia<WebRtcLocalMedia, WebRtcAudioTrack, WebRtcVideoTrack>
    • IInternalLocalMedia

    Table of contents

    Constructors

    • constructor

    Properties

    • _audioSourceInput
    • _videoSourceInput

    Methods

    • _setAudioMediaStream
    • _setVideoMediaStream
    • abortStart
    • addOnAudioDestroyed
    • addOnAudioLevel
    • addOnAudioMuted
    • addOnAudioStarted
    • addOnAudioStopped
    • addOnAudioUnmuted
    • addOnVideoDestroyed
    • addOnVideoMuted
    • addOnVideoSize
    • addOnVideoSizeChange
    • addOnVideoStarted
    • addOnVideoStopped
    • addOnVideoUnmuted
    • changeAudioConstraints
    • changeAudioSourceInput
    • changeVideoConstraints
    • changeVideoSourceInput
    • destroy
    • destroyAudioContext
    • doGetAudioEncodings
    • doGetVideoEncodings
    • doSetAudioEncodings
    • doSetVideoEncodings
    • doStart
    • doStartInternal
    • doStop
    • getAudio
    • getAudioConstraints
    • getAudioEncoding
    • getAudioEncodings
    • getAudioGain
    • getAudioLevelInterval
    • getAudioMuted
    • getAudioSimulcastDisabled
    • getAudioSimulcastEncodingCount
    • getAudioSimulcastPreferredBitrate
    • getAudioSink
    • getAudioSourceInput
    • getAudioSourceInputs
    • getAudioTrack
    • getAudioTracks
    • getAudioVolume
    • getDynamicProperties
    • getDynamicValue
    • getId
    • getScreen
    • getSourceInputs
    • getState
    • getTypeString
    • getVideo
    • getVideoConstraints
    • getVideoEncoding
    • getVideoEncodings
    • getVideoMuted
    • getVideoSimulcastBitsPerPixel
    • getVideoSimulcastDegradationPreference
    • getVideoSimulcastDisabled
    • getVideoSimulcastEncodingCount
    • getVideoSimulcastPreferredBitrate
    • getVideoSink
    • getVideoSize
    • getVideoSourceInput
    • getVideoSourceInputs
    • getVideoTrack
    • getVideoTracks
    • getView
    • getViewSink
    • grabVideoFrame
    • initializeAudioContext
    • lockAudioEncodings
    • lockVideoEncodings
    • removeOnAudioDestroyed
    • removeOnAudioLevel
    • removeOnAudioMuted
    • removeOnAudioStarted
    • removeOnAudioStopped
    • removeOnAudioUnmuted
    • removeOnVideoDestroyed
    • removeOnVideoMuted
    • removeOnVideoSize
    • removeOnVideoSizeChange
    • removeOnVideoStarted
    • removeOnVideoStopped
    • removeOnVideoUnmuted
    • setAudio
    • setAudioEncodings
    • setAudioGain
    • setAudioLevelInterval
    • setAudioMuted
    • setAudioSimulcastDisabled
    • setAudioSimulcastEncodingCount
    • setAudioSimulcastPreferredBitrate
    • setAudioSourceInput
    • setAudioVolume
    • setDynamicValue
    • setId
    • setScreen
    • setVideo
    • setVideoEncodings
    • setVideoMuted
    • setVideoSimulcastBitsPerPixel
    • setVideoSimulcastDegradationPreference
    • setVideoSimulcastDisabled
    • setVideoSimulcastEncodingCount
    • setVideoSimulcastPreferredBitrate
    • setVideoSourceInput
    • start
    • stop
    • unsetDynamicValue
    • getDefaultVideoBitsPerPixel
    • setDefaultVideoBitsPerPixel

    Constructors

    constructor

    + new WebRtcLocalMedia(external: IExternalLocalMedia, audio: any, video: any, screen?: boolean): WebRtcLocalMedia

    Parameters:

    Name Type
    external IExternalLocalMedia
    audio any
    video any
    screen? boolean

    Returns: WebRtcLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:396

    Properties

    _audioSourceInput

    • Private _audioSourceInput: SourceInput

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


    _videoSourceInput

    • Private _videoSourceInput: SourceInput

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

    Methods

    _setAudioMediaStream

    ▸ Protected_setAudioMediaStream(audioMediaStream: MediaStream): boolean

    Parameters:

    Name Type
    audioMediaStream MediaStream

    Returns: boolean

    Inherited from: WebRtcLocalMediaBase

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


    _setVideoMediaStream

    ▸ Protected_setVideoMediaStream(videoMediaStream: MediaStream): boolean

    Parameters:

    Name Type
    videoMediaStream MediaStream

    Returns: boolean

    Inherited from: WebRtcLocalMediaBase

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


    abortStart

    ▸ ProtectedabortStart(promise: Promise<WebRtcLocalMedia>, exception: Exception): void

    Aborts the start.

    Parameters:

    Name Type Description
    promise Promise<WebRtcLocalMedia> The promise.
    exception Exception The exception.

    Returns: void

    Inherited from: WebRtcLocalMediaBase

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


    addOnAudioDestroyed

    ▸ addOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:162


    addOnAudioLevel

    ▸ addOnAudioLevel(value: IAction1<number>): void

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:175


    addOnAudioMuted

    ▸ addOnAudioMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    addOnAudioStarted

    ▸ addOnAudioStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:133


    addOnAudioStopped

    ▸ addOnAudioStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    addOnAudioUnmuted

    ▸ addOnAudioUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    addOnVideoDestroyed

    ▸ addOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:165


    addOnVideoMuted

    ▸ addOnVideoMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:105


    addOnVideoSize

    ▸ addOnVideoSize(value: IAction1<Size>): void

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:179


    addOnVideoSizeChange

    ▸ addOnVideoSizeChange(value: IAction1<Size>): void

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:183


    addOnVideoStarted

    ▸ addOnVideoStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    addOnVideoStopped

    ▸ addOnVideoStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    addOnVideoUnmuted

    ▸ addOnVideoUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    changeAudioConstraints

    ▸ changeAudioConstraints(audioConstraints: MediaTrackConstraints): Future<Object>

    Parameters:

    Name Type
    audioConstraints MediaTrackConstraints

    Returns: Future<Object>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:264


    changeAudioSourceInput

    ▸ changeAudioSourceInput(audioSourceInput: SourceInput): Future<Object>

    Parameters:

    Name Type
    audioSourceInput SourceInput

    Returns: Future<Object>

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:316


    changeVideoConstraints

    ▸ changeVideoConstraints(videoConstraints: MediaTrackConstraints): Future<Object>

    Parameters:

    Name Type
    videoConstraints MediaTrackConstraints

    Returns: Future<Object>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:290


    changeVideoSourceInput

    ▸ changeVideoSourceInput(videoSourceInput: SourceInput): Future<Object>

    Parameters:

    Name Type
    videoSourceInput SourceInput

    Returns: Future<Object>

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:353


    destroy

    ▸ destroy(): void

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:214


    destroyAudioContext

    ▸ ProtecteddestroyAudioContext(): void

    Returns: void

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:437


    doGetAudioEncodings

    ▸ ProtecteddoGetAudioEncodings(): AudioEncodingConfig[]

    Returns: AudioEncodingConfig[]

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:952


    doGetVideoEncodings

    ▸ ProtecteddoGetVideoEncodings(): VideoEncodingConfig[]

    Returns: VideoEncodingConfig[]

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:961


    doSetAudioEncodings

    ▸ ProtecteddoSetAudioEncodings(encodings: AudioEncodingConfig[]): void

    Parameters:

    Name Type
    encodings AudioEncodingConfig[]

    Returns: void

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:955


    doSetVideoEncodings

    ▸ ProtecteddoSetVideoEncodings(encodings: VideoEncodingConfig[]): void

    Parameters:

    Name Type
    encodings VideoEncodingConfig[]

    Returns: void

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:964


    doStart

    ▸ doStart(): Future<WebRtcLocalMedia>

    Returns: Future<WebRtcLocalMedia>

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:465


    doStartInternal

    ▸ PrivatedoStartInternal(promise: Promise<WebRtcLocalMedia>): void

    Parameters:

    Name Type
    promise Promise<WebRtcLocalMedia>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:525


    doStop

    ▸ doStop(): Future<WebRtcLocalMedia>

    Returns: Future<WebRtcLocalMedia>

    Overrides: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:881


    getAudio

    ▸ getAudio(): any

    Returns: any

    Inherited from: WebRtcLocalMediaBase

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


    getAudioConstraints

    ▸ getAudioConstraints(): MediaTrackConstraints

    Returns: MediaTrackConstraints

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:255


    getAudioEncoding

    ▸ getAudioEncoding(): AudioEncodingConfig

    Gets the local audio encoding configuration. If there are multiple audio tracks in a custom media stack, this method calls into the first audio track.

    Returns: AudioEncodingConfig

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    getAudioEncodings

    ▸ getAudioEncodings(): AudioEncodingConfig[]

    Gets the local audio encoding configurations. Audio encodings cannot be empty, so if you set an encoding with a null value or an empty array, this method creates an empty array with one AudioEncodingConfig in it.
    If a new audio encodings array has the same number of encodings as the current one, the new audio encodings are applied to the local media’s audio track. Otherwise, an exception is thrown because the number of audio encodings cannot be changed once they are set.

    Returns: AudioEncodingConfig[]

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:174


    getAudioGain

    ▸ getAudioGain(): number

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:218


    getAudioLevelInterval

    ▸ getAudioLevelInterval(): number

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:222


    getAudioMuted

    ▸ getAudioMuted(): boolean

    Gets a value indicating whether the audio is muted. This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

    Returns: boolean

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    getAudioSimulcastDisabled

    ▸ getAudioSimulcastDisabled(): boolean

    Gets whether audio simulcast is disabled.

    Returns: boolean

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    getAudioSimulcastEncodingCount

    ▸ getAudioSimulcastEncodingCount(): number

    Gets the maximum number of simulcast encodings that this media produces for the audio stream.
    The number of encodings cannot be changed once they are set.
    This property must be set before the media starts.

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:200


    getAudioSimulcastPreferredBitrate

    ▸ getAudioSimulcastPreferredBitrate(): number

    Gets the preferred audio simulcast bitrate, in kbps. The bitrate must be a positive integer.

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    getAudioSink

    ▸ getAudioSink(): WebRtcDomAudioSink

    Returns: WebRtcDomAudioSink

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:249


    getAudioSourceInput

    ▸ getAudioSourceInput(): SourceInput

    Returns: SourceInput

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:225


    getAudioSourceInputs

    ▸ getAudioSourceInputs(): Future<SourceInput[]>

    Returns: Future<SourceInput[]>

    Implementation of: IInternalLocalMedia

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


    getAudioTrack

    ▸ getAudioTrack(): WebRtcAudioTrack

    Gets the audio track from this media. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track. Returns null if there are no audio tracks.

    Returns: WebRtcAudioTrack

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:125


    getAudioTracks

    ▸ getAudioTracks(): WebRtcAudioTrack[]

    Returns: WebRtcAudioTrack[]

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:225


    getAudioVolume

    ▸ getAudioVolume(): number

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:231


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: WebRtcLocalMediaBase

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

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


    getId

    ▸ getId(): string

    Gets the unique identifier of this media.

    Returns: string

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:160


    getScreen

    ▸ getScreen(): boolean

    Returns: boolean

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


    getSourceInputs

    ▸ PrivategetSourceInputs(kind: string): Future<SourceInput[]>

    Parameters:

    Name Type
    kind string

    Returns: Future<SourceInput[]>

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:166


    getState

    ▸ getState(): LocalMediaState

    Gets the current state of this media. The possible states are defined in the enumeration LocalMediaState. Use this property to check if, for example, the media instance is starting, has started, is stopping, or has stopped.

    Returns: LocalMediaState

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:225


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: WebRtcLocalMediaBase

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


    getVideo

    ▸ getVideo(): any

    Returns: any

    Inherited from: WebRtcLocalMediaBase

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


    getVideoConstraints

    ▸ getVideoConstraints(): MediaTrackConstraints

    Returns: MediaTrackConstraints

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:260


    getVideoEncoding

    ▸ getVideoEncoding(): VideoEncodingConfig

    Gets the local video encoding configuration.
    If there are multiple video tracks in a custom media stack, this method calls into the first video track. Returns the local VideoEncodingConfig.

    Returns: VideoEncodingConfig

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:238


    getVideoEncodings

    ▸ getVideoEncodings(): VideoEncodingConfig[]

    Gets the local video encoding configurations. Video encodings cannot be empty, so if you set the value of this method to null or an empty array, an exception is thrown.
    The number of video encodings cannot be changed once set. If the number of new video encodings is different from the existing number of video encodings, an error is thrown. If a new video encoding array has the same number of encodings as the current one, the encodings are applied to the media’s VP8, VP9, H.264, and H.265 controllers, converters, encoders, and packetizers.
    For controllers which inherit from FrameRatePipe, that means setting controller.OutputSynchronizationSource to the encoding.SynchronizationSource. If the encoding.FrameRate is greater than zero, this sets the controller.MaxFrameRate and controller.TargetFrameRate to the encoding.FrameRate.
    For converters which are the ImageScalePipe type, that means setting converter.MaxScale and converter.TargetScale to encoding.Scale, as long as encoding.Scale is greater than zero.
    For encoders, if the encoder's output format is not a fixed bitrate and encoding.Bitrate is greater than zero, that means setting the encoder.MaxBitrate and encoder.TargetBitrate to encoding.Bitrate.
    For packetizers, that means setting packetizer.Deactivated to encoding.Deactivated.

    Returns: VideoEncodingConfig[]

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:255


    getVideoMuted

    ▸ getVideoMuted(): boolean

    Gets a value indicating whether the video track is muted.
    If the video track is muted, then remote users see a black frame instead of the local user’s video.
    If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

    Returns: boolean

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:174


    getVideoSimulcastBitsPerPixel

    ▸ getVideoSimulcastBitsPerPixel(): number

    Gets the video simulcast bits per pixel (bpp). The bits per pixel value must be greater than or equal to zero.
    If the video source has declared a target width, height, and frame rate, and VideoSimulcastBitsPerPixel has a set value, then the encoding bitrates are calculated with setVideoSimulcastBitsPerPixel’s value instead of the preferred bitrate.

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:268


    getVideoSimulcastDegradationPreference

    ▸ getVideoSimulcastDegradationPreference(): VideoDegradationPreference

    Gets the video’s simulcast degradation preference.
    The following degradation preferences can be set:
    Automatic: Prefers to automate degradation based on video type. A Screen video type prefers to degrade FrameRate. A Camera video type prefers to degrade Resolution. An unknown video type prefers a Balanced approach.
    Balanced: Prefers to degrade both FrameRate and Resolution together in smaller increments.
    FrameRate: Prefers to degrade FrameRate instead of Resolution.
    Resolution: Prefers to degrade Resolution instead of FrameRate.

    Returns: VideoDegradationPreference

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:285


    getVideoSimulcastDisabled

    ▸ getVideoSimulcastDisabled(): boolean

    Gets whether video simulcast is disabled. If true, video simulcast is disabled. If false, video simulcast is enabled.

    Returns: boolean

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:297


    getVideoSimulcastEncodingCount

    ▸ getVideoSimulcastEncodingCount(): number

    Gets the maximum number of simulcast encodings that this LocalMedia produces for the video stream. The default value is 2. For LiveSwitch Media Server, the maximum is 4 encodings. This property must be set before the LocalMedia starts.

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:309


    getVideoSimulcastPreferredBitrate

    ▸ getVideoSimulcastPreferredBitrate(): number

    Gets the preferred bitrate of a video simulcast in Kbps. The bitrate must be a positive integer.

    Returns: number

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    getVideoSink

    ▸ getVideoSink(): WebRtcDomVideoSink

    Returns: WebRtcDomVideoSink

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:255


    getVideoSize

    ▸ getVideoSize(): Size

    Returns: Size

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:240


    getVideoSourceInput

    ▸ getVideoSourceInput(): SourceInput

    Returns: SourceInput

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:235


    getVideoSourceInputs

    ▸ getVideoSourceInputs(): Future<SourceInput[]>

    Returns: Future<SourceInput[]>

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:162


    getVideoTrack

    ▸ getVideoTrack(): WebRtcVideoTrack

    Gets the video track from this media.
    If there are multiple video tracks in a custom media stack, this property is bound to the first video track. Returns null if there are no video tracks.

    Returns: WebRtcVideoTrack

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:196


    getVideoTracks

    ▸ getVideoTracks(): WebRtcVideoTrack[]

    Returns: WebRtcVideoTrack[]

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:243


    getView

    ▸ getView(): HTMLElement

    Returns: HTMLElement

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:261


    getViewSink

    ▸ getViewSink(): WebRtcDomVideoSink

    Returns: WebRtcDomVideoSink

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    grabVideoFrame

    ▸ grabVideoFrame(): Future<VideoBuffer>

    Returns: Future<VideoBuffer>

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:273


    initializeAudioContext

    ▸ ProtectedinitializeAudioContext(): void

    Returns: void

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:327


    lockAudioEncodings

    ▸ ProtectedlockAudioEncodings(): void

    Locks the audio encodings in prior to initialization.

    Returns: void

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:346


    lockVideoEncodings

    ▸ ProtectedlockVideoEncodings(): void

    Locks the video encodings in prior to initialization.

    Returns: void

    Inherited from: WebRtcLocalMediaBase

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

    ▸ ProtectedlockVideoEncodings(sourceType: VideoType): void

    Locks the video encodings in prior to initialization.

    Parameters:

    Name Type
    sourceType VideoType

    Returns: void

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:366

    ▸ ProtectedlockVideoEncodings(sourceType: VideoType, sourceWidth: number, sourceHeight: number, sourceFrameRate: number): void

    Locks the video encodings in prior to initialization.

    Parameters:

    Name Type
    sourceType VideoType
    sourceWidth number
    sourceHeight number
    sourceFrameRate number

    Returns: void

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:372


    removeOnAudioDestroyed

    ▸ removeOnAudioDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:168


    removeOnAudioLevel

    ▸ removeOnAudioLevel(value: IAction1<number>): void

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:292


    removeOnAudioMuted

    ▸ removeOnAudioMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    removeOnAudioStarted

    ▸ removeOnAudioStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:145


    removeOnAudioStopped

    ▸ removeOnAudioStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:148


    removeOnAudioUnmuted

    ▸ removeOnAudioUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    removeOnVideoDestroyed

    ▸ removeOnVideoDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:171


    removeOnVideoMuted

    ▸ removeOnVideoMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    removeOnVideoSize

    ▸ removeOnVideoSize(value: IAction1<Size>): void

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:298


    removeOnVideoSizeChange

    ▸ removeOnVideoSizeChange(value: IAction1<Size>): void

    Parameters:

    Name Type
    value IAction1<Size>

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    removeOnVideoStarted

    ▸ removeOnVideoStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:151


    removeOnVideoStopped

    ▸ removeOnVideoStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:154


    removeOnVideoUnmuted

    ▸ removeOnVideoUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalLocalMedia

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


    setAudio

    ▸ setAudio(audio: any): void

    Parameters:

    Name Type
    audio any

    Returns: void

    Inherited from: WebRtcLocalMediaBase

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


    setAudioEncodings

    ▸ setAudioEncodings(value: AudioEncodingConfig[]): void

    Sets the local audio encoding configurations. Audio encodings cannot be empty, so if you set an encoding with a null value or an empty array, this method creates an empty array with one AudioEncodingConfig in it.
    If a new audio encodings array has the same number of encodings as the current one, the new audio encodings are applied to the local media’s audio track. Otherwise, an exception is thrown because the number of audio encodings cannot be changed once they are set.

    Parameters:

    Name Type
    value AudioEncodingConfig[]

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:397


    setAudioGain

    ▸ setAudioGain(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:304


    setAudioLevelInterval

    ▸ setAudioLevelInterval(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:308


    setAudioMuted

    ▸ setAudioMuted(value: boolean): void

    Sets a value indicating whether the audio is muted. This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    setAudioSimulcastDisabled

    ▸ setAudioSimulcastDisabled(value: boolean): void

    Sets whether audio simulcast is disabled.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:420


    setAudioSimulcastEncodingCount

    ▸ setAudioSimulcastEncodingCount(value: number): void

    Sets the maximum number of simulcast encodings that this media produces for the audio stream.
    The number of encodings cannot be changed once they are set.
    This property must be set before the media starts.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:434


    setAudioSimulcastPreferredBitrate

    ▸ setAudioSimulcastPreferredBitrate(value: number): void

    Sets the preferred audio simulcast bitrate, in kbps. The bitrate must be a positive integer.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:448


    setAudioSourceInput

    ▸ setAudioSourceInput(audioInput: SourceInput): void

    Parameters:

    Name Type
    audioInput SourceInput

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:228


    setAudioVolume

    ▸ setAudioVolume(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMedia.ts:317


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

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


    setId

    ▸ setId(value: string): void

    Sets the unique identifier of this media.

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:319


    setScreen

    ▸ setScreen(screen: boolean): void

    Parameters:

    Name Type
    screen boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:250


    setVideo

    ▸ setVideo(video: any): void

    Parameters:

    Name Type
    video any

    Returns: void

    Inherited from: WebRtcLocalMediaBase

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


    setVideoEncodings

    ▸ setVideoEncodings(value: VideoEncodingConfig[]): void

    Sets the local video encoding configurations. Video encodings cannot be empty, so if you set the value of this method to null or an empty array, an exception is thrown.
    The number of video encodings cannot be changed once set. If the number of new video encodings is different from the existing number of video encodings, an error is thrown. If a new video encoding array has the same number of encodings as the current one, the encodings are applied to the media’s VP8, VP9, H.264, and H.265 controllers, converters, encoders, and packetizers.
    For controllers which inherit from FrameRatePipe, that means setting controller.OutputSynchronizationSource to the encoding.SynchronizationSource. If the encoding.FrameRate is greater than zero, this sets the controller.MaxFrameRate and controller.TargetFrameRate to the encoding.FrameRate.
    For converters which are the ImageScalePipe type, that means setting converter.MaxScale and converter.TargetScale to encoding.Scale, as long as encoding.Scale is greater than zero.
    For encoders, if the encoder's output format is not a fixed bitrate and encoding.Bitrate is greater than zero, that means setting the encoder.MaxBitrate and encoder.TargetBitrate to encoding.Bitrate.
    For packetizers, that means setting packetizer.Deactivated to encoding.Deactivated.

    Parameters:

    Name Type
    value VideoEncodingConfig[]

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:474


    setVideoMuted

    ▸ setVideoMuted(value: boolean): void

    Sets a value indicating whether the video track is muted.
    If the video track is muted, then remote users see a black frame instead of the local user’s video.
    If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcMediaBase.ts:333


    setVideoSimulcastBitsPerPixel

    ▸ setVideoSimulcastBitsPerPixel(value: number): void

    Sets the video simulcast bits per pixel (bpp). The bits per pixel value must be greater than or equal to zero.
    If the video source has declared a target width, height, and frame rate, and VideoSimulcastBitsPerPixel has a set value, then the encoding bitrates are calculated with setVideoSimulcastBitsPerPixel’s value instead of the preferred bitrate.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:498


    setVideoSimulcastDegradationPreference

    ▸ setVideoSimulcastDegradationPreference(value: VideoDegradationPreference): void

    Sets the video’s simulcast degradation preference.
    The following degradation preferences can be set:
    Automatic: Prefers to automate degradation based on video type. A Screen video type prefers to degrade FrameRate. A Camera video type prefers to degrade Resolution. An unknown video type prefers a Balanced approach.
    Balanced: Prefers to degrade both FrameRate and Resolution together in smaller increments.
    FrameRate: Prefers to degrade FrameRate instead of Resolution.
    Resolution: Prefers to degrade Resolution instead of FrameRate.

    Parameters:

    Name Type
    value VideoDegradationPreference

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    setVideoSimulcastDisabled

    ▸ setVideoSimulcastDisabled(value: boolean): void

    Sets whether video simulcast is disabled. If true, video simulcast is disabled. If false, video simulcast is enabled.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    setVideoSimulcastEncodingCount

    ▸ setVideoSimulcastEncodingCount(value: number): void

    Sets the maximum number of simulcast encodings that this LocalMedia produces for the video stream. The default value is 2. For LiveSwitch Media Server, the maximum is 4 encodings. This property must be set before the LocalMedia starts.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

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


    setVideoSimulcastPreferredBitrate

    ▸ setVideoSimulcastPreferredBitrate(value: number): void

    Sets the preferred bitrate of a video simulcast in Kbps. The bitrate must be a positive integer.

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:552


    setVideoSourceInput

    ▸ setVideoSourceInput(videoInput: SourceInput): void

    Parameters:

    Name Type
    videoInput SourceInput

    Returns: void

    Implementation of: IInternalLocalMedia

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMedia.ts:238


    start

    ▸ start(): Future<WebRtcLocalMedia>

    Starts media track sources. This method does not take any parameters and executes asynchronously. Call this method when LocalMedia's state is New or Stopped. If you call this method when LocalMedia's state is not New or Stopped, then the Future returned by this method is rejected.

    Returns: Future<WebRtcLocalMedia>

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:565


    stop

    ▸ stop(): Future<WebRtcLocalMedia>

    Stops media track sources. This method does not take any parameters and executes asynchronously. Call this method when LocalMedia has started. If you call this method when LocalMedia has not started, then the Future returned by this method is rejected.

    Returns: Future<WebRtcLocalMedia>

    Implementation of: IInternalLocalMedia

    Inherited from: WebRtcLocalMediaBase

    Defined in: Generated/TypeScript/fm.liveswitch/WebRtcLocalMediaBase.ts:615


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

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


    getDefaultVideoBitsPerPixel

    ▸ StaticgetDefaultVideoBitsPerPixel(): number

    Gets the default bits-per-pixel for video.

    Returns: number

    Inherited from: WebRtcLocalMediaBase

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


    setDefaultVideoBitsPerPixel

    ▸ StaticsetDefaultVideoBitsPerPixel(value: number): void

    Sets the default bits-per-pixel for video.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: WebRtcLocalMediaBase

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

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