SDL::TrackBase Struct Reference

Base class to Track. More...

Inheritance diagram for SDL::TrackBase:

Public Member Functions
void	Destroy ()
	Destroy the specified track.
PropertiesRef	GetProperties ()
	Get the properties associated with a track.
MixerRef	GetMixer ()
	Get the Mixer that owns a Track.
void	SetAudio (AudioRef audio)
	Set a Track's input to a Audio.
void	SetAudioStream (AudioStreamRef stream)
	Set a Track's input to an AudioStream.
void	SetIOStream (IOStreamRef io, bool closeio=false)
	Set a Track's input to an IOStream.
void	SetRawIOStream (IOStreamRef io, const AudioSpec &spec, bool closeio=false)
	Set a Track's input to an IOStream providing raw PCM data.
void	Tag (StringParam tag)
	Assign an arbitrary tag to a track.
void	Untag (StringParam tag)
	Remove an arbitrary tag from a track.
OwnArray< char * >	GetTags ()
	Get the tags currently associated with a track.
void	SetPlaybackPosition (Sint64 frames)
	Seek a playing track to a new position in its input.
Sint64	GetPlaybackPosition ()
	Get the current input position of a playing track.
Sint64	GetFadeFrames ()
	Query whether a given track is fading.
int	GetLoops ()
	Query how many loops remain for a given track.
void	SetLoops (int num_loops)
	Change the number of times a currently-playing track will loop.
AudioRef	GetAudio ()
	Query the Audio assigned to a track.
AudioStreamRef	GetAudioStream ()
	Query the AudioStream assigned to a track.
Sint64	GetRemaining ()
	Return the number of sample frames remaining to be mixed in a track.
Sint64	MSToFrames (Milliseconds ms)
	Convert milliseconds to sample frames for a track's current format.
Milliseconds	FramesToMS (Sint64 frames)
	Convert sample frames for a track's current format to milliseconds.
void	Play (PropertiesRef options=nullptr)
	Start (or restart) mixing a track for playback.
bool	Stop (Sint64 fade_out_frames)
	Halt a currently-playing track, possibly fading out over time.
bool	Pause ()
	Pause a currently-playing track.
bool	Resume ()
	Resume a currently-paused track.
bool	Playing ()
	Query if a track is currently playing.
bool	Paused ()
	Query if a track is currently paused.
void	SetGain (float gain)
	Set a track's gain control.
float	GetGain ()
	Get a track's gain control.
void	SetFrequencyRatio (float ratio)
	Change the frequency ratio of a track.
float	GetFrequencyRatio ()
	Query the frequency ratio of a track.
void	SetOutputChannelMap (std::span< const int > chmap)
	Set the current output channel map of a track.
void	SetStereo (const StereoGains &gains)
	Force a track to stereo output, with optionally left/right panning.
void	Set3DPosition (const Point3D &position)
	Set a track's position in 3D space.
Point3D	Get3DPosition ()
	Get a track's current position in 3D space.
void	SetGroup (GroupRef group)
	Assign a track to a mixing group.
void	SetStoppedCallback (TrackStoppedCallback cb, void *userdata)
	Set a callback that fires when a Track is stopped.
void	SetStoppedCallback (TrackStoppedCB cb)
	Set a callback that fires when a Track is stopped.
void	SetRawCallback (TrackMixCallback cb, void *userdata)
	Set a callback that fires when a Track has initial decoded audio.
void	SetRawCallback (TrackMixCB cb)
	Set a callback that fires when a Track has initial decoded audio.
void	SetCookedCallback (TrackMixCallback cb, void *userdata)
	Set a callback that fires when the mixer has transformed a track's audio.
void	SetCookedCallback (TrackMixCB cb)
	Set a callback that fires when the mixer has transformed a track's audio.
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	ResourceBaseT (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBaseT (std::nullptr_t)
	Constructs null/invalid.
constexpr	ResourceBaseT (const ResourceBaseT &)=default
	Copy constructor.
constexpr	ResourceBaseT (ResourceBaseT &&) noexcept=default
	Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< TrackRaw >
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBaseT &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBaseT< TrackRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< TrackRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

Base class to Track.

See also

Track

---

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

• SDL3pp/SDL3pp_mixer.h