Search Results for

    / fm / liveswitch / PluginAudioTrack

    Class: PluginAudioTrack

    fm.liveswitch.PluginAudioTrack

    Hierarchy

    • PluginMediaTrack

      ↳ PluginAudioTrack

    Implements

    • IAudioTrack
    • IInternalAudioTrack

    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
    • isLocal
    • removeOnDestroyed
    • removeOnLevel
    • removeOnMuted
    • removeOnStarted
    • removeOnStopped
    • removeOnUnmuted
    • setDynamicValue
    • setGain
    • setLevelInterval
    • setMuted
    • setSinkOutput
    • setSourceInput
    • setVolume
    • unsetDynamicValue

    Constructors

    constructor

    + new PluginAudioTrack(external: IExternalAudioTrack, media: PluginMedia): PluginAudioTrack

    Parameters:

    Name Type
    external IExternalAudioTrack
    media PluginMedia

    Returns: PluginAudioTrack

    Inherited from: PluginMediaTrack

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

    Methods

    addOnDestroyed

    ▸ addOnDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    addOnLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalAudioTrack

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


    addOnMuted

    ▸ addOnMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    addOnStarted

    ▸ addOnStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    addOnStopped

    ▸ addOnStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    addOnUnmuted

    ▸ addOnUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    changeSinkOutput

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

    Parameters:

    Name Type
    sinkOutput SinkOutput

    Returns: Future<Object>

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:79


    changeSourceInput

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

    Parameters:

    Name Type
    sourceInput SourceInput

    Returns: Future<Object>

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    destroy

    ▸ destroy(): boolean

    Returns: boolean

    Implementation of: IInternalAudioTrack

    Inherited from: PluginMediaTrack

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


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: PluginMediaTrack

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

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


    getGain

    ▸ getGain(): number

    Returns: number

    Implementation of: IInternalAudioTrack

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


    getLevelInterval

    ▸ getLevelInterval(): number

    Returns: number

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:135


    getMedia

    ▸ getMedia(): PluginMedia

    Returns: PluginMedia

    Inherited from: PluginMediaTrack

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


    getMuted

    ▸ getMuted(): boolean

    Returns: boolean

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:138


    getSinkOutput

    ▸ getSinkOutput(): SinkOutput

    Returns: SinkOutput

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    getSinkOutputs

    ▸ getSinkOutputs(): Future<SinkOutput[]>

    Returns: Future<SinkOutput[]>

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:91


    getSourceInput

    ▸ getSourceInput(): SourceInput

    Returns: SourceInput

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    getSourceInputs

    ▸ getSourceInputs(): Future<SourceInput[]>

    Returns: Future<SourceInput[]>

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:116


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: PluginMediaTrack

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


    getVolume

    ▸ getVolume(): number

    Returns: number

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:141


    isLocal

    ▸ PrivateisLocal(): boolean

    Returns: boolean

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


    removeOnDestroyed

    ▸ removeOnDestroyed(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:75


    removeOnLevel

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

    Parameters:

    Name Type
    value IAction1<number>

    Returns: void

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:144


    removeOnMuted

    ▸ removeOnMuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:51


    removeOnStarted

    ▸ removeOnStarted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:63


    removeOnStopped

    ▸ removeOnStopped(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    removeOnUnmuted

    ▸ removeOnUnmuted(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:57


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

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


    setGain

    ▸ setGain(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:147


    setLevelInterval

    ▸ setLevelInterval(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:150


    setMuted

    ▸ setMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:153


    setSinkOutput

    ▸ setSinkOutput(value: SinkOutput): void

    Parameters:

    Name Type
    value SinkOutput

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:97


    setSourceInput

    ▸ setSourceInput(value: SourceInput): void

    Parameters:

    Name Type
    value SourceInput

    Returns: void

    Implementation of: IInternalAudioTrack

    Overrides: PluginMediaTrack

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


    setVolume

    ▸ setVolume(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Implementation of: IInternalAudioTrack

    Defined in: Generated/TypeScript/fm.liveswitch/PluginAudioTrack.ts:156


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

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