raylib-cpp
C++ object-oriented wrapper library for raylib.
Public Member Functions | Static Public Member Functions | List of all members
raylib::AudioStream Class Reference

AudioStream management functions. More...

Public Member Functions

 AudioStream (AudioStream &&other)
 
 AudioStream (const ::AudioStream &music)
 
 AudioStream (const AudioStream &)=delete
 
 AudioStream (rAudioBuffer *buffer=nullptr, unsigned int sampleRate=0, unsigned int sampleSize=0, unsigned int channels=0)
 
 AudioStream (unsigned int SampleRate, unsigned int SampleSize, unsigned int Channels=2)
 Init audio stream (to stream raw audio pcm data) More...
 
rAudioBuffer * GetBuffer () const
 Retrieves the buffer value for the object. More...
 
unsigned int GetChannels () const
 Retrieves the channels value for the object. More...
 
unsigned int GetSampleRate () const
 Retrieves the sampleRate value for the object. More...
 
unsigned int GetSampleSize () const
 Retrieves the sampleSize value for the object. More...
 
bool IsPlaying () const
 Check if audio stream is playing.
 
bool IsProcessed () const
 Check if any audio stream buffers requires refill.
 
bool IsReady ()
 Retrieve whether or not the audio stream is ready.
 
bool Load (unsigned int SampleRate, unsigned int SampleSize, unsigned int Channels=2)
 Init audio stream (to stream raw audio pcm data) More...
 
AudioStreamoperator= (AudioStream &&other)
 
AudioStreamoperator= (const ::AudioStream &stream)
 
AudioStreamoperator= (const AudioStream &)=delete
 
AudioStreamPause ()
 Pause audio stream.
 
AudioStreamPlay ()
 Play audio stream.
 
AudioStreamResume ()
 Resume audio stream.
 
void SetBuffer (rAudioBuffer *value)
 Sets the buffer value for the object. More...
 
void SetChannels (unsigned int value)
 Sets the channels value for the object. More...
 
AudioStreamSetPitch (float pitch)
 Set pitch for audio stream (1.0 is base level)
 
void SetSampleRate (unsigned int value)
 Sets the sampleRate value for the object. More...
 
void SetSampleSize (unsigned int value)
 Sets the sampleSize value for the object. More...
 
AudioStreamSetVolume (float volume)
 Set volume for audio stream (1.0 is max level)
 
AudioStreamStop ()
 Stop audio stream.
 
void Unload ()
 Unload audio stream and free memory.
 
AudioStreamUpdate (const void *data, int samplesCount)
 Update audio stream buffers with data.
 

Static Public Member Functions

static void SetBufferSizeDefault (int size)
 Default size for new audio streams.
 

Detailed Description

AudioStream management functions.

Definition at line 12 of file AudioStream.hpp.

Constructor & Destructor Documentation

◆ AudioStream()

raylib::AudioStream::AudioStream ( unsigned int  SampleRate,
unsigned int  SampleSize,
unsigned int  Channels = 2 
)
inline

Init audio stream (to stream raw audio pcm data)

Exceptions
raylib::RaylibExceptionThrows if the AudioStream failed to load.

Definition at line 30 of file AudioStream.hpp.

References Load().

Member Function Documentation

◆ GetBuffer()

rAudioBuffer* raylib::AudioStream::GetBuffer ( ) const
inline

Retrieves the buffer value for the object.

Returns
The buffer value of the object.

Definition at line 51 of file AudioStream.hpp.

◆ GetChannels()

unsigned int raylib::AudioStream::GetChannels ( ) const
inline

Retrieves the channels value for the object.

Returns
The channels value of the object.

Definition at line 54 of file AudioStream.hpp.

◆ GetSampleRate()

unsigned int raylib::AudioStream::GetSampleRate ( ) const
inline

Retrieves the sampleRate value for the object.

Returns
The sampleRate value of the object.

Definition at line 52 of file AudioStream.hpp.

◆ GetSampleSize()

unsigned int raylib::AudioStream::GetSampleSize ( ) const
inline

Retrieves the sampleSize value for the object.

Returns
The sampleSize value of the object.

Definition at line 53 of file AudioStream.hpp.

◆ Load()

bool raylib::AudioStream::Load ( unsigned int  SampleRate,
unsigned int  SampleSize,
unsigned int  Channels = 2 
)
inline

Init audio stream (to stream raw audio pcm data)

Returns
True or false depending on if the audio stream initialized properly.

Definition at line 175 of file AudioStream.hpp.

References IsReady().

Referenced by AudioStream().

◆ SetBuffer()

void raylib::AudioStream::SetBuffer ( rAudioBuffer *  value)
inline

Sets the buffer value for the object.

Parameters
valueThe value of which to set buffer to.

Definition at line 51 of file AudioStream.hpp.

◆ SetChannels()

void raylib::AudioStream::SetChannels ( unsigned int  value)
inline

Sets the channels value for the object.

Parameters
valueThe value of which to set channels to.

Definition at line 54 of file AudioStream.hpp.

◆ SetSampleRate()

void raylib::AudioStream::SetSampleRate ( unsigned int  value)
inline

Sets the sampleRate value for the object.

Parameters
valueThe value of which to set sampleRate to.

Definition at line 52 of file AudioStream.hpp.

◆ SetSampleSize()

void raylib::AudioStream::SetSampleSize ( unsigned int  value)
inline

Sets the sampleSize value for the object.

Parameters
valueThe value of which to set sampleSize to.

Definition at line 53 of file AudioStream.hpp.