A single playable sound instance in the sound engine. More...

#include <sound.hpp>

Inheritance diagram for from::CS::CSFD4SoundIns:

Public Types
enum	sound_state : char { INIT = 0 , PLAY = 1 , STOP = 2 , DIAL = 3 }
	The sound playback state.

Public Member Functions
void	stop_playback () noexcept
	Stop sound playback.

bool	is_playing () const noexcept
	Is the sound playing?

const sound_state	get_playback_state () const noexcept
	Get the playback state.

Public Member Functions inherited from from::DLUT::DLReferenceCountObject
virtual void	deleter ()
	The deleter method to call when reference count reaches zero.

int	count () const noexcept
	Get number of references to object.

void	ref () noexcept
	Increment the object's reference count.

void	unref ()
	Unreference object; there cannot be more ref() calls than unref() calls.

Additional Inherited Members
Protected Member Functions inherited from from::DLUT::DLReferenceCountObject
	DLReferenceCountObject () noexcept=default
	Protected DLReferenceCountObject constructor.

Detailed Description

A single playable sound instance in the sound engine.

Member Function Documentation

const sound_state from::CS::CSFD4SoundIns::get_playback_state ( ) const

inlinenoexcept

Get the playback state.

bool from::CS::CSFD4SoundIns::is_playing ( ) const

inlinenoexcept

Is the sound playing?

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