Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Media

Hierarchy

  • Dynamic
    • Media

Implements

  • IMedia<AudioTrack, VideoTrack>
  • IExternalMedia

Index

Constructors

Methods

Constructors

constructor

Methods

Abstract _getInternal

  • _getInternal(): IInternalMedia
  • internal

    Returns IInternalMedia

addOnAudioDestroyed

  • addOnAudioDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnAudioLevel

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

  • Parameters

    • value: IAction1<number>

    Returns void

addOnVideoDestroyed

  • addOnVideoDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnVideoSize

  • addOnVideoSize(value: IAction1<Size>): void

  • Parameters

    • value: IAction1<Size>

    Returns void

destroy

  • destroy(): void

  • Returns void

Private externalToInternal

  • externalToInternal(external: IExternalMediaTrack): IInternalMediaTrack

  • Parameters

    • external: IExternalMediaTrack

    Returns IInternalMediaTrack

Private externalsToInternals

  • externalsToInternals(externals: IExternalMediaTrack[]): IInternalMediaTrack[]

  • Parameters

    • externals: IExternalMediaTrack[]

    Returns IInternalMediaTrack[]

getAudioGain

  • getAudioGain(): number

  • Returns number

getAudioMuted

  • getAudioMuted(): boolean

  • Returns boolean

getAudioTrack

  • getAudioTrack(): AudioTrack

  • Returns AudioTrack

getAudioTracks

  • getAudioTracks(): AudioTrack[]

  • Returns AudioTrack[]

getAudioVolume

  • getAudioVolume(): number

  • 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

  • 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

  • Returns boolean

getVideoSize

  • getVideoSize(): Size

  • Returns Size

getVideoTrack

  • getVideoTrack(): VideoTrack

  • Returns VideoTrack

getVideoTracks

  • getVideoTracks(): VideoTrack[]

  • Returns VideoTrack[]

getView

  • getView(): HTMLElement

  • Returns HTMLElement

getViewSink

  • getViewSink(): DomVideoSink

  • Returns DomVideoSink

grabVideoFrame

  • grabVideoFrame(): Future<VideoBuffer>

  • Returns Future<VideoBuffer>

Private internalToExternal

  • internalToExternal(internal: IInternalMediaTrack): IExternalMediaTrack

  • Parameters

    • internal: IInternalMediaTrack

    Returns IExternalMediaTrack

Private internalsToExternals

  • internalsToExternals(internals: IInternalMediaTrack[]): IExternalMediaTrack[]

  • Parameters

    • internals: IInternalMediaTrack[]

    Returns IExternalMediaTrack[]

removeOnAudioDestroyed

  • removeOnAudioDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnAudioLevel

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

  • Parameters

    • value: IAction1<number>

    Returns void

removeOnVideoDestroyed

  • removeOnVideoDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnVideoSize

  • removeOnVideoSize(value: IAction1<Size>): void

  • Parameters

    • value: IAction1<Size>

    Returns void

setAudioGain

  • setAudioGain(value: number): void

  • Parameters

    • value: number

    Returns void

setAudioMuted

  • setAudioMuted(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setAudioVolume

  • setAudioVolume(value: number): void

  • 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

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