manages the native audio classes. More...

#include <Audio.h>

Public Member Functions
void	SetOnAudioDeviceAddedHandler (Heph::EventHandler handler)

void	AddOnAudioDeviceAddedHandler (Heph::EventHandler handler)

void	SetOnAudioDeviceRemovedHandler (Heph::EventHandler handler)

void	AddOnAudioDeviceRemovedHandler (Heph::EventHandler handler)

void	SetOnCaptureHandler (Heph::EventHandler handler)

void	AddOnCaptureHandler (Heph::EventHandler handler)

	Audio ()

	Audio (AudioAPI api)

	Audio (const Audio &)=delete

Audio &	operator= (const Audio &)=delete

	~Audio ()

Native::NativeAudio *	GetNativeAudio () const

std::shared_ptr< IAudioDecoder >	GetAudioDecoder () const

void	SetAudioDecoder (std::shared_ptr< IAudioDecoder > pNewDecoder)

std::shared_ptr< IAudioEncoder >	GetAudioEncoder () const

void	SetAudioEncoder (std::shared_ptr< IAudioEncoder > pNewEncoder)

AudioObject *	Play (const std::filesystem::path &filePath)

AudioObject *	Play (const std::filesystem::path &filePath, uint32_t playCount)

AudioObject *	Play (const std::filesystem::path &filePath, uint32_t playCount, bool isPaused)

AudioObject *	Load (const std::filesystem::path &filePath)

AudioObject *	Load (const std::filesystem::path &filePath, uint32_t playCount)

AudioObject *	Load (const std::filesystem::path &filePath, uint32_t playCount, bool isPaused)

AudioObject *	CreateAudioObject (const std::string &name, size_t bufferFrameCount, AudioChannelLayout channelLayout, uint16_t sampleRate)

bool	DestroyAudioObject (AudioObject *pAudioObject)

bool	DestroyAudioObject (const Heph::Guid &audioObjectId)

bool	AudioObjectExists (AudioObject *pAudioObject) const

bool	AudioObjectExists (const Heph::Guid &audioObjectId) const

AudioObject *	GetAudioObject (size_t index) const

AudioObject *	GetAudioObject (const Heph::Guid &audioObjectId)

AudioObject *	GetAudioObject (const std::string &audioObjectName) const

size_t	GetAudioObjectCount () const

void	ResumeCapture ()

void	PauseCapture ()

bool	IsCapturePaused () const

uint32_t	GetDeviceEnumerationPeriod () const

void	SetDeviceEnumerationPeriod (uint32_t deviceEnumerationPeriod_ms)

void	SetMasterVolume (double volume)

double	GetMasterVolume () const

const AudioFormatInfo &	GetRenderFormat () const

const AudioFormatInfo &	GetCaptureFormat () const

void	InitializeRender ()

void	InitializeRender (AudioChannelLayout channelLayout, uint32_t sampleRate)

void	InitializeRender (AudioFormatInfo format)

void	InitializeRender (AudioDevice *device, AudioFormatInfo format)

void	StopRendering ()

void	InitializeCapture ()

void	InitializeCapture (AudioChannelLayout channelLayout, uint32_t sampleRate)

void	InitializeCapture (AudioFormatInfo format)

void	InitializeCapture (AudioDevice *device, AudioFormatInfo format)

void	StopCapturing ()

void	GetNativeParams (Native::NativeAudioParams &nativeParams) const

void	SetNativeParams (const Native::NativeAudioParams &nativeParams)

AudioDevice	GetAudioDeviceById (const std::string &deviceId) const

AudioDevice	GetRenderDevice () const

AudioDevice	GetCaptureDevice () const

AudioDevice	GetDefaultAudioDevice (AudioDeviceType deviceType) const

std::vector< AudioDevice >	GetAudioDevices (AudioDeviceType deviceType) const

Detailed Description

manages the native audio classes.

Constructor & Destructor Documentation

◆ Audio() [1/2]

HephAudio::Audio::Audio ( )

creates a new instance and initializes it with default values.

◆ Audio() [2/2]

HephAudio::Audio::Audio ( AudioAPI api )

