Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginLocalMedia

Hierarchy

  • PluginMedia
    • PluginLocalMedia

Implements

  • IMedia<PluginAudioTrack, PluginVideoTrack>
  • IInternalMedia
  • ILocalMedia<PluginLocalMedia, PluginAudioTrack, PluginVideoTrack>
  • IInternalLocalMedia

Index

Constructors

constructor

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

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

    Returns PluginLocalMedia

Properties

Private _audio

_audio: any
internal

Private _axo

_axo: LocalMediaActiveXObject
internal

Private _external

_external: IExternalLocalMedia
internal

Private _onAudioDestroyedValues

_onAudioDestroyedValues: IAction0[] = []
internal

Private _onAudioStartedValues

_onAudioStartedValues: IAction0[] = []
internal

Private _onAudioStoppedValues

_onAudioStoppedValues: IAction0[] = []
internal

Private _onVideoDestroyedValues

_onVideoDestroyedValues: IAction0[] = []
internal

Private _onVideoStartedValues

_onVideoStartedValues: IAction0[] = []
internal

Private _onVideoStoppedValues

_onVideoStoppedValues: IAction0[] = []
internal

Private _screen

_screen: boolean
internal

Private _video

_video: any
internal

Protected _videoSink

_videoSink: PluginDomVideoSink

Private unloadHandler

unloadHandler: function
internal

Type declaration

    • (evt: any): void
    • Parameters

      • evt: any

      Returns void

Methods

Protected _getAxo

  • _getAxo(): LocalMediaActiveXObject
  • internal

    Returns LocalMediaActiveXObject

_getExternal

  • _getExternal(): IExternalLocalMedia
  • internal

    Returns IExternalLocalMedia

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

changeAudioSourceInput

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

    • audioSourceInput: SourceInput

    Returns Future<Object>

changeVideoSourceInput

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

    • videoSourceInput: SourceInput

    Returns Future<Object>

Private checkifLoaded

  • checkifLoaded(object: LocalMediaActiveXObject): void
  • Parameters

    • object: LocalMediaActiveXObject

    Returns void

destroy

  • destroy(): void
  • Returns void

getAudio

  • getAudio(): any
  • Returns any

getAudioGain

  • getAudioGain(): number
  • Returns number

getAudioMuted

  • getAudioMuted(): boolean
  • Returns boolean

getAudioSourceInput

  • getAudioSourceInput(): SourceInput
  • Returns SourceInput

getAudioSourceInputs

  • getAudioSourceInputs(): Future<SourceInput[]>
  • Returns Future<SourceInput[]>

getAudioTrack

  • getAudioTrack(): PluginAudioTrack
  • Returns PluginAudioTrack

getAudioTracks

  • getAudioTracks(): PluginAudioTrack[]
  • Returns PluginAudioTrack[]

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.

getHandle

  • getHandle(): number
  • Returns number

getId

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

getState

  • getState(): LocalMediaState
  • Returns LocalMediaState

getTypeString

  • getTypeString(): string
  • Returns string

getVideo

  • getVideo(): any
  • Returns any

getVideoMuted

  • getVideoMuted(): boolean
  • Returns boolean

getVideoSize

  • getVideoSize(): Size
  • Returns Size

getVideoSourceInput

  • getVideoSourceInput(): SourceInput
  • Returns SourceInput

getVideoSourceInputs

  • getVideoSourceInputs(): Future<SourceInput[]>
  • Returns Future<SourceInput[]>

getVideoTrack

  • getVideoTrack(): PluginVideoTrack
  • Returns PluginVideoTrack

getVideoTracks

  • getVideoTracks(): PluginVideoTrack[]
  • Returns PluginVideoTrack[]

getView

  • getView(): HTMLElement
  • Returns HTMLElement

getViewSink

  • getViewSink(): PluginDomVideoSink
  • Returns PluginDomVideoSink

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

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

    • value: boolean

    Returns void

setVideoSourceInput

  • setVideoSourceInput(value: SourceInput): void
  • Parameters

    • value: SourceInput

    Returns void

start

  • start(): Future<PluginLocalMedia>
  • Returns Future<PluginLocalMedia>

stop

  • stop(): Future<PluginLocalMedia>
  • Returns Future<PluginLocalMedia>

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.