ARDOUR::SessionMetadata Class Reference

#include <session_metadata.h>

Inheritance diagram for ARDOUR::SessionMetadata:

Public Types
typedef std::map< std::string, std::string >	MetaDataMap

Public Member Functions
	SessionMetadata ()
	~SessionMetadata ()
std::string	description () const
std::string	comment () const
std::string	copyright () const
std::string	isrc () const
uint32_t	year () const
std::string	grouping () const
std::string	barcode () const
std::string	title () const
std::string	subtitle () const
std::string	artist () const
std::string	album_artist () const
std::string	lyricist () const
std::string	composer () const
std::string	conductor () const
std::string	remixer () const
std::string	arranger () const
std::string	engineer () const
std::string	producer () const
std::string	dj_mixer () const
std::string	mixer () const
std::string	album () const
std::string	compilation () const
std::string	disc_subtitle () const
uint32_t	disc_number () const
uint32_t	total_discs () const
uint32_t	track_number () const
uint32_t	total_tracks () const
std::string	genre () const
std::string	instructor () const
std::string	course () const
std::string	user_name () const
std::string	user_email () const
std::string	user_web () const
std::string	organization () const
std::string	country () const
void	set_description (const std::string &)
void	set_comment (const std::string &)
void	set_copyright (const std::string &)
void	set_isrc (const std::string &)
void	set_year (uint32_t)
void	set_grouping (const std::string &)
void	set_barcode (const std::string &)
void	set_title (const std::string &)
void	set_subtitle (const std::string &)
void	set_artist (const std::string &)
void	set_album_artist (const std::string &)
void	set_lyricist (const std::string &)
void	set_composer (const std::string &)
void	set_conductor (const std::string &)
void	set_remixer (const std::string &)
void	set_arranger (const std::string &)
void	set_engineer (const std::string &)
void	set_producer (const std::string &)
void	set_dj_mixer (const std::string &)
void	set_mixer (const std::string &)
void	set_album (const std::string &)
void	set_compilation (const std::string &)
void	set_disc_subtitle (const std::string &)
void	set_disc_number (uint32_t)
void	set_total_discs (uint32_t)
void	set_track_number (uint32_t)
void	set_total_tracks (uint32_t)
void	set_genre (const std::string &)
void	set_instructor (const std::string &)
void	set_course (const std::string &)
void	set_user_name (const std::string &)
void	set_user_email (const std::string &)
void	set_user_web (const std::string &)
void	set_organization (const std::string &)
void	set_country (const std::string &)
void	av_export_tag (MetaDataMap &) const
XMLNode &	get_state () const
XMLNode &	get_user_state ()
int	set_state (const XMLNode &, int version_num)
Public Member Functions inherited from PBD::Stateful
	Stateful ()
virtual	~Stateful ()
virtual bool	apply_change (PropertyBase const &)
PropertyChange	apply_changes (PropertyList const &)
const OwnedPropertyList &	properties () const
void	add_property (PropertyBase &s)
void	add_extra_xml (XMLNode &)
XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)
void	save_extra_xml (const XMLNode &)
const PBD::ID &	id () const
bool	set_id (const XMLNode &)
void	set_id (const std::string &)
void	reset_id ()
void	clear_changes ()
virtual void	clear_owned_changes ()
PropertyList *	get_changes_as_properties (PBD::Command *) const
virtual void	rdiff (std::vector< PBD::Command * > &) const
bool	changed () const
virtual PropertyList *	property_factory (const XMLNode &) const
virtual void	suspend_property_changes ()
virtual void	resume_property_changes ()
bool	property_changes_suspended () const
Public Member Functions inherited from PBD::Destructible
virtual	~Destructible ()
virtual void	drop_references ()

Static Public Member Functions
static SessionMetadata *	Metadata ()

Private Types
typedef std::pair< std::string, std::string >	Property
typedef std::map< std::string, std::string >	PropertyMap

Private Member Functions
XMLNode *	get_xml (const std::string &name) const
std::string	get_value (const std::string &name) const
uint32_t	get_uint_value (const std::string &name) const
void	set_value (const std::string &name, const std::string &value)
void	set_value (const std::string &name, uint32_t value)

Private Attributes
PropertyMap	map
PropertyMap	user_map

Static Private Attributes
static SessionMetadata *	_metadata

