Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcLocalMedia

Hierarchy

  • WebRtcLocalMediaBase<WebRtcLocalMedia, WebRtcAudioTrack, WebRtcVideoTrack>
    • WebRtcLocalMedia

Implements

  • IMedia<WebRtcAudioTrack, WebRtcVideoTrack>
  • IMedia<WebRtcAudioTrack, WebRtcVideoTrack>
  • IInternalMedia
  • ILocalMedia<WebRtcLocalMedia, WebRtcAudioTrack, WebRtcVideoTrack>
  • IInternalLocalMedia

Index

Constructors

Properties

Methods

Constructors

constructor

  • new WebRtcLocalMedia(external: IExternalLocalMedia, audio: any, video: any, screen?: boolean): WebRtcLocalMedia

  • Parameters

    • external: IExternalLocalMedia
    • audio: any
    • video: any
    • Optional screen: boolean

    Returns WebRtcLocalMedia

Properties

Private _audio

_audio: any
internal

Private _audioConstraints

_audioConstraints: MediaTrackConstraints
internal

Private _audioInput

_audioInput: SourceInput

Private _chromeScreenEventListener

_chromeScreenEventListener: function
internal

Type declaration

    • (ev: MessageEvent): any

    • Parameters

      • ev: MessageEvent

      Returns any

Private _chromeScreenStreamId

_chromeScreenStreamId: number
internal

Private _external

_external: IExternalLocalMedia
internal

Private _onAudioStartedValues

_onAudioStartedValues: IAction0[] = []
internal

Private _onAudioStoppedValues

_onAudioStoppedValues: IAction0[] = []
internal

Private _onVideoStartedValues

_onVideoStartedValues: IAction0[] = []
internal

Private _onVideoStoppedValues

_onVideoStoppedValues: IAction0[] = []
internal

Private _screen

_screen: boolean
internal

Private _video

_video: any
internal

Private _videoConstraints

_videoConstraints: MediaTrackConstraints
internal

Private _videoInput

_videoInput: SourceInput

Static Private __webRtcLocalMediaInitialized

__webRtcLocalMediaInitialized: boolean = false
internal

Static Private _chromeExtensionId

_chromeExtensionId: string
internal

Static Private _chromeExtensionInstalled

_chromeExtensionInstalled: boolean
internal

Static Private _chromeExtensionRequiresUserGesture

_chromeExtensionRequiresUserGesture: boolean
internal

Static Private _chromeExtensionUrl

_chromeExtensionUrl: string
internal

Methods

_getExternal

  • _getExternal(): IExternalLocalMedia
  • internal

    Returns IExternalLocalMedia

Protected abortStart

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

    Parameters

    • promise: Promise<WebRtcLocalMedia>

      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