creates a new instance and initializes it with the provided values.

Parameters

api	the native audio API that will be used.

◆ ~Audio()

HephAudio::Audio::~Audio ( )

releases the resources and destroys the instance.

Member Function Documentation

◆ GetNativeAudio()

Native::NativeAudio * HephAudio::Audio::GetNativeAudio ( ) const

gets the pointer to the native audio instance that's internally used.

◆ GetAudioDecoder()

std::shared_ptr< IAudioDecoder > HephAudio::Audio::GetAudioDecoder ( ) const

gets the shared pointer to the audio decoder instance.

◆ SetAudioDecoder()

void HephAudio::Audio::SetAudioDecoder ( std::shared_ptr< IAudioDecoder > pNewDecoder )

sets the decoder.

Parameters

pNewDecoder shared pointer to the new decoder.

◆ GetAudioEncoder()

std::shared_ptr< IAudioEncoder > HephAudio::Audio::GetAudioEncoder ( ) const

gets the shared pointer to the audio encoder instance.

◆ SetAudioEncoder()

void HephAudio::Audio::SetAudioEncoder ( std::shared_ptr< IAudioEncoder > pNewEncoder )

sets the encoder.

Parameters

pNewEncoder shared pointer to the new encoder.

◆ Play() [1/3]

AudioObject * HephAudio::Audio::Play ( const std::filesystem::path & filePath )

reads the file, then starts playing it.

Parameters

filePath path of the file which will be played.

Returns: pointer to the audio object instance.

◆ Play() [2/3]

AudioObject * HephAudio::Audio::Play	(	const std::filesystem::path &	filePath,
		uint32_t	playCount )

reads the file, then starts playing it.

Parameters

filePath	path of the file which will be played.
playCount	number of times the file will be played.

Returns: pointer to the audio object instance.

◆ Play() [3/3]

AudioObject * HephAudio::Audio::Play	(	const std::filesystem::path &	filePath,
		uint32_t	playCount,
		bool	isPaused )

reads the file, then starts playing it.

Parameters

filePath	path of the file which will be played.
playCount	number of times the file will be played.
isPaused	indicates whether to start playing the audio data after reading it to memory.

Returns: pointer to the audio object instance.

◆ Load() [1/3]

AudioObject * HephAudio::Audio::Load ( const std::filesystem::path & filePath )

reads the file and converts the audio data to the render format but does not start playing it.

Parameters

filePath path of the file which will be loaded.

Returns: pointer to the audio object instance.

◆ Load() [2/3]

AudioObject * HephAudio::Audio::Load	(	const std::filesystem::path &	filePath,
		uint32_t	playCount )

reads the file and converts the audio data to the render format but does not start playing it.

Parameters

filePath	path of the file which will be loaded.
playCount	number of times the file will be played.

Returns: pointer to the audio object instance.

◆ Load() [3/3]

AudioObject * HephAudio::Audio::Load	(	const std::filesystem::path &	filePath,
		uint32_t	playCount,
		bool	isPaused )

reads the file and converts the audio data to the render format but does not start playing it.

Parameters

filePath	path of the file which will be loaded.
playCount	number of times the file will be played.
isPaused	indicates whether to start playing the audio data after loading it.

Returns: pointer to the audio object instance.

◆ CreateAudioObject()

AudioObject * HephAudio::Audio::CreateAudioObject	(	const std::string &	name,
		size_t	bufferFrameCount,
		AudioChannelLayout	channelLayout,
		uint16_t	sampleRate )

creates an audio object with the provided buffer info.

Parameters

name	name for the audio object.
bufferFrameCount	number of frames the buffer will have.
channelLayout	channel layout of the buffer.
sampleRate	sample rate of the buffer.

Returns: pointer to the audio object instance.

◆ DestroyAudioObject() [1/2]

bool HephAudio::Audio::DestroyAudioObject ( AudioObject * pAudioObject )

destroys the audio object.

Parameters

pAudioObject pointer to the object which will be destroyed.

Returns: true if the object is found and destroyed, otherwise false.

◆ DestroyAudioObject() [2/2]

bool HephAudio::Audio::DestroyAudioObject ( const Heph::Guid & audioObjectId )

