nomlib
Loading...
Searching...
No Matches
nom::audio::SoundBuffer Struct Reference

Public Attributes

uint32 buffer_id = 0
 The unique identifier for the buffer.
uint32 source_id = 0
 The unique identifier for the sound source.
void * samples = nullptr
 The audio buffer.
nom::size_type frame_count = 0
 The total number of frames in this sample instance.
uint32 channel_count = 0
uint32 channel_format = 0
uint32 sample_rate = 0
int64 sample_count = 0
real32 duration = 0.0f
 The total time, in seconds, of the audio buffer.
nom::size_type total_bytes = 0
bool seekable = false
bool stream_source = false
nom::size_type samples_read = 0
nom::size_type elapsed_seconds = 0
void * context = nullptr

Detailed Description

Definition at line 38 of file SoundBuffer.hpp.

Member Data Documentation

◆ buffer_id

uint32 nom::audio::SoundBuffer::buffer_id = 0

The unique identifier for the buffer.

Remarks
This is the internal referencing system used by OpenAL.

Definition at line 43 of file SoundBuffer.hpp.

◆ channel_count

uint32 nom::audio::SoundBuffer::channel_count = 0

Definition at line 54 of file SoundBuffer.hpp.

◆ channel_format

uint32 nom::audio::SoundBuffer::channel_format = 0

Definition at line 56 of file SoundBuffer.hpp.

◆ context

void* nom::audio::SoundBuffer::context = nullptr

Definition at line 79 of file SoundBuffer.hpp.

◆ duration

real32 nom::audio::SoundBuffer::duration = 0.0f

The total time, in seconds, of the audio buffer.

Definition at line 63 of file SoundBuffer.hpp.

◆ elapsed_seconds

nom::size_type nom::audio::SoundBuffer::elapsed_seconds = 0

Definition at line 76 of file SoundBuffer.hpp.

◆ frame_count

nom::size_type nom::audio::SoundBuffer::frame_count = 0

The total number of frames in this sample instance.

Definition at line 52 of file SoundBuffer.hpp.

◆ sample_count

int64 nom::audio::SoundBuffer::sample_count = 0

Definition at line 60 of file SoundBuffer.hpp.

◆ sample_rate

uint32 nom::audio::SoundBuffer::sample_rate = 0

Definition at line 58 of file SoundBuffer.hpp.

◆ samples

void* nom::audio::SoundBuffer::samples = nullptr

The audio buffer.

Definition at line 49 of file SoundBuffer.hpp.

◆ samples_read

nom::size_type nom::audio::SoundBuffer::samples_read = 0

Definition at line 73 of file SoundBuffer.hpp.

◆ seekable

bool nom::audio::SoundBuffer::seekable = false

Definition at line 67 of file SoundBuffer.hpp.

◆ source_id

uint32 nom::audio::SoundBuffer::source_id = 0

The unique identifier for the sound source.

Definition at line 46 of file SoundBuffer.hpp.

◆ stream_source

bool nom::audio::SoundBuffer::stream_source = false
See also
nom::audio::ALAudioDeviceCaps
Todo
Consider using the AudioSourceType enumeration instead

Definition at line 71 of file SoundBuffer.hpp.

◆ total_bytes

nom::size_type nom::audio::SoundBuffer::total_bytes = 0

Definition at line 65 of file SoundBuffer.hpp.


The documentation for this struct was generated from the following file: