Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcMediaBase<TIAudioTrack, TIVideoTrack>

A collection of audio/video track base methods/properties.

Type parameters

  • TIAudioTrack: IAudioTrack

  • TIVideoTrack: IVideoTrack

Hierarchy

  • Dynamic
    • WebRtcMediaBase

Implements

  • IMedia<TIAudioTrack, TIVideoTrack>

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private __id

__id: string
internal

Methods

Abstract addOnAudioDestroyed

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

    Parameters

    • value: IAction0

    Returns void

Abstract addOnAudioLevel

  • addOnAudioLevel(value: IAction1<number>): void
  • Adds a handler that is raised whenever the level of the first audio track is calculated.

    Parameters

    • value: IAction1<number>

    Returns void

Abstract addOnVideoDestroyed

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

    Parameters

    • value: IAction0

    Returns void

Abstract addOnVideoSize

  • addOnVideoSize(value: IAction1<Size>): void
  • Adds a handler that is raised whenever the size of the first video track is calculated.

    Parameters

    • value: IAction1<Size>

    Returns void

Abstract destroy

  • destroy(): void
  • Destroys this media.

    Returns void

getAudioGain

  • getAudioGain(): number
  • Gets a value indicating the gain (input amplification) of the first audio track.

    Returns number

getAudioMuted

  • getAudioMuted(): boolean
  • Gets a value indicating whether the first audio track is muted.

    Returns boolean

getAudioTrack

  • getAudioTrack(): TIAudioTrack
  • Gets the first audio track.

    Returns TIAudioTrack

Abstract getAudioTracks

  • getAudioTracks(): TIAudioTrack[]
  • Gets the audio tracks.

    Returns TIAudioTrack[]

getAudioVolume

  • getAudioVolume(): number
  • Gets a value indicating the volume (output resistance) of the first audio track.

    Returns number

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.

getId

  • getId(): string
  • Gets the identifier.

    Returns string

getIsDirty

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

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getSerialized

  • getSerialized(): string

getTypeString

  • getTypeString(): string

getVideoMuted

  • getVideoMuted(): boolean
  • Gets a value indicating whether the first video track is muted.

    Returns boolean

Abstract getVideoSize

  • getVideoSize(): Size
  • Gets the size of the first video track.

    Returns Size

getVideoTrack

  • getVideoTrack(): TIVideoTrack
  • Gets the first video track.

    Returns TIVideoTrack

Abstract getVideoTracks

  • getVideoTracks(): TIVideoTrack[]
  • Gets the video tracks.

    Returns TIVideoTrack[]

Abstract grabVideoFrame

  • grabVideoFrame(): Future<VideoBuffer>
  • Grabs a frame from the first video track.

    Returns Future<VideoBuffer>

Abstract removeOnAudioDestroyed

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

    Parameters

    • value: IAction0

    Returns void

Abstract removeOnAudioLevel

  • removeOnAudioLevel(value: IAction1<number>): void
  • Removes a handler that is raised whenever the level of the first audio track is calculated.

    Parameters

    • value: IAction1<number>

    Returns void

Abstract removeOnVideoDestroyed

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

    Parameters

    • value: IAction0

    Returns void

Abstract removeOnVideoSize

  • removeOnVideoSize(value: IAction1<Size>): void
  • Removes a handler that is raised whenever the size of the first video track is calculated.

    Parameters

    • value: IAction1<Size>

    Returns void

setAudioGain

  • setAudioGain(value: number): void
  • Sets a value indicating the gain (input amplification) of the first audio track.

    Parameters

    • value: number

    Returns void

setAudioMuted

  • setAudioMuted(value: boolean): void
  • Sets a value indicating whether the first audio track is muted.

    Parameters

    • value: boolean

    Returns void

setAudioVolume

  • setAudioVolume(value: number): void
  • Sets a value indicating the volume (output resistance) of the first audio track.

    Parameters

    • value: number

    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

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setVideoMuted

  • setVideoMuted(value: boolean): void
  • Sets a value indicating whether the first video track is muted.

    Parameters

    • value: boolean

    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.