AudioObject.h File Reference

#include "HephAudioShared.h"
#include "AudioBuffer.h"
#include "Event.h"
#include "Guid.h"
#include <vector>
#include <filesystem>

Go to the source code of this file.

Classes
struct	HephAudio::AudioObject
	stores information that's necessary to play audio. More...

Macros
#define	HEPHAUDIO_INFINITE_LOOP   (0)
#define	HEPHAUDIO_RENDER_HANDLER_DEFAULT   &HephAudio::AudioObject::DefaultRenderHandler
#define	HEPHAUDIO_RENDER_HANDLER_MATCH_FORMAT   &HephAudio::AudioObject::MatchFormatRenderHandler
#define	HEPHAUDIO_FINISHED_PLAYING_HANDLER_DEFAULT   &HephAudio::AudioObject::DefaultFinishedPlayingHandler

Macro Definition Documentation

HEPHAUDIO_INFINITE_LOOP

#define HEPHAUDIO_INFINITE_LOOP   (0)

indicates the audio object will be played infinitely.

HEPHAUDIO_RENDER_HANDLER_DEFAULT

#define HEPHAUDIO_RENDER_HANDLER_DEFAULT   &HephAudio::AudioObject::DefaultRenderHandler

the default handler for the AudioObject::OnRender event. Plays the audio data as is.

HEPHAUDIO_RENDER_HANDLER_MATCH_FORMAT

#define HEPHAUDIO_RENDER_HANDLER_MATCH_FORMAT   &HephAudio::AudioObject::MatchFormatRenderHandler

an handler for the AudioObject::OnRender event. Converts the audio data to the render format before playing.

HEPHAUDIO_FINISHED_PLAYING_HANDLER_DEFAULT

#define HEPHAUDIO_FINISHED_PLAYING_HANDLER_DEFAULT   &HephAudio::AudioObject::DefaultFinishedPlayingHandler

the default handler for the AudioObject::OnFinishedPlaying event. If looping, replays the audio object; otherwise, destroys it.