Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalMedia

Hierarchy

  • Media
    • LocalMedia

Implements

  • IMedia<AudioTrack, VideoTrack>
  • IExternalMedia
  • ILocalMedia<LocalMedia, AudioTrack, VideoTrack>
  • IExternalLocalMedia

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LocalMedia(audio: any, video: any, screen?: boolean): LocalMedia

  • Parameters

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

    Returns LocalMedia

Properties

Private _internal

_internal: IInternalLocalMedia

Methods

_getInternal

  • _getInternal(): IInternalLocalMedia
  • internal

    Returns IInternalLocalMedia

addOnAudioDestroyed

  • addOnAudioDestroyed(value: IAction0): 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

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

changeAudioInput

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

  • Parameters

    • audioInput: SourceInput

    Returns Future<Object>

changeAudioSourceInput

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

  • Parameters

    • audioSourceInput: SourceInput

    Returns Future<Object>

changeVideoInput

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

  • Parameters

    • videoInput: SourceInput

    Returns Future<Object>

changeVideoSourceInput

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

  • Parameters

    • videoSourceInput: SourceInput

    Returns Future<Object>

destroy

  • destroy(): void

  • Returns void

getAudioGain

  • getAudioGain(): number

getAudioInput

  • getAudioInput(): SourceInput

  • Returns SourceInput

getAudioInputs

  • getAudioInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

getAudioMuted

  • getAudioMuted(): boolean

getAudioSourceInput

  • getAudioSourceInput(): SourceInput

  • Returns SourceInput

getAudioSourceInputs

  • getAudioSourceInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

getAudioTrack

  • getAudioTrack(): AudioTrack

getAudioTracks

  • getAudioTracks(): AudioTrack[]

getAudioVolume

  • getAudioVolume(): 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

getState

  • getState(): LocalMediaState

  • Returns LocalMediaState

getTypeString

  • getTypeString(): string

getVideoInput

  • getVideoInput(): SourceInput

  • Returns SourceInput

getVideoInputs

  • getVideoInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

getVideoMuted

  • getVideoMuted(): boolean

getVideoSize

  • getVideoSize(): Size

getVideoSourceInput

  • getVideoSourceInput(): SourceInput

  • Returns SourceInput

getVideoSourceInputs

  • getVideoSourceInputs(): Future<SourceInput[]>

  • Returns Future<SourceInput[]>

getVideoTrack

  • getVideoTrack(): VideoTrack

getVideoTracks

  • getVideoTracks(): VideoTrack[]

getView

  • getView(): HTMLElement

  • Returns HTMLElement

getViewSink

  • getViewSink(): DomVideoSink

  • Returns DomVideoSink

grabVideoFrame

  • grabVideoFrame(): Future<VideoBuffer>

  • Returns Future<VideoBuffer>

removeOnAudioDestroyed

  • removeOnAudioDestroyed(value: IAction0): 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

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

setAudioGain

  • setAudioGain(value: number): void

  • Parameters

    • value: number

    Returns void

setAudioInput

  • setAudioInput(audioInput: SourceInput): void

  • Parameters

    • audioInput: SourceInput

    Returns void

setAudioMuted

  • setAudioMuted(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setAudioSourceInput

  • setAudioSourceInput(value: SourceInput): void

  • Parameters

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

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setVideoInput

  • setVideoInput(videoInput: SourceInput): void

  • Parameters

    • videoInput: SourceInput

    Returns void

setVideoMuted

  • setVideoMuted(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setVideoSourceInput

  • setVideoSourceInput(value: SourceInput): void

  • Parameters

    • value: SourceInput

    Returns void

start

  • start(): Future<LocalMedia>

  • Returns Future<LocalMedia>

stop

  • stop(): Future<LocalMedia>

  • Returns Future<LocalMedia>

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

  • Returns string

Static getChromeExtensionInstalled

  • getChromeExtensionInstalled(): boolean

  • Returns boolean

Static getChromeExtensionRequiresUserGesture

  • getChromeExtensionRequiresUserGesture(): boolean

  • Returns boolean

Static getChromeExtensionUrl

  • getChromeExtensionUrl(): string

  • Returns string

Static setChromeExtensionId

  • setChromeExtensionId(chromeExtensionId: string): void

  • Parameters

    • chromeExtensionId: string

    Returns void

Static setChromeExtensionRequiresUserGesture

  • setChromeExtensionRequiresUserGesture(chromeExtensionRequiresUserGesture: boolean): void

  • Parameters

    • chromeExtensionRequiresUserGesture: boolean

    Returns void