from::CS::CSFD4SoundIns Class Reference

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 ()=0
	The deleter method to call when reference count reaches zero.

Friends
class	CSSound

Detailed Description

A single playable sound instance in the sound engine.

Member Function Documentation

get_playback_state()

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

inlinenoexcept

Get the playback state.

Returns

const sound_state playback state

is_playing()

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

inlinenoexcept

Is the sound playing?

Returns

true

false

---

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

• include/coresystem/sound.hpp