Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcLocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack>

A collection of local audio/video track base methods.

Type parameters

  • TLocalMedia: WebRtcLocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack>

  • TAudioTrack: WebRtcAudioTrack

  • TVideoTrack: WebRtcVideoTrack

Hierarchy

  • WebRtcMedia<TAudioTrack, TVideoTrack>
    • WebRtcLocalMediaBase

Implements

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

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.localMediaBase class.

    Parameters

    • external: Object

      The external.

    Returns WebRtcLocalMediaBase

Properties

Private __stateLock

__stateLock: Object
internal

Private _state

_state: LocalMediaState
internal

Methods

Protected abortStart

  • abortStart(promise: Promise<TLocalMedia>, exception: Exception): void
  • Aborts the start.

    Parameters

    • promise: Promise<TLocalMedia>

      The promise.

    • exception: Exception

      The exception.

    Returns void

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

Protected cleanupAudioContext

  • cleanupAudioContext(): void

  • Returns void

destroy

  • destroy(): void

  • Returns void

Protected Abstract doStart

  • doStart(): Future<TLocalMedia>
  • Starts the local media.

    Returns Future<TLocalMedia>

Protected Abstract doStop

  • doStop(): Future<TLocalMedia>
  • Stops the local media.

    Returns Future<TLocalMedia>

getAudioGain

  • getAudioGain(): number

  • Returns number

getAudioMuted

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

    Returns boolean

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

getState

  • getState(): LocalMediaState
  • Gets the state.

    Returns LocalMediaState

getTypeString

  • getTypeString(): string

  • Returns string

getVideoMuted

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

    Returns boolean

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

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

Private setState

  • setState(value: LocalMediaState): void
  • internal

    Parameters

    • value: LocalMediaState

    Returns void

setVideoMuted

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

    Parameters

    • value: boolean

    Returns void

start

  • start(): Future<TLocalMedia>
  • Starts the media track sources.

    Returns Future<TLocalMedia>

Private startInternal

  • startInternal(promise: Promise<TLocalMedia>): Future<TLocalMedia>
  • internal

    Parameters

    • promise: Promise<TLocalMedia>

    Returns Future<TLocalMedia>

stop

  • stop(): Future<TLocalMedia>
  • Stops the media track sources.

    Returns Future<TLocalMedia>

Private stopInternal

  • stopInternal(promise: Promise<TLocalMedia>): Future<TLocalMedia>
  • internal

    Parameters

    • promise: Promise<TLocalMedia>

    Returns Future<TLocalMedia>

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.