AudioStreamBinding

import { AudioStreamBinding } from "destack:audio/binding";

Stream binding family.

language/library/src/audio/binding/stream.ds:137:273

1export interface AudioStreamBinding {2    supportAudioStream(request: &'a readonly AudioStreamRequest): Result<AudioStreamSupport, HostError>;3    openAudioStream(request: &'a readonly AudioStreamRequest): Result<AudioStreamHandle, HostError>;4    closeAudioStream(stream: AudioStreamHandle): Result<void, HostError>;5    startAudioStream(stream: AudioStreamHandle): Result<void, HostError>;6    pauseAudioStream(stream: AudioStreamHandle): Result<void, HostError>;7    resumeAudioStream(stream: AudioStreamHandle): Result<void, HostError>;8    stopAudioStream(stream: AudioStreamHandle): Result<void, HostError>;9    drainAudioStream(stream: AudioStreamHandle, timeoutNs?: uint64 | undefined): Result<void, HostError>;10    describeAudioStream(stream: AudioStreamHandle): Result<AudioStream, HostError>;11    audioStreamStatus(stream: AudioStreamHandle): Result<AudioStreamStatus, HostError>;12    readAudioStream(stream: AudioStreamHandle, buffer: &'a [uint8], timeoutNs?: uint64 | undefined): Result<uint64, HostError>;13    writeAudioStream(stream: AudioStreamHandle, bytes: &'a readonly [uint8], timeoutNs?: uint64 | undefined): Result<uint64, HostError>;14    setAudioStreamGain(stream: AudioStreamHandle, gain: float64): Result<void, HostError>;15    setAudioStreamMute(stream: AudioStreamHandle, isMuted: boolean): Result<void, HostError>;16}

Members

supportAudioStream(request: &'a readonly AudioStreamRequest): Result<AudioStreamSupport, HostError>: Check whether one audio stream can be opened.
openAudioStream(request: &'a readonly AudioStreamRequest): Result<AudioStreamHandle, HostError>: Open one audio stream.
closeAudioStream(stream: AudioStreamHandle): Result<void, HostError>: Close one audio stream.
startAudioStream(stream: AudioStreamHandle): Result<void, HostError>: Start one audio stream.
pauseAudioStream(stream: AudioStreamHandle): Result<void, HostError>: Pause one audio stream.
resumeAudioStream(stream: AudioStreamHandle): Result<void, HostError>: Resume one audio stream.
stopAudioStream(stream: AudioStreamHandle): Result<void, HostError>: Stop one audio stream.
drainAudioStream(stream: AudioStreamHandle, timeoutNs?: uint64 | undefined): Result<void, HostError>: Drain queued playback data.
describeAudioStream(stream: AudioStreamHandle): Result<AudioStream, HostError>: Read one opened audio stream state.
audioStreamStatus(stream: AudioStreamHandle): Result<AudioStreamStatus, HostError>: Read one stream status sample.
readAudioStream(stream: AudioStreamHandle, buffer: &'a [uint8], timeoutNs?: uint64 | undefined): Result<uint64, HostError>: Read buffered capture frames into one buffer.
writeAudioStream(stream: AudioStreamHandle, bytes: &'a readonly [uint8], timeoutNs?: uint64 | undefined): Result<uint64, HostError>: Write buffered playback frames from one buffer.
setAudioStreamGain(stream: AudioStreamHandle, gain: float64): Result<void, HostError>: Set one stream gain multiplier.
setAudioStreamMute(stream: AudioStreamHandle, isMuted: boolean): Result<void, HostError>: Set one stream mute state.