HephAudio::AudioFinishedPlayingEventArgs Struct Reference

struct for storing the arguments for the audio finished playing events. More...

#include <AudioFinishedPlayingEventArgs.h>

Inheritance diagram for HephAudio::AudioFinishedPlayingEventArgs:

Public Member Functions
	AudioFinishedPlayingEventArgs (Native::NativeAudio *pNativeAudio, AudioObject *pAudioObject, uint32_t remainingLoopCount)
Public Member Functions inherited from HephAudio::AudioEventArgs
	AudioEventArgs (Native::NativeAudio *pNativeAudio)
virtual	~AudioEventArgs ()=default
Public Member Functions inherited from Heph::EventArgs
virtual	~EventArgs ()=default

Public Attributes
AudioObject *	pAudioObject
uint32_t	remainingLoopCount
Public Attributes inherited from HephAudio::AudioEventArgs
Native::NativeAudio *	pNativeAudio

Detailed Description

struct for storing the arguments for the audio finished playing events.

Constructor & Destructor Documentation

AudioFinishedPlayingEventArgs()

HephAudio::AudioFinishedPlayingEventArgs::AudioFinishedPlayingEventArgs	(	Native::NativeAudio *	pNativeAudio,
		AudioObject *	pAudioObject,
		uint32_t	remainingLoopCount )

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

Parameters

pNativeAudio	pointer to the native audio instance that raised the event.
pAudioObject	pointer to the audio object instance that's being rendered.
remainingLoopCount	number of loops remaining. Number of times the audio object will be played again.

Member Data Documentation

pAudioObject

AudioObject* HephAudio::AudioFinishedPlayingEventArgs::pAudioObject

pointer to the audio object instance that's being rendered.

remainingLoopCount

uint32_t HephAudio::AudioFinishedPlayingEventArgs::remainingLoopCount

number of loops remaining. Number of times the audio object will be played again.