Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcDomVideoSink

Hierarchy

  • Dynamic
    • WebRtcDomVideoSink

Implements

  • IInternalDomVideoSink

Index

Constructors

constructor

  • new WebRtcDomVideoSink(external: IExternalDomVideoSink, track: WebRtcVideoTrack): WebRtcDomVideoSink

Properties

Private _container

_container: HTMLElement
internal

Private _external

_external: IExternalDomVideoSink
internal

Private _local

_local: boolean
internal

Private _track

_track: WebRtcVideoTrack
internal

Private _video

_video: HTMLVideoElement
internal

Private _viewMirror

_viewMirror: boolean
internal

Private _viewScale

_viewScale: LayoutScale
internal

Methods

_getExternal

  • _getExternal(): IExternalDomVideoSink
  • internal

    Returns IExternalDomVideoSink

Private applyScale

  • applyScale(scale: LayoutScale): void
  • Parameters

    • scale: LayoutScale

    Returns void

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

getLocal

  • getLocal(): boolean
  • Returns boolean

getMuted

  • getMuted(): boolean
  • Returns boolean

getSerialized

  • getSerialized(): string

getTrack

  • getTrack(): WebRtcVideoTrack
  • Returns WebRtcVideoTrack

getTypeString

  • getTypeString(): string

getVideo

  • getVideo(): HTMLVideoElement
  • Returns HTMLVideoElement

getVideoHeight

  • getVideoHeight(): number
  • Returns number

getVideoWidth

  • getVideoWidth(): number
  • Returns number

getView

  • getView(): HTMLElement
  • Returns HTMLElement

getViewMirror

  • getViewMirror(): boolean
  • Returns boolean

getViewScale

  • getViewScale(): LayoutScale
  • Returns LayoutScale

getVolume

  • getVolume(): number
  • Returns number

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

setMuted

  • setMuted(muted: boolean): void
  • Parameters

    • muted: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTrack

  • setTrack(track: WebRtcVideoTrack): boolean
  • Parameters

    • track: WebRtcVideoTrack

    Returns boolean

setViewMirror

  • setViewMirror(viewMirror: boolean): void
  • Parameters

    • viewMirror: boolean

    Returns void

setViewScale

  • setViewScale(viewScale: LayoutScale): void
  • Parameters

    • viewScale: LayoutScale

    Returns void

setVolume

  • setVolume(volume: number): void
  • Parameters

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