core/general_audio library
Classes
- AllocatedAudioFrames
- AllocatedAudioFrames allocates requested frames of buffer.
- AudioBuffer
- AudioBuffer is a AudioFrames's internal audio buffer data. pBuffer contains pointer to a raw pcm audio.
- AudioBus
- AudioBus represents a audio node's format and connection.
- AudioClock
- An audio clock that provides a time reference for audio tasks.
- AudioDecoder
- An abstract class for audio decoders.
- AudioDecodeResult
- The result of AudioDecoder.decode.
- AudioDevice
- A base class for audio devices.
- AudioDeviceContext
- The audio device context that is used to create audio devices for the specified backends.
- AudioDeviceId
- A unique identifier for an audio device.
- AudioDeviceInfo
- An audio device information.
- AudioDeviceNotification
- An audio device notification which is sent when the audio device state changes.
- AudioEncoder
- An abstract class for audio encoders.
- AudioEncodeResult
- The result of AudioEncoder.encode.
- AudioEndpointBus
- An audio endpoint bus that cannot be connected to any input bus.
- AudioFileDataSource
- An audio data source for a file.
- AudioFilterNode
- AudioFilterNode is the handy base class for audio filter nodes.
- AudioFormat
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioFormatConverter
- Converts audio data from one format to another.
- AudioFormatConverterConfig
- The configuration of an audio format converter.
- AudioFormatConverterResult
- The result of an audio format conversion.
- AudioFrames
- AudioFrames is a base class of audio buffers. You can call lock to request internal lock and retrieve the AudioBuffer. When you call lock, you must call unlock when the raw buffer operations is not necessary. Memory will be used internal buffer allocations.
- AudioInputBus
- AudioInputBus represents a audio node's input format and connection.
- AudioInputDataSource
- An abstract class for audio input data sources.
- AudioIntervalClock
- An audio clock that ticks at a fixed interval.
- AudioLoopClock
- An audio clock that ticks in a loop.
- AudioMemoryDataSource
- An audio data source for a memory buffer.
- AudioNode
- AudioNode is the base class for all audio nodes.
- AudioOutputBus
- AudioOutputBus represents a audio node's output format and connection.
- AudioOutputDataSource
- An abstract class for audio output data sources.
- AudioReadResult
- The result of reading audio data from a source.
- AudioResourceManager
- A manager that provides a way to dispose audio resources.
- AudioSampleRateConverterConfig
- NOTE: This class is not fully implemented for now and is only used for internal purposes. An audio resampler for converting audio data from one sample rate to another.
- AudioTime
- A class for representing audio time.
- CaptureDevice
- A capture device.
- CaptureDeviceReadResult
- The result of the read operation.
- CaptureNode
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- CaVersion
- Represents a version of the general_audio library.
- CoastAudioInterop
- An interop helper for the general_audio and miniaudio library.
- CoastAudioNative
- A wrapper around the native general_audio library.
- DataSourceNode
- DataSourceNode is a node that provides audio data to outputBus.
- DecoderNode
- An audio node that decodes audio data by using AudioDecoder.
- DelayNode
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- DynamicAudioFrames
- An audio buffer that can be resized dynamically.
- FfiMemory
-
FfiMemory uses native functions to interact with memory operations.
For example, setMemory will use the
memsetfunction. - FrameRingBuffer
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- FunctionNode
- An audio node that generates audio data by a function.
- LinearAudioSampleRateConverterConfig
- A linear audio resampler.
- MaAudioDecoder
- An audio decoder using the miniaudio library.
- MaVersion
- Represents a version of the miniaudio library.
- Memory
- Memory class handles pointer related operations. You can customize the behavior by extending this class and provide it to memory related instances such as AllocatedAudioFrames. By default, FfiMemory will be used.
- MixerNode
- A node that mixes audio data from multiple input buses.
- Mutex
- Mutex provides a simple mutual exclusion lock.
- OffsetFunction
- A wave generator function that returns a constant value.
- PlaybackDevice
- A playback device.
- PlaybackDeviceWriteResult
- The result of the write operation.
- PlaybackNode
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- RingBuffer
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- SawtoothFunction
- A wave generator function that returns a sawtooth wave.
- SineFunction
- A wave generator function that returns a sine wave.
- SquareFunction
- A wave generator function that returns a square wave.
- TriangleFunction
- A wave generator function that returns a triangle wave.
- VolumeNode
- VolumeNode is a node that changes the volume of the audio data.
- WavAudioDecoder
- An audio decoder for WAV format.
- WavAudioEncoder
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- WaveFunction
- The abstract class of a wave generator function. You can implement custom waves by extending this class.
Enums
- AudioChannelMixMode
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioDeviceBackend
- The device backend which is used to communicate with the native audio device.
- AudioDeviceNotificationType
- Types of audio device notifications.
- AudioDevicePerformanceProfile
- The performance profile of the audio device.
- AudioDeviceState
- The state of the audio device.
- AudioDeviceType
- The type of the audio device.
- AudioDitherMode
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- MaResult
- miniaudio result codes.
- SampleFormat
- Sample format which represents the format of the audio data.
Mixins
- AudioResourceMixin
- A mixin that provides a finalizer for audio resources.
- BypassNodeMixin
- A mixin that can bypass the node's process method.
- ProcessorNodeMixin
- An audio node that reads from an input bus and calls process method automatically.
- SingleInNodeMixin
- A mixin that provides a single input bus.
- SingleOutNodeMixin
- A mixin that provides a single output bus.
Extensions
- AudioBufferExtension on AudioBuffer
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioClockExtension on AudioClock
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioFrameExtension on AudioFrames
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- NativeBindingsExtension on NativeBindings
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
Typedefs
- AttemptConnectBusCallback = void Function(AudioOutputBus bus)
- When a AudioOutputBus is trying to connect to AudioInputBus, this callback will be called.
- AudioClockCallback = void Function(AudioClock clock)
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- DecodeResultListener = void Function(AudioDecodeResult result)
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- InputFormatResolver = AudioFormat? Function(AudioInputBus bus)
- A callback that resolves the format of the AudioInputBus.
- OutputFormatResolver = AudioFormat? Function(AudioOutputBus bus)
- A resolver that resolves the output format of a AudioOutputBus.
Exceptions / Errors
- AudioBusConnectionException
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioEndpointBusConnectionError
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioFormatError
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- AudioResourceDisposedException
- An exception that is thrown when an audio resource is already disposed.
- CoastAudioNativeInitializationException
- An exception thrown when the native general_audio library fails to initialize.
- MaException
- An exception thrown when a miniaudio operation fails.
- MixerNodeException
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- MutexAlreadyLockedException
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer
- WavFormatException
- General Library Documentation Undocument By General Corporation & Global Corporation & General Developer