Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReceiveAudioInputTask

ReceiveAudioInputTask acquires an audio input.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected logger

logger: Logger

Protected taskName

taskName: string = 'ReceiveAudioInputTask'

Methods

cancel

  • cancel(): void

  • Attempts to cancel the task. The task may still succeed if it is unable to be canceled. If the task is canceled, then its run function will reject the promise. If cancel is called before run, then run must immediately reject the returned promise. If cancel is called after run, then nothing happens.

    Returns void

Protected getStatus

Protected logAndThrow

  • logAndThrow(message: string): void

name

  • name(): string

once

run

  • run(): Promise<void>

  • Runs the unit of work until it either succeeds and fulfills the promise or fails and rejects the promise. Where possible it should listen for the cancellation signal, stop working, and reject the promise. If run is called more than once, it should immediately reject the promise.

    Returns Promise<void>

setParent

  • setParent(parentTask: Task): void

Generated using TypeDoc