Gst::TagList Class Reference

Gst::TagList — List of tags and values used to describe media metadata. More...

#include <taglist.h>

List of all members.

Public Types

typedef sigc::slot< void,
const TagList&, const
Glib::ustring& > 
SlotForeach
 For example, void on_foreach(const Gst::TagList& taglist, const Glib::Ustring& tag);.

Public Member Functions

 TagList ()
 TagList (GstTagList* gobject, bool make_a_copy=false, bool destroy=true)
 TagList (const TagList& other)
TagListoperator= (const TagList& other)
 ~TagList ()
void swap (TagList& other)
GstTagList* gobj ()
 Provides access to the underlying C instance.
const GstTagList* gobj () const
 Provides access to the underlying C instance.
GstTagList* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
void set_destroy (bool destroy)
 Change whether the wrapper should destroy the underlying gobject or not when the wrapper is deleted.
bool empty ()
 Checks if the given taglist is empty.
void insert (const TagList& other, TagMergeMode mode)
 Inserts the tags of the second list into the first list using the given mode.
TagList merge (const TagList& other, TagMergeMode mode)
 Merges the two given lists into a new list.
void foreach (const SlotForeach& slot)
 Calls the given slot for each tag inside the tag list.

Static Public Member Functions

static bool exists (const Glib::ustring& tag)
 Checks if the given type is already registered.
static GType get_type (const Glib::ustring& tag)
 Gets the Type used for this tag.
static Glib::ustring get_nick (const Glib::ustring& tag)
 Returns: the human-readable name of this tag.
static Glib::ustring get_description (const Glib::ustring& tag)
 Returns: the human-readable description of this tag.
static TagFlag get_flag (const Glib::ustring& tag)
 Gets the flag of tag.
static bool is_fixed (const Glib::ustring& tag)
 Checks if the given tag is fixed.

Protected Attributes

GstTagList* gobject_

Related Functions

(Note that these are not member functions.)

void swap (TagList& lhs, TagList& rhs)
Gst::TagList wrap (GstTagList* object, bool take_copy=false, bool destroy=true, bool dummy=false)
 A Glib::wrap() method for this object.


Detailed Description

Gst::TagList — List of tags and values used to describe media metadata.

Member Typedef Documentation

typedef sigc::slot<void, const TagList&, const Glib::ustring&> Gst::TagList::SlotForeach

For example, void on_foreach(const Gst::TagList& taglist, const Glib::Ustring& tag);.


Constructor & Destructor Documentation

Gst::TagList::TagList (  ) 

Gst::TagList::TagList ( GstTagList *  gobject,
bool  make_a_copy = false,
bool  destroy = true 
) [explicit]

Gst::TagList::TagList ( const TagList other  ) 

Gst::TagList::~TagList (  ) 


Member Function Documentation

TagList& Gst::TagList::operator= ( const TagList other  ) 

void Gst::TagList::swap ( TagList other  ) 

Referenced by swap().

GstTagList* Gst::TagList::gobj (  )  [inline]

Provides access to the underlying C instance.

References gobject_.

const GstTagList* Gst::TagList::gobj (  )  const [inline]

Provides access to the underlying C instance.

References gobject_.

GstTagList* Gst::TagList::gobj_copy (  )  const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

void Gst::TagList::set_destroy ( bool  destroy  ) 

Change whether the wrapper should destroy the underlying gobject or not when the wrapper is deleted.

Parameters:
destroy whether or not the wrapper should destroy the underlying gobject when it is destroyed

static bool Gst::TagList::exists ( const Glib::ustring &  tag  )  [static]

Checks if the given type is already registered.

Parameters:
tag Name of the tag.
Returns:
true if the type is already registered.

static GType Gst::TagList::get_type ( const Glib::ustring &  tag  )  [static]

Gets the Type used for this tag.

Parameters:
tag The tag.
Returns:
The Type of this tag.

static Glib::ustring Gst::TagList::get_nick ( const Glib::ustring &  tag  )  [static]

Returns: the human-readable name of this tag.

Parameters:
tag The tag.
Returns:
The human-readable name of this tag.

static Glib::ustring Gst::TagList::get_description ( const Glib::ustring &  tag  )  [static]

Returns: the human-readable description of this tag.

Parameters:
tag The tag.
Returns:
The human-readable description of this tag.

static TagFlag Gst::TagList::get_flag ( const Glib::ustring &  tag  )  [static]

Gets the flag of tag.

Parameters:
tag The tag.
Returns:
The flag of this tag.

static bool Gst::TagList::is_fixed ( const Glib::ustring &  tag  )  [static]

Checks if the given tag is fixed.

A fixed tag can only contain one value. Unfixed tags can contain lists of values.

Parameters:
tag Tag to check.
Returns:
true, if the given tag is fixed.

bool Gst::TagList::empty (  ) 

Checks if the given taglist is empty.

Returns:
true if the taglist is empty, otherwise false.
Since: 0.10.11.

void Gst::TagList::insert ( const TagList other,
TagMergeMode  mode 
)

Inserts the tags of the second list into the first list using the given mode.

Parameters:
from List to merge from.
mode The mode to use.

TagList Gst::TagList::merge ( const TagList other,
TagMergeMode  mode 
)

Merges the two given lists into a new list.

If one of the lists is 0, a copy of the other is returned. If both lists are 0, 0 is returned.

Parameters:
list2 Second list to merge.
mode The mode to use.
Returns:
The new list.

void Gst::TagList::foreach ( const SlotForeach slot  ) 

Calls the given slot for each tag inside the tag list.

Note that if there is no tag, the slot won't be called at all.

Parameters:
slot slot to be called for each tag


Friends And Related Function Documentation

void swap ( TagList lhs,
TagList rhs 
) [related]

Parameters:
lhs The left-hand side
rhs The right-hand side

References swap().

Gst::TagList wrap ( GstTagList *  object,
bool  take_copy = false,
bool  destroy = true,
bool  dummy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
destroy False if the result should not delete the C instance when wrapper is destroyed. True if it should.
dummy Unused; simply an extra param to disambiguate wrap in weird case such as GStreamer types GstStructure and GstTagList which are both really same C type
Returns:
A C++ instance that wraps this C instance.


Member Data Documentation

GstTagList* Gst::TagList::gobject_ [protected]

Referenced by gobj().


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

Generated on Mon Jun 2 01:59:23 2008 for gstreamermm by  doxygen 1.5.5