XJ music engine  1.9.6
In-game runtime engine for XJ music.
Public Member Functions | Protected Attributes | Friends | List of all members
XJ::ActiveAudio Class Reference

#include <ActiveAudio.h>

Public Member Functions

 ActiveAudio (const SegmentChoiceArrangementPick *pick, const Instrument *instrument, const InstrumentAudio *audio, unsigned long long startAtChainMicros, unsigned long long stopAtChainMicros, float fromIntensity, float toIntensity)
 
float getFromVolume () const
 
float getToVolume () const
 
UUID getId () const
 
const SegmentChoiceArrangementPick * getPick () const
 
const Instrument * getInstrument () const
 
unsigned long long getStartAtChainMicros () const
 
unsigned long long getStopAtChainMicros () const
 
const InstrumentAudio * getAudio () const
 
int getReleaseMillis () const
 
float getAmplitude (float ap) const
 

Protected Attributes

const SegmentChoiceArrangementPick * pick
 
const Instrument * instrument
 
const InstrumentAudio * audio
 
unsigned long long startAtChainMicros
 
unsigned long long stopAtChainMicros
 
float fromVolume
 
float toVolume
 

Friends

bool operator< (const ActiveAudio &lhs, const ActiveAudio &rhs)
 
bool operator> (const ActiveAudio &lhs, const ActiveAudio &rhs)
 
bool operator== (const ActiveAudio &lhs, const ActiveAudio &rhs)
 
bool operator!= (const ActiveAudio &lhs, const ActiveAudio &rhs)
 

Constructor & Destructor Documentation

◆ ActiveAudio()

ActiveAudio::ActiveAudio ( const SegmentChoiceArrangementPick *  pick,
const Instrument *  instrument,
const InstrumentAudio *  audio,
unsigned long long  startAtChainMicros,
unsigned long long  stopAtChainMicros,
float  fromIntensity,
float  toIntensity 
)

Member Function Documentation

◆ getAmplitude()

float ActiveAudio::getAmplitude ( float  ap) const

Get the amplitude at a given amplitude position between 0 and 1.

Parameters
apamplitude position
Returns
amplitude

◆ getAudio()

const InstrumentAudio * ActiveAudio::getAudio ( ) const

◆ getFromVolume()

float ActiveAudio::getFromVolume ( ) const

◆ getId()

UUID ActiveAudio::getId ( ) const

◆ getInstrument()

const Instrument * ActiveAudio::getInstrument ( ) const

◆ getPick()

const SegmentChoiceArrangementPick * ActiveAudio::getPick ( ) const

◆ getReleaseMillis()

int ActiveAudio::getReleaseMillis ( ) const

◆ getStartAtChainMicros()

unsigned long long ActiveAudio::getStartAtChainMicros ( ) const

◆ getStopAtChainMicros()

unsigned long long ActiveAudio::getStopAtChainMicros ( ) const

◆ getToVolume()

float ActiveAudio::getToVolume ( ) const

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const ActiveAudio &  lhs,
const ActiveAudio &  rhs 
)
friend

Compare two Active Audio for equality

Parameters
lhsActive Audio
rhsActive Audio
Returns
true if lhs == rhs

◆ operator<

bool operator< ( const ActiveAudio &  lhs,
const ActiveAudio &  rhs 
)
friend

Compare two Active Audio by startAtChainMicros

Parameters
lhsActive Audio
rhsActive Audio
Returns
true if lhs < rhs

◆ operator==

bool operator== ( const ActiveAudio &  lhs,
const ActiveAudio &  rhs 
)
friend

Compare two Active Audio for equality

Parameters
lhsActive Audio
rhsActive Audio
Returns
true if lhs == rhs

◆ operator>

bool operator> ( const ActiveAudio &  lhs,
const ActiveAudio &  rhs 
)
friend

Compare two Active Audio by startAtChainMicros

Parameters
lhsActive Audio
rhsActive Audio
Returns
true if lhs >rhs

Member Data Documentation

◆ audio

const InstrumentAudio* XJ::ActiveAudio::audio
protected

◆ fromVolume

float XJ::ActiveAudio::fromVolume
protected

◆ instrument

const Instrument* XJ::ActiveAudio::instrument
protected

◆ pick

const SegmentChoiceArrangementPick* XJ::ActiveAudio::pick
protected

◆ startAtChainMicros

unsigned long long XJ::ActiveAudio::startAtChainMicros
protected

◆ stopAtChainMicros

unsigned long long XJ::ActiveAudio::stopAtChainMicros
protected

◆ toVolume

float XJ::ActiveAudio::toVolume
protected

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