Class VideoInputTest

VideoInputTest class that parses options and starts a video input device test.

Please see testVideoInputDevice for details and recommended practices.

Hierarchy

EventEmitter
- VideoInputTest

Index

Enumerations

Events

Interfaces

Constructors

constructor

Events

on

Properties

Methods

Constructors

constructor

new VideoInputTest(options?: Options): VideoInputTest

- Defined in lib/VideoInputTest.ts:121
Constructor for a VideoInputTest object.

Parameters
- Optional options: Options
  
  Options to be used during the runtime of the test.
Returns VideoInputTest

Events

on

on(event: End, listener: function): this
on(event: Error, listener: function): this

Overrides EventEmitter.on
- Defined in lib/VideoInputTest.ts:54
Raised upon completion of the test.

Parameters
- event: End
  
  VideoInputTest.Events.End
- listener: function
  
  A callback that expects the following parameters: An VideoInputTest.Report that summarizes the test.
  - - (report: Report): any
    - Parameters
      - report: Report
      Returns any
Returns this

This VideoInputTest instance.
Overrides EventEmitter.on
- Defined in lib/VideoInputTest.ts:67
Raised by the test when encountering an error with a parameter of type DiagnosticError.

Parameters
- event: Error
  
  VideoInputTest.Events.Error
- listener: function
  
  A callback that expects the following parameters: A DiagnosticError that the test encountered.
  - - (error: DiagnosticError): any
    - Parameters
      - error: DiagnosticError
      Returns any
Returns this

This VideoInputTest instance.

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static testName

testName: string = "video-input-test"

The name of the test.

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from AudioInputTest.addListener

Overrides EventEmitter.addListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private emit

emit(event: End, report: Report): boolean
emit(event: Error, error: DiagnosticError): boolean

Overrides MediaConnectionBitrateTest.emit
- Defined in lib/VideoInputTest.ts:30
This event is emitted with a test report when the test ends.

Parameters
- event: End
  
  VideoInputTest.Events.End
- report: Report
  
  Summary of the test.
Returns boolean
Overrides MediaConnectionBitrateTest.emit
- Defined in lib/VideoInputTest.ts:41
This event is emitted with a DiagnosticError when the test encounters an error, fatal or not.

Parameters
- event: Error
  
  VideoInputTest.Events.Error
- error: DiagnosticError
  
  The DiagnosticError that was encountered.
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from AudioInputTest.eventNames

Overrides EventEmitter.eventNames
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from AudioInputTest.getMaxListeners

Overrides EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from AudioInputTest.listenerCount

Overrides EventEmitter.listenerCount
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from AudioInputTest.listeners

Overrides EventEmitter.listeners
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from AudioInputTest.off

Overrides EventEmitter.off
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from AudioInputTest.once

Overrides EventEmitter.once
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from AudioInputTest.prependListener

Overrides EventEmitter.prependListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from AudioInputTest.prependOnceListener

Overrides EventEmitter.prependOnceListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from AudioInputTest.rawListeners

Overrides EventEmitter.rawListeners
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from AudioInputTest.removeAllListeners

Overrides EventEmitter.removeAllListeners
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from AudioInputTest.removeListener

Overrides EventEmitter.removeListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from AudioInputTest.setMaxListeners

Overrides EventEmitter.setMaxListeners
Parameters
- n: number
Returns this

stop

stop(): void

- Defined in lib/VideoInputTest.ts:142
Stops the test. Emits a report upon the end of the test.

Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from AudioInputTest.listenerCount
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc