Semi-safe reference for AudioStream.
Inheritance diagram for SDL::AudioStreamRef:
Collaboration diagram for SDL::AudioStreamRef:
Public Member Functions | |
| AudioStreamRef (AudioStreamParam resource) | |
| Constructs from AudioStreamParam. More... | |
| AudioStreamRef (const AudioStreamRef &other) | |
| Copy constructor. | |
| ~AudioStreamRef () | |
| Destructor. | |
 Public Member Functions inherited from SDL::AudioStream | |
| constexpr | AudioStream ()=default |
| Default ctor. | |
| constexpr | AudioStream (const AudioStreamRaw resource) |
| Constructs from AudioStreamParam. More... | |
| constexpr | AudioStream (const AudioStream &other)=delete |
| Copy constructor. | |
| constexpr | AudioStream (AudioStream &&other) |
| Move constructor. | |
| constexpr | AudioStream (const AudioStreamRef &other)=delete |
| constexpr | AudioStream (AudioStreamRef &&other)=delete |
| AudioStream (OptionalRef< const AudioSpec > src_spec, OptionalRef< const AudioSpec > dst_spec) | |
| Create a new audio stream. More... | |
| AudioStream (AudioDeviceParam devid, OptionalRef< const AudioSpec > spec=std::nullopt, AudioStreamCallback callback=nullptr, void *userdata=nullptr) | |
| Convenience function for straightforward audio init for the common case. More... | |
| AudioStream (AudioDeviceParam devid, OptionalRef< const AudioSpec > spec, AudioStreamCB callback) | |
| Convenience function for straightforward audio init for the common case. More... | |
| ~AudioStream () | |
| Destructor. | |
| AudioStream & | operator= (AudioStream other) |
| Assignment operator. | |
| constexpr AudioStreamRaw | get () const |
| Retrieves underlying AudioStreamRaw. | |
| constexpr AudioStreamRaw | release () |
| Retrieves underlying AudioStreamRaw and clear this. | |
| constexpr auto | operator<=> (const AudioStream &other) const =default |
| Comparison. | |
| constexpr bool | operator== (std::nullptr_t _) const |
| Comparison. | |
| constexpr | operator bool () const |
| Converts to bool. | |
| constexpr | operator AudioStreamParam () const |
| Converts to AudioStreamParam. | |
| void | Destroy () |
| Free an audio stream. More... | |
| PropertiesRef | GetProperties () const |
| Get the properties associated with an audio stream. More... | |
| AudioSpec | GetInputFormat () const |
| Query the current input format of an audio stream. More... | |
| AudioSpec | GetOutputFormat () const |
| Query the current output format of an audio stream. More... | |
| void | GetFormat (AudioSpec *src_spec, AudioSpec *dst_spec) const |
| Query the current format of an audio stream. More... | |
| void | SetInputFormat (const AudioSpec &spec) |
| Change the input format of an audio stream. More... | |
| void | SetOutputFormat (const AudioSpec &spec) |
| Change the output format of an audio stream. More... | |
| void | SetFormat (OptionalRef< const AudioSpec > src_spec, OptionalRef< const AudioSpec > dst_spec) |
| Change the input and output formats of an audio stream. More... | |
| float | GetFrequencyRatio () const |
| Get the frequency ratio of an audio stream. More... | |
| void | SetFrequencyRatio (float ratio) |
| Change the frequency ratio of an audio stream. More... | |
| float | GetGain () const |
| Get the gain of an audio stream. More... | |
| void | SetGain (float gain) |
| Change the gain of an audio stream. More... | |
| OwnArray< int > | GetInputChannelMap () const |
| Get the current input channel map of an audio stream. More... | |
| OwnArray< int > | GetOutputChannelMap () const |
| Get the current output channel map of an audio stream. More... | |
| void | SetInputChannelMap (std::span< int > chmap) |
| Set the current input channel map of an audio stream. More... | |
| void | SetOutputChannelMap (std::span< int > chmap) |
| Set the current output channel map of an audio stream. More... | |
| void | PutData (SourceBytes buf) |
| Add data to the stream. More... | |
| int | GetData (TargetBytes buf) |
| Get converted/resampled data from the stream. More... | |
| int | GetAvailable () const |
| Get the number of converted/resampled bytes available. More... | |
| int | GetQueued () const |
| Get the number of bytes currently queued. More... | |
| void | Flush () |
| Tell the stream that you're done sending data, and anything being buffered should be converted/resampled and made available immediately. More... | |
| void | Clear () |
| Clear any pending data in the stream. More... | |
| void | PauseDevice () |
| Use this function to pause audio playback on the audio device associated with an audio stream. More... | |
| void | ResumeDevice () |
| Use this function to unpause audio playback on the audio device associated with an audio stream. More... | |
| bool | DevicePaused () const |
| Use this function to query if an audio device associated with a stream is paused. More... | |
| void | Lock () |
| Lock an audio stream for serialized access. More... | |
| void | Unlock () |
| Unlock an audio stream for serialized access. More... | |
| void | SetGetCallback (AudioStreamCallback callback, void *userdata) |
| Set a callback that runs when data is requested from an audio stream. More... | |
| void | SetGetCallback (AudioStreamCB callback) |
| Set a callback that runs when data is requested from an audio stream. More... | |
| void | SetPutCallback (AudioStreamCallback callback, void *userdata) |
| Set a callback that runs when data is added to an audio stream. More... | |
| void | SetPutCallback (AudioStreamCB callback) |
| Set a callback that runs when data is added to an audio stream. More... | |
| void | Unbind () |
| Unbind a single audio stream from its audio device. More... | |
| AudioDeviceRef | GetDevice () const |
| Query an audio stream for its currently-bound device. More... | |
Constructor & Destructor Documentation
◆ AudioStreamRef()
|
inline |
- Parameters
-
resource a AudioStreamRaw or AudioStream.
This does not takes ownership!
The documentation for this struct was generated from the following file:
- SDL3pp/SDL3pp_audio.h
