Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcRemoteMedia

Hierarchy

  • WebRtcMedia<WebRtcAudioTrack, WebRtcVideoTrack>
    • WebRtcRemoteMedia

Implements

  • IMedia<WebRtcAudioTrack, WebRtcVideoTrack>
  • IMedia<WebRtcAudioTrack, WebRtcVideoTrack>
  • IInternalMedia
  • IRemoteMedia<WebRtcAudioTrack, WebRtcVideoTrack>
  • IInternalRemoteMedia

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • external: IExternalRemoteMedia

    Returns WebRtcRemoteMedia

Properties

Private _audioSinkOutput

_audioSinkOutput: SinkOutput
internal

Private _external

_external: IExternalRemoteMedia
internal

Private _videoSinkOutput

_videoSinkOutput: SinkOutput
internal

Methods

_getExternal

  • _getExternal(): IExternalRemoteMedia
  • internal

    Returns IExternalRemoteMedia

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

Private attachAudioSinkOutput

  • attachAudioSinkOutput(audioSinkOutput: SinkOutput, element: HTMLMediaElement): void

  • Parameters

    • audioSinkOutput: SinkOutput
    • element: HTMLMediaElement

    Returns void

changeAudioSinkOutput

  • changeAudioSinkOutput(audioInput: SinkOutput): Future<Object>

  • Parameters

    • audioInput: SinkOutput

    Returns Future<Object>

changeVideoSinkOutput

  • changeVideoSinkOutput(videoInput: SinkOutput): Future<Object>

  • Parameters

    • videoInput: SinkOutput

    Returns Future<Object>

Protected cleanupAudioContext

  • cleanupAudioContext(): void

  • Returns void

destroy

  • destroy(): void

  • Returns void

getAudioGain

  • getAudioGain(): number

  • Returns number

getAudioMuted

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

    Returns boolean

getAudioSinkOutput

  • getAudioSinkOutput(): SinkOutput

  • Returns SinkOutput

getAudioSinkOutputs

  • getAudioSinkOutputs(): Future<SinkOutput[]>

  • Returns Future<SinkOutput[]>

getAudioTrack

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

    Returns WebRtcAudioTrack

getAudioTracks

  • getAudioTracks(): WebRtcAudioTrack[]

  • Returns WebRtcAudioTrack[]

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

Private getSinkOutputs

  • getSinkOutputs(kind: string): Future<SinkOutput[]>

  • Parameters

    • kind: string

    Returns Future<SinkOutput[]>

getTypeString

  • getTypeString(): string

  • Returns string

getVideoMuted

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

    Returns boolean

getVideoSinkOutput

  • getVideoSinkOutput(): SinkOutput

  • Returns SinkOutput

getVideoSinkOutputs

  • getVideoSinkOutputs(): Future<SinkOutput[]>

  • Returns Future<SinkOutput[]>

getVideoSize

  • getVideoSize(): Size

  • Returns Size

getVideoTrack

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

    Returns WebRtcVideoTrack

getVideoTracks

  • getVideoTracks(): WebRtcVideoTrack[]

  • Returns WebRtcVideoTrack[]

getView

  • getView(): HTMLElement

  • Returns HTMLElement

getViewSink

  • getViewSink(): WebRtcDomVideoSink

  • Returns WebRtcDomVideoSink

grabVideoFrame

  • grabVideoFrame(): Future<VideoBuffer>

  • Returns Future<VideoBuffer>

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
  • Sets a value indicating whether the first audio track is muted.

    Parameters

    • value: boolean

    Returns void

setAudioSinkOutput

  • setAudioSinkOutput(audioSinkOutput: SinkOutput): void

  • Parameters

    • audioSinkOutput: SinkOutput

    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
  • Sets a value indicating whether the first video track is muted.

    Parameters

    • value: boolean

    Returns void

setVideoSinkOutput

  • setVideoSinkOutput(videoSinkOutput: SinkOutput): void

  • Parameters

    • videoSinkOutput: SinkOutput

    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.