XJ::AudioScheduleEvent Class Reference

#include <AudioScheduleEvent.h>

Public Types
enum class	EType { Create , Update , Delete }

Public Member Functions
	AudioScheduleEvent (EType type, ActiveAudio audio)
unsigned long long	getStartAtChainMicros () const
bool	operator< (const AudioScheduleEvent &rhs) const

Static Public Member Functions
static std::string	toString (const EType &type)
static EType	parseType (const std::string &value)

Public Attributes
EType	type
ActiveAudio	schedule

Member Enumeration Documentation

EType

enum XJ::AudioScheduleEvent::EType

strong

Enumerator
Create
Update
Delete

Constructor & Destructor Documentation

AudioScheduleEvent()

XJ::AudioScheduleEvent::AudioScheduleEvent ( const AudioScheduleEvent::EType  type, ActiveAudio  audio  )

explicit

Construct an AudioScheduleEvent object

Parameters

type	The type of the event
audio	The ActiveAudio object

Member Function Documentation

getStartAtChainMicros()

unsigned long long XJ::AudioScheduleEvent::getStartAtChainMicros ( ) const

inline

Get the startAtChainMicros of the ActiveAudio object

Returns

The startAtChainMicros of the ActiveAudio object

operator<()

bool XJ::AudioScheduleEvent::operator< ( const AudioScheduleEvent &  rhs ) const

inline

Compare two AudioScheduleEvent objects by their startAtChainMicros

Parameters

rhs	The right-hand side AudioScheduleEvent object

Returns

True if this object is less than the right-hand side object

parseType()

AudioScheduleEvent::EType XJ::AudioScheduleEvent::parseType ( const std::string &  value )

static

Parse the Audio Schedule Event Type enum value from a string

Parameters

value

The string to parse

Returns

The Audio Schedule Event Type enum value

toString()

std::string XJ::AudioScheduleEvent::toString ( const EType &  type )

static

Convert an Audio Schedule Event Type enum value to a string

Parameters

type	The Event Type enum value

Returns

The string representation of the Event Type

Member Data Documentation

schedule

ActiveAudio XJ::AudioScheduleEvent::schedule

type

EType XJ::AudioScheduleEvent::type

---

The documentation for this class was generated from the following files:

• /home/runner/work/xjmusic/xjmusic/engine/include/xjmusic/audio/AudioScheduleEvent.h
• /home/runner/work/xjmusic/xjmusic/engine/src/audio/AudioScheduleEvent.cpp