Additional Inherited Members
Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)>	PropertyChanged
Public Attributes inherited from PBD::Destructible
PBD::Signal< void()>	Destroyed
PBD::Signal< void()>	DropReferences
Static Public Attributes inherited from PBD::Stateful
static int	current_state_version
static int	loading_state_version
Protected Member Functions inherited from PBD::Stateful
void	add_instant_xml (XMLNode &, const std::string &directory_path)
XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)
void	add_properties (XMLNode &) const
PropertyChange	set_values (XMLNode const &)
virtual void	post_set (const PropertyChange &)
virtual void	send_change (const PropertyChange &)
virtual void	mid_thaw (const PropertyChange &)
bool	regenerate_xml_or_string_ids () const
Protected Attributes inherited from PBD::Stateful
XMLNode *	_extra_xml
XMLNode *	_instant_xml
PBD::PropertyChange	_pending_changed
Glib::Threads::Mutex	_lock
std::string	_xml_node_name
	name of node to use for this object in XML More...
OwnedPropertyList *	_properties

Detailed Description

Represents metadata associated to a Session Metadata can be accessed and edited via this class. Exported files can also be tagged with this data.

Definition at line 39 of file session_metadata.h.

Member Typedef Documentation

MetaDataMap

typedef std::map<std::string,std::string> ARDOUR::SessionMetadata::MetaDataMap

Definition at line 136 of file session_metadata.h.

Property

typedef std::pair<std::string, std::string> ARDOUR::SessionMetadata::Property

private

Definition at line 148 of file session_metadata.h.

PropertyMap

typedef std::map<std::string, std::string> ARDOUR::SessionMetadata::PropertyMap

private

Definition at line 149 of file session_metadata.h.

Constructor & Destructor Documentation

SessionMetadata()

ARDOUR::SessionMetadata::SessionMetadata

(

)

~SessionMetadata()

ARDOUR::SessionMetadata::~SessionMetadata

(

)

Member Function Documentation

album()

std::string ARDOUR::SessionMetadata::album

(

)

const

album_artist()

std::string ARDOUR::SessionMetadata::album_artist

(

)

const

arranger()

std::string ARDOUR::SessionMetadata::arranger

(

)

const

artist()

std::string ARDOUR::SessionMetadata::artist

(

)

const

av_export_tag()

void ARDOUR::SessionMetadata::av_export_tag

(

MetaDataMap &

)

const

barcode()

std::string ARDOUR::SessionMetadata::barcode

(

)

const

comment()

std::string ARDOUR::SessionMetadata::comment

(

)

const

compilation()

std::string ARDOUR::SessionMetadata::compilation

(

)

const

composer()

std::string ARDOUR::SessionMetadata::composer

(

)

const

conductor()

std::string ARDOUR::SessionMetadata::conductor

(

)

const

copyright()

std::string ARDOUR::SessionMetadata::copyright

(

)

const

country()

std::string ARDOUR::SessionMetadata::country

(

)

const

course()

std::string ARDOUR::SessionMetadata::course

(

)

const

description()

std::string ARDOUR::SessionMetadata::description

(

)

const

disc_number()

uint32_t ARDOUR::SessionMetadata::disc_number

(

)

const

disc_subtitle()

std::string ARDOUR::SessionMetadata::disc_subtitle

(

)

const

dj_mixer()

std::string ARDOUR::SessionMetadata::dj_mixer

(

)

const

engineer()

std::string ARDOUR::SessionMetadata::engineer

(

)

const

genre()

std::string ARDOUR::SessionMetadata::genre

(

)

const

get_state()

XMLNode& ARDOUR::SessionMetadata::get_state ( ) const

virtual

Implements PBD::Stateful.

get_uint_value()

uint32_t ARDOUR::SessionMetadata::get_uint_value ( const std::string &  name ) const

private

get_user_state()

XMLNode& ARDOUR::SessionMetadata::get_user_state

(

)

get_value()

std::string ARDOUR::SessionMetadata::get_value ( const std::string &  name ) const

private

get_xml()

XMLNode* ARDOUR::SessionMetadata::get_xml ( const std::string &  name ) const

private

grouping()

std::string ARDOUR::SessionMetadata::grouping

(

)

const

instructor()

std::string ARDOUR::SessionMetadata::instructor

(

)

const

isrc()

std::string ARDOUR::SessionMetadata::isrc

(

)

const

lyricist()

std::string ARDOUR::SessionMetadata::lyricist

(

)

const

Metadata()

static SessionMetadata* ARDOUR::SessionMetadata::Metadata ( )

inlinestatic

Definition at line 43 of file session_metadata.h.

mixer()

std::string ARDOUR::SessionMetadata::mixer

(

)

const

organization()

std::string ARDOUR::SessionMetadata::organization

(

)

const

producer()

std::string ARDOUR::SessionMetadata::producer

(

)

const

remixer()

std::string ARDOUR::SessionMetadata::remixer

(

)

const

set_album()

void ARDOUR::SessionMetadata::set_album

(

const std::string &

)

set_album_artist()

void ARDOUR::SessionMetadata::set_album_artist

(

const std::string &

)

set_arranger()

void ARDOUR::SessionMetadata::set_arranger

