Metadata Class Reference

Metadata describes meta information that is part of an audio or video file. More...

#include <PrimoAV.h>

Inherits Reference.

Public Member Functions
virtual MetaAttributeList *	attributes () const =0
	Returns a modifiable collection with all the attributes in the Metadata object. More...
virtual Metadata *	clone () const =0
	Creates a deep copy of this object. More...
virtual bool_t	immutable () const =0
	Returns whether the object is immutable. More...
virtual MetaPictureList *	pictures () const =0
	Returns a modifiable collection with all the pictures in the Metadata object. More...
Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance. More...
virtual int32_t	retain () const =0
	Retains the instance. More...
virtual int32_t	retainCount () const =0
	Returns the current reference count. More...

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

Detailed Description

Metadata describes meta information that is part of an audio or video file.

It can hold various textual information and images.

See Also

Library::createMetaAttribute

Library::createMetaPicture

Library::createMetadata

Constructor & Destructor Documentation

virtual ~Metadata ( )

protectedvirtual

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

See Also

primo::Reference::release

Member Function Documentation

virtual MetaAttributeList* attributes ( ) const

pure virtual

Returns a modifiable collection with all the attributes in the Metadata object.

Returns

A collection of MetaAttribute objects. The default value is an empty collection which can be modified but it cannot be replaced.

The returned collection exists only in the context of the Metadata object.

See Also

Library::createMetaAttribute

MetaAttributeList

virtual Metadata* clone ( ) const

pure virtual

Creates a deep copy of this object.

Returns

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

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

Remarks

When cloned an immutable object becomes mutable.

See Also

Object Management

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.

virtual MetaPictureList* pictures ( ) const

pure virtual

Returns a modifiable collection with all the pictures in the Metadata object.

Returns

A collection of MetaPicture objects. The default value is an empty collection which can be modified but it cannot be replaced.

The returned collection exists only in the context of the Metadata object.

See Also

Library::createMetaPicture

MetaPictureList