AudioStreamPlayer class
#include <nCine/Audio/AudioStreamPlayer.h>
Audio stream player.
Base classes
- class IAudioPlayer
- Audio player interface.
Public static functions
- static auto sType() -> ObjectType
Constructors, destructors, conversion operators
- AudioStreamPlayer()
- Default constructor.
- AudioStreamPlayer(StringView filename) explicit
- A constructor creating a player from a file.
- ~AudioStreamPlayer() override
- AudioStreamPlayer(const AudioStreamPlayer&) deleted
- AudioStreamPlayer(AudioStreamPlayer&&) defaulted
Public functions
- auto operator=(const AudioStreamPlayer&) -> AudioStreamPlayer& deleted
- auto operator=(AudioStreamPlayer&&) -> AudioStreamPlayer& defaulted
- auto loadFromFile(const char* filename) -> bool
-
auto bufferId() const -> std::
uint32_t override - Returns the OpenAL id of the currently playing buffer.
-
auto bytesPerSample() const -> std::
int32_t override - Returns the number of bytes per sample.
-
auto numChannels() const -> std::
int32_t override - Returns the number of audio channels of the currently playing buffer.
-
auto frequency() const -> std::
int32_t override - Returns the samples frequency of the currently playing buffer.
-
auto numSamples() const -> std::
int32_t override - Returns the number of samples.
- auto duration() const -> float override
- Returns the duration in seconds.
-
auto bufferSize() const -> std::
int32_t override - Returns the size of the currently playing buffer in bytes.
-
auto numStreamSamples() const -> std::
int32_t -
auto streamBufferSize() const -> std::
int32_t - void play() override
- Starts playing.
- void pause() override
- Pauses playing.
- void stop() override
- Stops playing and rewind.
- void setLooping(bool value) override
- Sets player looping property.
- void updateState() override
- Updates the player state and the stream buffer queue.