(

const std::string &

)

set_artist()

void ARDOUR::SessionMetadata::set_artist

(

const std::string &

)

set_barcode()

void ARDOUR::SessionMetadata::set_barcode

(

const std::string &

)

set_comment()

void ARDOUR::SessionMetadata::set_comment

(

const std::string &

)

set_compilation()

void ARDOUR::SessionMetadata::set_compilation

(

const std::string &

)

set_composer()

void ARDOUR::SessionMetadata::set_composer

(

const std::string &

)

set_conductor()

void ARDOUR::SessionMetadata::set_conductor

(

const std::string &

)

set_copyright()

void ARDOUR::SessionMetadata::set_copyright

(

const std::string &

)

set_country()

void ARDOUR::SessionMetadata::set_country

(

const std::string &

)

set_course()

void ARDOUR::SessionMetadata::set_course

(

const std::string &

)

set_description()

void ARDOUR::SessionMetadata::set_description

(

const std::string &

)

set_disc_number()

void ARDOUR::SessionMetadata::set_disc_number

(

uint32_t

)

set_disc_subtitle()

void ARDOUR::SessionMetadata::set_disc_subtitle

(

const std::string &

)

set_dj_mixer()

void ARDOUR::SessionMetadata::set_dj_mixer

(

const std::string &

)

set_engineer()

void ARDOUR::SessionMetadata::set_engineer

(

const std::string &

)

set_genre()

void ARDOUR::SessionMetadata::set_genre

(

const std::string &

)

set_grouping()

void ARDOUR::SessionMetadata::set_grouping

(

const std::string &

)

set_instructor()

void ARDOUR::SessionMetadata::set_instructor

(

const std::string &

)

set_isrc()

void ARDOUR::SessionMetadata::set_isrc

(

const std::string &

)

set_lyricist()

void ARDOUR::SessionMetadata::set_lyricist

(

const std::string &

)

set_mixer()

void ARDOUR::SessionMetadata::set_mixer

(

const std::string &

)

set_organization()

void ARDOUR::SessionMetadata::set_organization

(

const std::string &

)

set_producer()

void ARDOUR::SessionMetadata::set_producer

(

const std::string &

)

set_remixer()

void ARDOUR::SessionMetadata::set_remixer

(

const std::string &

)

set_state()

int ARDOUR::SessionMetadata::set_state ( const XMLNode &  , int  version_num  )

virtual

Implements PBD::Stateful.

set_subtitle()

void ARDOUR::SessionMetadata::set_subtitle

(

const std::string &

)

set_title()

void ARDOUR::SessionMetadata::set_title

(

const std::string &

)

set_total_discs()

void ARDOUR::SessionMetadata::set_total_discs

(

uint32_t

)

set_total_tracks()

void ARDOUR::SessionMetadata::set_total_tracks

(

uint32_t

)

set_track_number()

void ARDOUR::SessionMetadata::set_track_number

(

uint32_t

)

set_user_email()

void ARDOUR::SessionMetadata::set_user_email

(

const std::string &

)

set_user_name()

void ARDOUR::SessionMetadata::set_user_name

(

const std::string &

)

set_user_web()

void ARDOUR::SessionMetadata::set_user_web

(

const std::string &

)

set_value() [1/2]

void ARDOUR::SessionMetadata::set_value ( const std::string &  name, const std::string &  value  )

private

set_value() [2/2]

void ARDOUR::SessionMetadata::set_value ( const std::string &  name, uint32_t  value  )

private

set_year()

void ARDOUR::SessionMetadata::set_year

(

uint32_t

)

subtitle()

std::string ARDOUR::SessionMetadata::subtitle

(

)

const

title()

std::string ARDOUR::SessionMetadata::title

(

)

const

total_discs()

uint32_t ARDOUR::SessionMetadata::total_discs

(

)

const

total_tracks()

uint32_t ARDOUR::SessionMetadata::total_tracks

(

)

const

track_number()

uint32_t ARDOUR::SessionMetadata::track_number

(

)

const

user_email()

std::string ARDOUR::SessionMetadata::user_email

(

)

const

user_name()

std::string ARDOUR::SessionMetadata::user_name

(

)

const

user_web()

std::string ARDOUR::SessionMetadata::user_web

(

)

const

year()

uint32_t ARDOUR::SessionMetadata::year

(

)

const

Member Data Documentation

_metadata

SessionMetadata* ARDOUR::SessionMetadata::_metadata

staticprivate

Definition at line 146 of file session_metadata.h.

map

PropertyMap ARDOUR::SessionMetadata::map

private

Definition at line 150 of file session_metadata.h.

user_map

PropertyMap ARDOUR::SessionMetadata::user_map

private

Definition at line 151 of file session_metadata.h.

---

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

• session_metadata.h