Search Results for

    / fm / liveswitch / AudioTrack

    Class: AudioTrack

    fm.liveswitch.AudioTrack

    Hierarchy

    • MediaTrack

      ↳ AudioTrack

    Implements

    • IAudioTrack
    • IExternalAudioTrack

    Table of contents

    Constructors

    • constructor

    Methods

    • addOnDestroyed
    • addOnLevel
    • addOnMuted
    • addOnStarted
    • addOnStopped
    • addOnUnmuted
    • changeSinkOutput
    • changeSourceInput
    • destroy
    • getDynamicProperties
    • getDynamicValue
    • getGain
    • getLevelInterval
    • getMedia
    • getMuted
    • getSinkOutput
    • getSinkOutputs
    • getSourceInput
    • getSourceInputs
    • getTypeString
    • getVolume
    • removeOnDestroyed
    • removeOnLevel
    • removeOnMuted
    • removeOnStarted
    • removeOnStopped
    • removeOnUnmuted
    • setDynamicValue
    • setGain
    • setLevelInterval
    • setMuted
    • setSinkOutput
    • setSourceInput
    • setVolume
    • unsetDynamicValue

    Constructors

    constructor

    + new AudioTrack(media: Media, internalMedia?: IInternalMedia): AudioTrack

    Parameters:

    Name Type
    media Media
    internalMedia? IInternalMedia

    Returns: AudioTrack

    Inherited from: MediaTrack

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

    Methods

    addOnDestroyed

    ▸ addOnDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    addOnLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IExternalAudioTrack

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


    addOnMuted

    ▸ addOnMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    addOnStarted

    ▸ addOnStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    addOnStopped

    ▸ addOnStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    addOnUnmuted

    ▸ addOnUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    changeSinkOutput

    ▸ changeSinkOutput(sinkOutput: SinkOutput): Future<Object>

    Parameters:

    Name Type
    sinkOutput SinkOutput

    Returns: Future<Object>

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:53


    changeSourceInput

    ▸ changeSourceInput(sourceInput: SourceInput): Future<Object>

    Parameters:

    Name Type
    sourceInput SourceInput

    Returns: Future<Object>

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    destroy

    ▸ destroy(): boolean

    Returns: boolean

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: MediaTrack

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

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


    getGain

    ▸ getGain(): number

    Returns: number

    Implementation of: IExternalAudioTrack

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


    getLevelInterval

    ▸ getLevelInterval(): number

    Returns: number

    Implementation of: IExternalAudioTrack

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


    getMedia

    ▸ getMedia(): Media

    Returns: Media

    Inherited from: MediaTrack

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


    getMuted

    ▸ getMuted(): boolean

    Returns: boolean

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    getSinkOutput

    ▸ getSinkOutput(): SinkOutput

    Returns: SinkOutput

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    getSinkOutputs

    ▸ getSinkOutputs(): Future<SinkOutput[]>

    Returns: Future<SinkOutput[]>

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    getSourceInput

    ▸ getSourceInput(): SourceInput

    Returns: SourceInput

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:71


    getSourceInputs

    ▸ getSourceInputs(): Future<SourceInput[]>

    Returns: Future<SourceInput[]>

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:74


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: MediaTrack

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


    getVolume

    ▸ getVolume(): number

    Returns: number

    Implementation of: IExternalAudioTrack

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


    removeOnDestroyed

    ▸ removeOnDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    removeOnLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IExternalAudioTrack

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


    removeOnMuted

    ▸ removeOnMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    removeOnStarted

    ▸ removeOnStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    removeOnStopped

    ▸ removeOnStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


    removeOnUnmuted

    ▸ removeOnUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

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


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

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


    setGain

    ▸ setGain(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalAudioTrack

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


    setLevelInterval

    ▸ setLevelInterval(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalAudioTrack

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


    setMuted

    ▸ setMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:77


    setSinkOutput

    ▸ setSinkOutput(value: SinkOutput): void

    Parameters:

    Name Type
    value SinkOutput

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:80


    setSourceInput

    ▸ setSourceInput(value: SourceInput): void

    Parameters:

    Name Type
    value SourceInput

    Returns: void

    Implementation of: IExternalAudioTrack

    Inherited from: MediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/MediaTrack.ts:83


    setVolume

    ▸ setVolume(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IExternalAudioTrack

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


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

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

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