Class RtAudio

constructor

• new RtAudio(api?): RtAudio

• Create an RtAudio instance.

  Parameters

  • Optional api: RtAudioApi

    The audio API to use. (Default will be automatically selected)

  Returns RtAudio

outputVolume

streamTime

clearOutputQueue

• clearOutputQueue(): void

• Clears the output stream queue.

  Returns void

closeStream

• closeStream(): void

• A function that closes a stream and frees any associated stream memory.

  Returns void

getApi

• getApi(): string

• Returns the full display name of the current used API.

  Returns string

getDefaultInputDevice

• getDefaultInputDevice(): number

• Returns the id of the default input device.

  Returns number

getDefaultOutputDevice

• getDefaultOutputDevice(): number

• Returns the id of the default output device.

  Returns number

getDevices

• getDevices(): RtAudioDeviceInfo[]

• Returns the list of available devices.

  Returns RtAudioDeviceInfo[]

getStreamLatency

• getStreamLatency(): number

• Returns the internal stream latency in sample frames.

  Returns number

getStreamSampleRate

• getStreamSampleRate(): number

• Returns actual sample rate in use by the stream.

  Returns number

isStreamOpen

• isStreamOpen(): boolean

• Returns true if a stream is open and false if not.

  Returns boolean

isStreamRunning

• isStreamRunning(): boolean

• Returns true if the stream is running and false if it is stopped or not open.

  Returns boolean

openStream

• openStream(outputParameters, inputParameters, format, sampleRate, frameSize, streamName, inputCallback, frameOutputCallback, flags?, errorCallback?): number

• A public function for opening a stream with the specified parameters. Returns the actual frameSize used by the stream, useful if a frameSize of 0 is passed.

  Parameters

  • outputParameters: null | RtAudioStreamParameters

    Specifies output stream parameters to use when opening a stream. For input-only streams, this argument should be null.
  • inputParameters: null | RtAudioStreamParameters

    Specifies input stream parameters to use when opening a stream. For output-only streams, this argument should be null.
  • format: RtAudioFormat

    An RtAudio.Format specifying the desired sample data format.
  • sampleRate: number

    The desired sample rate (sample frames per second).
  • frameSize: number

    The amount of samples per frame. Can be 0 for some APIs, in which case the lowest allowable value is determined; this is necessary for the ASIO & Jack APIs where the user can set an overriding global buffer size for their device.
  • streamName: string

    A stream name (currently used only in Jack).
  • inputCallback: null | ((inputData) => void)

    A callback that is called when a new input signal is available. Should be null for output-only streams.
  • frameOutputCallback: null | (() => void)

    A callback that is called when a frame is finished playing in the output device.
  • Optional flags: RtAudioStreamFlags

    A bit-mask of stream flags (RtAudio.StreamFlags).
  • Optional errorCallback: null | ((type, msg) => void)

    A callback that is called when an error has occurred.

  Returns number

  The actual frame-size used for stream. Useful if passed 0 as frameSize.

setFrameOutputCallback

• setFrameOutputCallback(callback): void

• Sets the frame output playback for the output device.

  Parameters

  • callback: null | (() => void)

    A callback that is called when a frame is finished playing in the output device.

  Returns void

setInputCallback

• setInputCallback(callback): void

• Sets the input callback function for the input device.

  Parameters

  • callback: null | ((inputData) => void)

    A callback that is called when a new input signal is available. Should be null for output-only streams.

  Returns void

start

• start(): void

• Start the stream.

  Returns void

stop

• stop(): void

• Stop the stream.

  Returns void

write

• write(pcm): void

• Queues a new output PCM data to be played using the stream.

  Parameters

  • pcm: Buffer

    The raw PCM data. The length should be frame_size * no_of_output_channels * size_of_sample.

  Returns void