addOnAudioStarted

  • addOnAudioStarted(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnAudioStopped

  • addOnAudioStopped(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnVideoDestroyed

  • addOnVideoDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnVideoSize

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

  • Parameters

    • value: IAction1<Size>

    Returns void

addOnVideoStarted

  • addOnVideoStarted(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnVideoStopped

  • addOnVideoStopped(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

changeAudioConstraints

  • changeAudioConstraints(audioConstraints: MediaTrackConstraints): Future<Object>

  • Parameters

    • audioConstraints: MediaTrackConstraints

    Returns Future<Object>

changeAudioSourceInput

  • changeAudioSourceInput(audioInput: SourceInput): Future<Object>

  • Parameters

    • audioInput: SourceInput

    Returns Future<Object>

changeVideoConstraints

  • changeVideoConstraints(videoConstraints: MediaTrackConstraints): Future<Object>

  • Parameters

    • videoConstraints: MediaTrackConstraints

    Returns Future<Object>

changeVideoSourceInput

  • changeVideoSourceInput(videoInput: SourceInput): Future<Object>

  • Parameters

    • videoInput: SourceInput

    Returns Future<Object>

Protected cleanupAudioContext

  • cleanupAudioContext(): void

  • Returns void

destroy

  • destroy(): void

  • Returns void

doStart

  • doStart(): Future<WebRtcLocalMedia>

  • Returns Future<WebRtcLocalMedia>

Private doStartInternal

  • doStartInternal(promise: Promise<WebRtcLocalMedia>, deprecated?: boolean): void

  • Parameters

    • promise: Promise<WebRtcLocalMedia>
    • Optional deprecated: boolean

    Returns void

doStop

  • doStop(): Future<WebRtcLocalMedia>

  • Returns Future<WebRtcLocalMedia>

getAudio

  • getAudio(): any

  • Returns any

getAudioConstraints

  • getAudioConstraints(): MediaTrackConstraints

  • Returns MediaTrackConstraints

getAudioGain

  • getAudioGain(): number

  • Returns number

getAudioMuted

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

    Returns boolean

getAudioSourceInput

  • getAudioSourceInput(): SourceInput

  • Returns SourceInput

getAudioSourceInputs

  • getAudioSourceInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

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

getScreen

  • getScreen(): boolean

  • Returns boolean

getSerialized

  • getSerialized(): string

Private getSourceInputs

  • getSourceInputs(kind: string): Future<SourceInput[]>

  • Parameters

    • kind: string

    Returns Future<SourceInput[]>

getState

  • getState(): LocalMediaState
  • Gets the state.

    Returns LocalMediaState

getTypeString

  • getTypeString(): string

  • Returns string

getVideo

  • getVideo(): any

  • Returns any

getVideoConstraints

  • getVideoConstraints(): MediaTrackConstraints

  • Returns MediaTrackConstraints

getVideoMuted

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

    Returns boolean

getVideoSize

  • getVideoSize(): Size

  • Returns Size

getVideoSourceInput

  • getVideoSourceInput(): SourceInput

  • Returns SourceInput

getVideoSourceInputs

  • getVideoSourceInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

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

removeOnAudioStarted

  • removeOnAudioStarted(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnAudioStopped

  • removeOnAudioStopped(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnVideoDestroyed

  • removeOnVideoDestroyed(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnVideoSize

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

  • Parameters

    • value: IAction1<Size>

    Returns void

removeOnVideoStarted

  • removeOnVideoStarted(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnVideoStopped

  • removeOnVideoStopped(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

setAudio

  • setAudio(audio: any): void

  • Parameters

    • audio: any

    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

setAudioSourceInput

  • setAudioSourceInput(audioInput: SourceInput): void

  • Parameters

    • audioInput: SourceInput

    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

setScreen

  • setScreen(screen: boolean): void

  • Parameters

    • screen: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setVideo

  • setVideo(video: any): void

  • Parameters

    • video: any

    Returns void

setVideoMuted

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

    Parameters

    • value: boolean

    Returns void

setVideoSourceInput

  • setVideoSourceInput(videoInput: SourceInput): void

  • Parameters

    • videoInput: SourceInput

    Returns void

start

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

    Returns Future<WebRtcLocalMedia>

stop

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

    Returns Future<WebRtcLocalMedia>

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.

Static getChromeExtensionId

  • getChromeExtensionId(): string
  • internal

    Returns string

Static getChromeExtensionInstalled

  • getChromeExtensionInstalled(): boolean
  • internal

    Returns boolean

Static getChromeExtensionRequiresUserGesture

  • getChromeExtensionRequiresUserGesture(): boolean
  • internal

    Returns boolean

Static getChromeExtensionUrl

  • getChromeExtensionUrl(): string
  • internal

    Returns string

Static setChromeExtensionId

  • setChromeExtensionId(chromeExtensionId: string): void
  • internal

    Parameters

    • chromeExtensionId: string

    Returns void

Static setChromeExtensionRequiresUserGesture

  • setChromeExtensionRequiresUserGesture(chromeExtensionRequiresUserGesture: boolean): void
  • internal

    Parameters

    • chromeExtensionRequiresUserGesture: boolean

    Returns void

Static webRtcLocalMediaInitialize

  • webRtcLocalMediaInitialize(): void
  • internal

    Returns void