Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioTrack

Hierarchy

  • MediaTrack
    • AudioTrack

Implements

  • IMediaTrack
  • IExternalMediaTrack
  • IAudioTrack
  • IExternalAudioTrack

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • media: Media
    • Optional internalMedia: IInternalMedia

    Returns AudioTrack

Properties

Private _internal

_internal: IInternalAudioTrack
internal

Methods

_getInternal

  • _getInternal(): IInternalAudioTrack
  • internal

    Returns IInternalAudioTrack

addOnDestroyed

  • addOnDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnLevel

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

  • Parameters

    • value: IAction1<number>

    Returns void

addOnStarted

  • addOnStarted(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnStopped

  • addOnStopped(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

changeSinkOutput

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

  • Parameters

    • sinkOutput: SinkOutput

    Returns Future<Object>

changeSourceInput

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

  • Parameters

    • sourceInput: SourceInput

    Returns Future<Object>

destroy

  • destroy(): boolean

  • Returns boolean

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

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

getGain

  • getGain(): number

  • Returns number

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getMedia

  • getMedia(): Media

getMuted

  • getMuted(): boolean

  • Returns boolean

getSerialized

  • getSerialized(): string

getSinkOutput

  • getSinkOutput(): SinkOutput

getSinkOutputs

  • getSinkOutputs(): Future<SinkOutput[]>

getSourceInput

  • getSourceInput(): SourceInput

getSourceInputs

  • getSourceInputs(): Future<SourceInput[]>

getTypeString

  • getTypeString(): string

getVolume

  • getVolume(): number

  • Returns number

removeOnDestroyed

  • removeOnDestroyed(value: IAction0): void

removeOnLevel

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

  • Parameters

    • value: IAction1<number>

    Returns void

removeOnStarted

  • removeOnStarted(value: IAction0): void

removeOnStopped

  • removeOnStopped(value: IAction0): void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • 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

setGain

  • setGain(value: number): void

  • Parameters

    • value: number

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setMuted

  • setMuted(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setSinkOutput

  • setSinkOutput(value: SinkOutput): void

  • Parameters

    • value: SinkOutput

    Returns void

setSourceInput

  • setSourceInput(value: SourceInput): void

  • Parameters

    • value: SourceInput

    Returns void

setVolume

  • setVolume(value: number): void

  • Parameters

    • value: number

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

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