MetaAttribute Class Reference

MetaAttribute describes a textual meta information that is part of an audio or video file. More...

#include <av.h>

Inheritance diagram for MetaAttribute:

Public Member Functions
virtual MetaAttribute *	clone () const =0
	Creates a deep copy of this object.
virtual bool_t	immutable () const =0
	Returns whether the object is immutable.
virtual const char *	name () const =0
	Returns the name of the meta attribute.
virtual bool_t	setName (const char *name)=0
	Sets the name of a meta attribute.
virtual bool_t	setValue (const char_t *val)=0
	Sets the value a meta attribute.
virtual const char_t *	value () const =0
	Returns the value of the meta attribute.
Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance.
virtual int32_t	retain () const =0
	Retains the instance.
virtual int32_t	retainCount () const =0
	Returns the current reference count.

Protected Member Functions
virtual	~MetaAttribute ()
	This object can be destroyed only by the library that has created it.

Detailed Description

MetaAttribute describes a textual meta information that is part of an audio or video file.

See also

Library::createMetaAttribute

Metadata

Constructor & Destructor Documentation

~MetaAttribute()

virtual ~MetaAttribute ( )

protectedvirtual

This object can be destroyed only by the library that has created it.

See also

primo::Reference::release

Member Function Documentation

clone()

virtual MetaAttribute * clone ( ) const

pure virtual

Creates a deep copy of this object.

Returns

A new MetaAttribute object. The caller is responsible for releasing the new object when it's not needed anymore.

NULL if the object cannot be cloned because there is not enough memory.

Remarks

When cloned an immutable object becomes mutable.

See also

Object Management

immutable()

virtual bool_t immutable ( ) const

pure virtual

Returns whether the object is immutable.

An immmutable object cannot be modified and all modifying methods fail to produce a result.

Returns

TRUE if the object is immutable, FALSE otherwise.

Remarks

An immutable object can be modified by the AVBlocks library.

Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object.

When cloned an immutable object becomes mutable.

name()

virtual const char * name ( ) const

pure virtual

Returns the name of the meta attribute.

Returns

A pointer to an ANSI string.

Common meta attribute names are defined in primo::codecs::Meta

See also

primo::codecs::Meta

Referenced by setName().

setName()

virtual bool_t setName ( const char * name )

pure virtual

Sets the name of a meta attribute.

Parameters

[in]

name

A pointer to an ANSI string.

Common meta attribute names are defined in primo::codecs::Meta

Returns

TRUE if the name is successfully set, otherwise FALSE.

See also

primo::codecs::Meta

References name().

setValue()

virtual bool_t setValue ( const char_t * val )

pure virtual

Sets the value a meta attribute.

Parameters

[in]

val

A pointer to a Unicode string.

Returns

TRUE if the value is successfully set, otherwise FALSE.

value()

virtual const char_t * value ( ) const

pure virtual

Returns the value of the meta attribute.

Returns

A pointer to a Unicode string.