sound::music_track Class Reference

Internal representation of music tracks. More...

#include <sound_music_track.hpp>

Public Member Functions
	music_track ()
	music_track (const config &node)
	music_track (const std::string &v_name)
void	write (config &parent_node, bool append) const
bool	valid () const
bool	append () const
bool	immediate () const
bool	shuffle () const
bool	play_once () const
int	ms_before () const
int	ms_after () const
const std::string &	file_path () const
const std::string &	id () const
const std::string &	title () const
void	set_play_once (bool v)
void	set_shuffle (bool v)
void	set_ms_before (int v)
void	set_ms_after (int v)
void	set_title (const std::string &v)

Private Member Functions
void	resolve ()

Private Attributes
std::string	id_
std::string	file_path_
std::string	title_
int	ms_before_
int	ms_after_
bool	once_
bool	append_
bool	immediate_
bool	shuffle_

Detailed Description

Internal representation of music tracks.

Definition at line 28 of file sound_music_track.hpp.

Constructor & Destructor Documentation

music_track() [1/3]

sound::music_track::music_track

(

)

Definition at line 30 of file sound_music_track.cpp.

music_track() [2/3]

sound::music_track::music_track

(

const config &

node

)

Definition at line 42 of file sound_music_track.cpp.

References resolve().

music_track() [3/3]

sound::music_track::music_track ( const std::string &  v_name )

explicit

Definition at line 56 of file sound_music_track.cpp.

References resolve().

Member Function Documentation

append()

bool sound::music_track::append ( ) const

inline

Definition at line 38 of file sound_music_track.hpp.

References append_.

Referenced by sound::play_music_config(), and write().

file_path()

const std::string& sound::music_track::file_path ( ) const

inline

Definition at line 45 of file sound_music_track.hpp.

References file_path_.

Referenced by editor::editor_controller::init_music(), and sound::play_music_config().

id()

const std::string& sound::music_track::id ( ) const

inline

Definition at line 46 of file sound_music_track.hpp.

References id_.

Referenced by editor::map_context::add_to_playlist(), editor::editor_controller::init_music(), and sound::play_music_config().

immediate()

bool sound::music_track::immediate ( ) const

inline

Definition at line 39 of file sound_music_track.hpp.

References immediate_.

Referenced by sound::play_music_config().

ms_after()

int sound::music_track::ms_after ( ) const

inline

Definition at line 43 of file sound_music_track.hpp.

References ms_after_.

ms_before()

int sound::music_track::ms_before ( ) const

inline

Definition at line 42 of file sound_music_track.hpp.

References ms_before_.

play_once()

bool sound::music_track::play_once ( ) const

inline

Definition at line 41 of file sound_music_track.hpp.

References once_.

Referenced by sound::play_music_config().

resolve()

void sound::music_track::resolve ( )

private

Definition at line 70 of file sound_music_track.cpp.

References file_path_, filesystem::get_binary_file_location(), i, id_, LOG_AUDIO, utils::split(), and title_.

Referenced by music_track().

set_ms_after()

void sound::music_track::set_ms_after ( int  v )

inline

Definition at line 52 of file sound_music_track.hpp.

References ms_after_.

set_ms_before()

void sound::music_track::set_ms_before ( int  v )

inline

Definition at line 51 of file sound_music_track.hpp.

References ms_before_.

set_play_once()

void sound::music_track::set_play_once ( bool  v )

inline

Definition at line 49 of file sound_music_track.hpp.

References once_.

set_shuffle()

void sound::music_track::set_shuffle ( bool  v )

inline

Definition at line 50 of file sound_music_track.hpp.

References shuffle_.

set_title()

void sound::music_track::set_title ( const std::string &  v )

inline

Definition at line 53 of file sound_music_track.hpp.

References title_.

shuffle()

bool sound::music_track::shuffle ( ) const

inline

Definition at line 40 of file sound_music_track.hpp.

References shuffle_.

title()

const std::string& sound::music_track::title ( ) const

inline

Definition at line 47 of file sound_music_track.hpp.

References title_.

valid()

bool sound::music_track::valid ( ) const

inline

Definition at line 36 of file sound_music_track.hpp.

References file_path_.

Referenced by sound::play_music_config().

write()

void sound::music_track::write	(	config &	parent_node,
		bool	append
	)		const

Definition at line 114 of file sound_music_track.cpp.

References config::add_child(), append(), id_, ms_after_, ms_before_, and shuffle_.

Member Data Documentation

append_

bool sound::music_track::append_

private

Definition at line 65 of file sound_music_track.hpp.

Referenced by append().

file_path_

std::string sound::music_track::file_path_

private

Definition at line 59 of file sound_music_track.hpp.

Referenced by file_path(), resolve(), and valid().

id_

std::string sound::music_track::id_

private

Definition at line 58 of file sound_music_track.hpp.

Referenced by id(), resolve(), and write().

immediate_

bool sound::music_track::immediate_

private

Definition at line 66 of file sound_music_track.hpp.

Referenced by immediate().

ms_after_

int sound::music_track::ms_after_

private

Definition at line 62 of file sound_music_track.hpp.

Referenced by ms_after(), set_ms_after(), and write().

ms_before_

int sound::music_track::ms_before_

private

Definition at line 62 of file sound_music_track.hpp.

Referenced by ms_before(), set_ms_before(), and write().

once_

bool sound::music_track::once_

private

Definition at line 64 of file sound_music_track.hpp.

Referenced by play_once(), and set_play_once().

shuffle_

bool sound::music_track::shuffle_

private

Definition at line 67 of file sound_music_track.hpp.

Referenced by set_shuffle(), shuffle(), and write().

title_

std::string sound::music_track::title_

private

Definition at line 60 of file sound_music_track.hpp.

Referenced by resolve(), set_title(), and title().

---

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

• sound_music_track.hpp
• sound_music_track.cpp