destroys the audio object.

Parameters

audioObjectId unique identifier of the object which will be destroyed.

Returns: true if the object is found and destroyed, otherwise false.

◆ AudioObjectExists() [1/2]

bool HephAudio::Audio::AudioObjectExists ( AudioObject * pAudioObject ) const

◆ AudioObjectExists() [2/2]

bool HephAudio::Audio::AudioObjectExists ( const Heph::Guid & audioObjectId ) const

◆ GetAudioObject() [1/3]

AudioObject * HephAudio::Audio::GetAudioObject ( size_t index ) const

gets the audio object.

Parameters

index index of the audio object.

Returns: pointer to the audio object if found, otherwise nullptr.

◆ GetAudioObject() [2/3]

AudioObject * HephAudio::Audio::GetAudioObject ( const Heph::Guid & audioObjectId )

gets the audio object.

Parameters

audioObjectId unique identifier of the audio object.

Returns: pointer to the audio object if found, otherwise nullptr.

◆ GetAudioObject() [3/3]

AudioObject * HephAudio::Audio::GetAudioObject ( const std::string & audioObjectName ) const

gets the first audio object with the provided name.

Parameters

audioObjectName name of the audio object.

Returns: pointer to the audio object if found, otherwise nullptr.

◆ GetAudioObjectCount()

size_t HephAudio::Audio::GetAudioObjectCount ( ) const

gets the number of audio objects currently present.

◆ ResumeCapture()

void HephAudio::Audio::ResumeCapture ( )

resumes capturing.

◆ PauseCapture()

void HephAudio::Audio::PauseCapture ( )

pauses capturing.

◆ IsCapturePaused()

bool HephAudio::Audio::IsCapturePaused ( ) const

checks whether the capturing is paused.

Returns: true if paused capturing, otherwise false.

◆ GetDeviceEnumerationPeriod()

uint32_t HephAudio::Audio::GetDeviceEnumerationPeriod ( ) const

gets the device enumeration period. "/home/runner/work/HephAudio/HephAudio/HephAudio/HeaderFiles/Audio.h" 141

◆ SetDeviceEnumerationPeriod()

void HephAudio::Audio::SetDeviceEnumerationPeriod ( uint32_t deviceEnumerationPeriod_ms )

sets the device enumeration period. "/home/runner/work/HephAudio/HephAudio/HephAudio/HeaderFiles/Audio.h" 144

◆ SetMasterVolume()

void HephAudio::Audio::SetMasterVolume ( double volume )

sets the master volume.

Parameters

volume new master volume.

Important: values above 1 may cause distortion.

◆ GetMasterVolume()

double HephAudio::Audio::GetMasterVolume ( ) const

gets the master volume.

◆ GetRenderFormat()

const AudioFormatInfo & HephAudio::Audio::GetRenderFormat ( ) const

gets the audio format used for rendering.

◆ GetCaptureFormat()

const AudioFormatInfo & HephAudio::Audio::GetCaptureFormat ( ) const

gets the audio format used for capturing.

◆ InitializeRender() [1/4]

void HephAudio::Audio::InitializeRender ( )

initializes rendering with the default device and default format.

◆ InitializeRender() [2/4]

void HephAudio::Audio::InitializeRender	(	AudioChannelLayout	channelLayout,
		uint32_t	sampleRate )

initializes rendering with the default device and the provided format.

Parameters

channelLayout	channel layout of the render format.
sampleRate	sample rate of the render format.

◆ InitializeRender() [3/4]

void HephAudio::Audio::InitializeRender ( AudioFormatInfo format )

initializes rendering with the default device and the provided format.

Parameters

format render format.

◆ InitializeRender() [4/4]

void HephAudio::Audio::InitializeRender	(	AudioDevice *	device,
		AudioFormatInfo	format )

initializes rendering with the provided device and the provided format.

Parameters

device	pointer to the audio render device.
format	render format.

◆ StopRendering()

void HephAudio::Audio::StopRendering ( )

stops rendering and releases the resources allocated for it.

◆ InitializeCapture() [1/4]

void HephAudio::Audio::InitializeCapture ( )

