CameraKit/com.snap.camerakit/AudioProcessor/Input

Input

interface Input

Defines the audio input source model that is available to be read from by the processor.

Types

interface Frame

Defines the properties of a single audio input Frame. The buffer in each Frame is mutable which allows to apply audio processing operations to the input audio before it gets written / played somewhere else.

Properties

bufferSize

abstract val bufferSize: Int

Size of audio data expected to be delivered per frame.

channels

abstract val channels: Int

Number of channels in audio data.

sampleRate

abstract val sampleRate: Int

Number of samples for each audio channel per second, typically 44100Hz.

Functions

subscribeTo

@CheckResult

abstract fun subscribeTo(onFrameAvailable: Consumer<AudioProcessor.Input.Frame>): Closeable

Subscribes to the provided onFrameAvailable to be notified when a new Frame is available for this input. The returned Closeable must be closed when done working with this input otherwise underlying resources will be leaked.