Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack>

Local media interface.

Type parameters

  • TLocalMedia

  • TIAudioTrack: IAudioTrack

  • TIVideoTrack: IVideoTrack

Hierarchy

  • IMedia<TIAudioTrack, TIVideoTrack>
    • ILocalMedia

Index

Methods

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>

destroy

  • destroy(): void
  • Returns void

getAudioGain

  • getAudioGain(): number
  • Returns number

getAudioMuted

  • getAudioMuted(): boolean
  • Returns boolean

getAudioSourceInput

  • getAudioSourceInput(): SourceInput
  • Returns SourceInput

getAudioSourceInputs

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

getAudioTrack

  • getAudioTrack(): TIAudioTrack
  • Returns TIAudioTrack

getAudioTracks

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

getAudioVolume

  • getAudioVolume(): number
  • Returns number

getId

  • getId(): string
  • Returns string

getState

  • getState(): LocalMediaState
  • Returns LocalMediaState

getVideoMuted

  • getVideoMuted(): boolean
  • Returns boolean

getVideoSize

  • getVideoSize(): Size
  • Returns Size

getVideoSourceInput

  • getVideoSourceInput(): SourceInput
  • Returns SourceInput

getVideoSourceInputs

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

getVideoTrack

  • getVideoTrack(): TIVideoTrack
  • Returns TIVideoTrack

getVideoTracks

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

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

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

setVideoMuted

  • setVideoMuted(value: boolean): void
  • Parameters

    • value: boolean

    Returns void

setVideoSourceInput

  • setVideoSourceInput(value: SourceInput): void
  • Parameters

    • value: SourceInput

    Returns void

start

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

stop

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