initializes capturing with the default device and default format.

◆ InitializeCapture() [2/4]

void HephAudio::Audio::InitializeCapture	(	AudioChannelLayout	channelLayout,
		uint32_t	sampleRate )

initializes capturing with the default device and the provided format.

Parameters

channelLayout	channel layout of the capture format.
sampleRate	sample rate of the capture format.

◆ InitializeCapture() [3/4]

void HephAudio::Audio::InitializeCapture ( AudioFormatInfo format )

initializes capturing with the default device and the provided format.

Parameters

format capture format.

◆ InitializeCapture() [4/4]

void HephAudio::Audio::InitializeCapture	(	AudioDevice *	device,
		AudioFormatInfo	format )

initializes capturing with the provided device and the provided format.

Parameters

device	pointer to the audio capture device.
format	capture format.

◆ StopCapturing()

void HephAudio::Audio::StopCapturing ( )

stops capturing and releases the resources allocated for it.

◆ GetNativeParams()

void HephAudio::Audio::GetNativeParams ( Native::NativeAudioParams & nativeParams ) const

gets the native API specific parameters.

◆ SetNativeParams()

void HephAudio::Audio::SetNativeParams ( const Native::NativeAudioParams & nativeParams )

sets the native API specific parameters.

◆ GetAudioDeviceById()

AudioDevice HephAudio::Audio::GetAudioDeviceById ( const std::string & deviceId ) const

gets audio device by id.

◆ GetRenderDevice()

AudioDevice HephAudio::Audio::GetRenderDevice ( ) const

gets the audio device that's currently being used for rendering.

◆ GetCaptureDevice()

AudioDevice HephAudio::Audio::GetCaptureDevice ( ) const

gets the audio device that's currently being used for capturing.

◆ GetDefaultAudioDevice()

AudioDevice HephAudio::Audio::GetDefaultAudioDevice ( AudioDeviceType deviceType ) const

gets the system default render/capture device.

Parameters

deviceType type of the device. Must be either AudioDeviceType::Render or AudioDeviceType::Capture .

Returns: AudioDevice

◆ GetAudioDevices()

std::vector< AudioDevice > HephAudio::Audio::GetAudioDevices ( AudioDeviceType deviceType ) const

gets the available audio devices of the requested type.

Parameters

deviceType type of the audio devices.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Audio() [1/2]

◆ Audio() [2/2]

◆ ~Audio()

Member Function Documentation

◆ GetNativeAudio()

◆ GetAudioDecoder()

◆ SetAudioDecoder()

◆ GetAudioEncoder()

◆ SetAudioEncoder()

◆ Play() [1/3]

◆ Play() [2/3]

◆ Play() [3/3]

◆ Load() [1/3]

◆ Load() [2/3]

◆ Load() [3/3]

◆ CreateAudioObject()

◆ DestroyAudioObject() [1/2]

◆ DestroyAudioObject() [2/2]

◆ AudioObjectExists() [1/2]

◆ AudioObjectExists() [2/2]

◆ GetAudioObject() [1/3]

◆ GetAudioObject() [2/3]

◆ GetAudioObject() [3/3]

◆ GetAudioObjectCount()

◆ ResumeCapture()

◆ PauseCapture()

◆ IsCapturePaused()

◆ GetDeviceEnumerationPeriod()

◆ SetDeviceEnumerationPeriod()

◆ SetMasterVolume()

◆ GetMasterVolume()

◆ GetRenderFormat()

◆ GetCaptureFormat()

◆ InitializeRender() [1/4]

◆ InitializeRender() [2/4]

◆ InitializeRender() [3/4]

◆ InitializeRender() [4/4]

◆ StopRendering()

◆ InitializeCapture() [1/4]

◆ InitializeCapture() [2/4]

◆ InitializeCapture() [3/4]

◆ InitializeCapture() [4/4]

◆ StopCapturing()

◆ GetNativeParams()

◆ SetNativeParams()

◆ GetAudioDeviceById()

◆ GetRenderDevice()

◆ GetCaptureDevice()

◆ GetDefaultAudioDevice()

◆ GetAudioDevices()