CeresEngine::AudioMetadata Struct Reference

A class collecting audio metadata information. More...

#include <CeresEngine/Audio/AudioMetadata.hpp>

Public Types
using	Channels = unsigned int
	A type defining the channel count representation.
using	SampleRate = unsigned int
	A type defining the sample rate representation.
using	SampleCount = unsigned int
	A type defining the number of counts representation.

Public Member Functions
	AudioMetadata (Channels channels, SampleRate sampleRate, SampleCount sampleCount)
	Creates a new audio metadata object.

Public Attributes
Channels	channels
	The number of channels in the audio.
SampleRate	sampleRate
	The audio clip sample rate in Hz.
SampleCount	sampleCount
	The number of samples in the audio.

Detailed Description

A class collecting audio metadata information.

Member Typedef Documentation

Channels

using CeresEngine::AudioMetadata::Channels = unsigned int

A type defining the channel count representation.

SampleCount

using CeresEngine::AudioMetadata::SampleCount = unsigned int

A type defining the number of counts representation.

SampleRate

using CeresEngine::AudioMetadata::SampleRate = unsigned int

A type defining the sample rate representation.

Constructor & Destructor Documentation

AudioMetadata()

CeresEngine::AudioMetadata::AudioMetadata	(	Channels	channels,
		SampleRate	sampleRate,
		SampleCount	sampleCount
	)

Creates a new audio metadata object.

Parameters

channels	The number of audio channels
sampleRate	The audio sample rate
sampleCount	The number of samples in the audio

Member Data Documentation

channels

Channels CeresEngine::AudioMetadata::channels

The number of channels in the audio.

sampleCount

SampleCount CeresEngine::AudioMetadata::sampleCount

The number of samples in the audio.

sampleRate

SampleRate CeresEngine::AudioMetadata::sampleRate

The audio clip sample rate in Hz.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/AudioMetadata.hpp