AudioInputTest | @twilio/rtc-diagnostics

AudioInputTest class that parses options and starts an audio input device test.

Please see testAudioInputDevice for details and recommended practices.

Hierarchy

EventEmitter
- AudioInputTest

Index

Enumerations

Events

Interfaces

Constructors

constructor

Events

Properties

Methods

Constructors

constructor

new AudioInputTest(options?: Options): AudioInputTest

- Defined in lib/AudioInputTest.ts:232
Initializes the startTime and options.

Parameters
- Optional options: Options
  
  Optional settings to pass to the test.
Returns AudioInputTest

Events

on

on(event: End, listener: function): this
on(event: Error, listener: function): this
on(event: Volume, listener: function): this
on(event: Warning, listener: function): this
on(event: WarningCleared, listener: function): this

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

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

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

Parameters
- event: Error
  
  AudioInputTest.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 AudioInputTest instance.
Overrides EventEmitter.on
- Defined in lib/AudioInputTest.ts:117
Raised by the test every Options.volumeEventIntervalMs amount of milliseconds with a parameter of type number that represents the current volume of the audio stream.

Parameters
- event: Volume
  
  AudioInputTest.Events.Volume
- listener: function
  
  A callback that expects the following parameters: A number that represents the audio source's current volume.
  - - (value: number): any
    - Parameters
      - value: number
      Returns any
Returns this

This AudioInputTest instance.
Overrides EventEmitter.on
- Defined in lib/AudioInputTest.ts:130
Raised by the test when the test encounters a non-fatal warning during its run-time.

Parameters
- event: Warning
  
  AudioInputTest.Events.Warning
- listener: function
  
  A callback that expects the following parameters: A WarningName.
  - - (warningName: WarningName): any
    - Parameters
      - warningName: WarningName
      Returns any
Returns this

This AudioInputTest instance.
Overrides EventEmitter.on
- Defined in lib/AudioInputTest.ts:143
Raised by the test when the test clears a previously encountered non-fatal warning during its run-time.

Parameters
- event: WarningCleared
  
  AudioInputTest.Events.WarningCleared
- listener: function
  
  A callback that expects the following parameters: A WarningName name.
  - - (warningName: WarningName): any
    - Parameters
      - warningName: WarningName
      Returns any
Returns this

This AudioInputTest instance.

Properties

activeWarnings

activeWarnings: Set<WarningName> = new Set()

Active warnings to keep track of.

Static defaultMaxListeners

defaultMaxListeners: number

Static testName

testName: string = "audio-input-test"

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
emit(event: Volume, value: number): boolean
emit(event: Warning, warning: WarningName): boolean
emit(event: WarningCleared, warning: WarningName): boolean

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

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

Parameters
- event: Error
  
  AudioInputTest.Events.Error
- error: DiagnosticError
  
  The DiagnosticError that was encountered.
Returns boolean
Overrides MediaConnectionBitrateTest.emit
- Defined in lib/AudioInputTest.ts:55
This event is emitted with a volume level every AudioInputTest.Options.volumeEventIntervalMs after the test starts succesfully.

Parameters
- event: Volume
  
  AudioInputTest.Events.Volume
- value: number
  
  The current volume of the audio source.
Returns boolean
Overrides MediaConnectionBitrateTest.emit
- Defined in lib/AudioInputTest.ts:66
This event is emitted when the test encounters a non-fatal warning during its run-time.

Parameters
- event: Warning
  
  AudioInputTest.Events.Warning
- warning: WarningName
  
  The warning that the test encountered.
Returns boolean
Overrides MediaConnectionBitrateTest.emit
- Defined in lib/AudioInputTest.ts:77
This event is emitted when the test clears a previously encountered non-fatal warning during its run-time.

Parameters
- event: WarningCleared
  
  AudioInputTest.Events.WarningCleared
- warning: WarningName
  
  The warning that the test encountered that should be cleared.
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/AudioInputTest.ts:251
Stop the currently running AudioInputTest.

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

Hierarchy

Index

Enumerations

Interfaces

Constructors

Events

Properties

Methods

Constructors

constructor

Parameters

Optional options: Options

Returns AudioInputTest

Events

on

Parameters

event: End

listener: function

Parameters

report: Report

Returns any

Returns this

Parameters

event: Error

listener: function

Parameters

error: DiagnosticError

Returns any

Returns this

Parameters

event: Volume

listener: function

Parameters

value: number

Returns any

Returns this

Parameters

event: Warning

listener: function

Parameters

warningName: WarningName

Returns any

Returns this

Parameters

event: WarningCleared

listener: function

Parameters

warningName: WarningName

Returns any

Returns this

Properties

activeWarnings

Static defaultMaxListeners

Static testName

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Private emit

Parameters

event: End

report: Report

Returns boolean

Parameters

event: Error

error: DiagnosticError

Returns boolean

Parameters

event: Volume

value: number

Returns boolean

Parameters

event: Warning

warning: WarningName

Returns boolean