Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcMediaTrackBase

Media track base properties/methods.

Hierarchy

  • Dynamic
    • WebRtcMediaTrackBase

Implements

  • IMediaTrack

Index

Constructors

constructor

Methods

Abstract addOnDestroyed

  • addOnDestroyed(value: IAction0): void
  • Adds a handler that is raised when the track is destroyed.

    Parameters

    • value: IAction0

    Returns void

Abstract addOnStarted

  • addOnStarted(value: IAction0): void
  • Adds a handler that is raised when the track is started. Only applicable for local media tracks.

    Parameters

    • value: IAction0

    Returns void

Abstract addOnStopped

  • addOnStopped(value: IAction0): void
  • Adds a handler that is raised when the track is stopped. Only applicable for local media tracks.

    Parameters

    • value: IAction0

    Returns void

Abstract changeSinkOutput

  • changeSinkOutput(sinkOutput: SinkOutput): Future<Object>
  • Changes the sink output while the media track is active.

    Parameters

    • sinkOutput: SinkOutput

      The sink output.

    Returns Future<Object>

Abstract changeSourceInput

  • changeSourceInput(sourceInput: SourceInput): Future<Object>
  • Changes the source input while the media track is active.

    Parameters

    • sourceInput: SourceInput

      The source input.

    Returns Future<Object>

Abstract destroy

  • destroy(): boolean
  • Destroys this media track.

    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.

getIsDirty

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

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

Abstract getMuted

  • getMuted(): boolean
  • Gets a value indicating whether this track is muted.

    Returns boolean

getSerialized

  • getSerialized(): string

Abstract getSinkOutput

  • getSinkOutput(): SinkOutput
  • Gets the current sink output.

    Returns SinkOutput

Abstract getSinkOutputs

  • getSinkOutputs(): Future<SinkOutput[]>
  • Gets the available sink outputs.

    Returns Future<SinkOutput[]>

    A future with an array of sink outputs.

Abstract getSourceInput

  • getSourceInput(): SourceInput
  • Gets the current source input.

    Returns SourceInput

Abstract getSourceInputs

  • getSourceInputs(): Future<SourceInput[]>
  • Gets the available source inputs.

    Returns Future<SourceInput[]>

    A future with an array of source inputs.

getTypeString

  • getTypeString(): string

Abstract removeOnDestroyed

  • removeOnDestroyed(value: IAction0): void
  • Removes a handler that is raised when the track is destroyed.

    Parameters

    • value: IAction0

    Returns void

Abstract removeOnStarted

  • removeOnStarted(value: IAction0): void
  • Removes a handler that is raised when the track is started. Only applicable for local media tracks.

    Parameters

    • value: IAction0

    Returns void

Abstract removeOnStopped

  • removeOnStopped(value: IAction0): void
  • Removes a handler that is raised when the track is stopped. Only applicable for local media tracks.

    Parameters

    • value: IAction0

    Returns 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

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

Abstract setMuted

  • setMuted(value: boolean): void
  • Sets a value indicating whether this track is muted.

    Parameters

    • value: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Abstract setSinkOutput

  • setSinkOutput(value: SinkOutput): void
  • Sets the current sink output.

    Parameters

    • value: SinkOutput

    Returns void

Abstract setSourceInput

  • setSourceInput(value: SourceInput): void
  • Sets the current source input.

    Parameters

    • value: SourceInput

    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.