Parameters to be used when playing sound, you can mix your audio playback however you want with these. More...

#include <Mixer.hpp>

Public Member Functions
std::string	ToString () const

Public Attributes
int32_t	Loops { 0 }
	Number of times to loop the track when it reaches the end. A value of -1 will result in an infinite loop.
float	MaxMilliseconds { -1.0f }
	Mix at most n milliseconds. Default -1.0f, mixes all available audio.
float	StartMillisecond { 0.0f }
	Start mixing at n'th millisecond. Values <=0 will result in mixing from the very beginning of the tracks input.
float	LoopStartMillisecond { 0.0f }
	Start looping at n'th millisecond. Values <=0 will result in looping from the very beginning of the tracks input.
float	FadeInMilliseconds { 0.0f }
	Fade in the audio over n milliseconds. Will start from silence and reach full volume smoothly. A value <= 0 disables fade in.
float	AppendSilenceMilliseconds { 0.0f }
	Append n milliseconds to the end of a track after all loops (specified in PlayParams::Loops) are complete. A value <= 0 appends nothing.
bool	LoopedInSequence { true }
	This value is used to define a sequence looping point when passing a sequence to Track::Play, this value is ignored everywhere else.

Friends
std::ostream &	operator<< (std::ostream &os, const PlayParams &params)

Detailed Description

Parameters to be used when playing sound, you can mix your audio playback however you want with these.

Note: Sub millisecond data will be discarded when params are passed to Mixer::PlayTag, it only works with Mixer::PlayTrack

Definition at line 20 of file Mixer.hpp.

Member Function Documentation

◆ ToString()

std::string Cori::Audio::PlayParams::ToString ( ) const

inlinenodiscard

Definition at line 67 of file Mixer.hpp.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const PlayParams &	params )

friend

Definition at line 56 of file Mixer.hpp.

Member Data Documentation

◆ AppendSilenceMilliseconds

float Cori::Audio::PlayParams::AppendSilenceMilliseconds { 0.0f }

Append n milliseconds to the end of a track after all loops (specified in PlayParams::Loops) are complete. A value <= 0 appends nothing.

Definition at line 49 of file Mixer.hpp.

◆ FadeInMilliseconds

float Cori::Audio::PlayParams::FadeInMilliseconds { 0.0f }

Fade in the audio over n milliseconds. Will start from silence and reach full volume smoothly. A value <= 0 disables fade in.

Definition at line 44 of file Mixer.hpp.

◆ LoopedInSequence

bool Cori::Audio::PlayParams::LoopedInSequence { true }

This value is used to define a sequence looping point when passing a sequence to Track::Play, this value is ignored everywhere else.

Definition at line 54 of file Mixer.hpp.

◆ Loops

int32_t Cori::Audio::PlayParams::Loops { 0 }

Number of times to loop the track when it reaches the end. A value of -1 will result in an infinite loop.

Definition at line 24 of file Mixer.hpp.

◆ LoopStartMillisecond

float Cori::Audio::PlayParams::LoopStartMillisecond { 0.0f }

Start looping at n'th millisecond. Values <=0 will result in looping from the very beginning of the tracks input.

Definition at line 39 of file Mixer.hpp.

◆ MaxMilliseconds

float Cori::Audio::PlayParams::MaxMilliseconds { -1.0f }

Mix at most n milliseconds. Default -1.0f, mixes all available audio.

Definition at line 29 of file Mixer.hpp.

◆ StartMillisecond

float Cori::Audio::PlayParams::StartMillisecond { 0.0f }

Start mixing at n'th millisecond. Values <=0 will result in mixing from the very beginning of the tracks input.

Definition at line 34 of file Mixer.hpp.

The documentation for this struct was generated from the following file:

Mixer.hpp

Public Member Functions

Public Attributes

Friends