Inheritance diagram for com::avpkit::core::MetaData:

Collaboration diagram for com::avpkit::core::MetaData:

[legend]

Public Member Functions
virtual int32_t	getNumKeys ()
	Get the total number of keys currently in this IMetaData object. More...

virtual const char *	getKey (int32_t position)
	Get the key at the given position, or null if no such key at that position. More...

virtual const char *	getValue (const char *key, Flags flag)
	Get the value for the given key. More...

virtual int32_t	setValue (const char key, const char value)
	Sets the value for the given key to value. More...

virtual int32_t	setValue (const char key, const char value, Flags flag)
	Sets the value for the given key to value. More...

int32_t	copy (IMetaData *copy)
	Destroys the current data, and copies all data from copy.

int32_t	copy (AVDictionary *copy)
	Destroys the current data and copies all data from copy.

AVDictionary *	getDictionary ()
	Returns the AVDictionary for passing to FFmpeg calls. More...

Public Member Functions inherited from com::avpkit::ferry::RefCounted
virtual int32_t	acquire ()
	Internal Only. More...

virtual int32_t	release ()
	Internal Only. More...

virtual RefCounted *	copyReference ()
	Create a new Java object that refers to the same native object. More...

virtual int32_t	getCurrentRefCount ()
	Return the current reference count on this object. More...

void	setJavaAllocator (void *allocator)
	This method is public but not part of the standard API. More...

void *	getJavaAllocator ()
	This method is public but not part of the standard API. More...

Static Public Member Functions
static MetaData *	make (AVDictionary **metaDataToReference)
	Create a MetaData object using metaDataToReference. More...

static MetaData *	make (AVDictionary *metaDataToCopy)
	Copies all meta data currently in metaDataToCopy and returns a new object.

Static Public Member Functions inherited from com::avpkit::core::IMetaData
static IMetaData *	make ()
	Create a new IMetaData bag of properties with no values set.

Additional Inherited Members
Public Types inherited from com::avpkit::core::IMetaData
enum	Flags { METADATA_NONE =0 , METADATA_MATCH_CASE =1 , METADATA_DONT_OVERWRITE =16 , META_DATA_APPEND =32 }
	Different types of flags that can be passed to IMetaData#getValue. More...

Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.

Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.

void *	mAllocator
	Not part of public API.

Detailed Description

Definition at line 34 of file MetaData.h.

Member Function Documentation

◆ getDictionary()

AVDictionary* com::avpkit::core::MetaData::getDictionary ( )

inline

Returns the AVDictionary for passing to FFmpeg calls.

Returns: The underlying AVDictionary

Definition at line 76 of file MetaData.h.

76 { return (mMetaData ? *mMetaData : 0); }

Referenced by copy(), com::avpkit::core::Container::open(), com::avpkit::core::StreamCoder::open(), and com::avpkit::core::Property::setProperty().

◆ getKey()

const char * com::avpkit::core::MetaData::getKey ( int32_t position )

virtual

Get the key at the given position, or null if no such key at that position.

Note: positions of keys may change between calls to setValue(String, String) and should be requiried.

Parameters

position The position. Must be >=0 and < getNumKeys().

Returns: the key, or null if not found.

Implements com::avpkit::core::IMetaData.

Definition at line 67 of file MetaData.cpp.

 {
   if (!mMetaData || !*mMetaData || index < 0)
     return 0;
  
   AVDictionaryEntry* tag=0;
   int32_t position=-1;
   do
   {
     tag = av_dict_get(*mMetaData, "", tag, AV_DICT_IGNORE_SUFFIX);
     if (tag) {
       position++;
       if (position == index)
         return tag->key;
     }
   } while(tag);
   return 0;
 }

◆ getNumKeys()

int32_t com::avpkit::core::MetaData::getNumKeys ( )

virtual

Get the total number of keys currently in this IMetaData object.

Returns: the number of keys.

Implements com::avpkit::core::IMetaData.

Definition at line 50 of file MetaData.cpp.

 {
   if (!mMetaData || !*mMetaData)
     return 0;
   
   AVDictionaryEntry* tag=0;
   int32_t retval=0;
   do
   {
     tag = av_dict_get(*mMetaData, "", tag, AV_DICT_IGNORE_SUFFIX);
     if (tag)
       retval++;
   } while(tag);
   return retval;
 }

◆ getValue()

const char * com::avpkit::core::MetaData::getValue	(	const char *	key,
		Flags	flag
	)

virtual

Get the value for the given key.

Parameters

key	The key
flag	A flag for how to search

Returns: The value, or null if none.

Implements com::avpkit::core::IMetaData.

Definition at line 86 of file MetaData.cpp.

 {
    if (!mMetaData || !*mMetaData || !key || !*key)
      return 0;
    AVDictionaryEntry* tag = av_dict_get(*mMetaData, key, 0, (int)flag);
    if (tag)
      return tag->value;
    else
      return 0;
 }

◆ make()

MetaData * com::avpkit::core::MetaData::make ( AVDictionary ** metaDataToReference )

static

Create a MetaData object using metaDataToReference.

Once this is done, this MetaData object is responsible for calling av_dict_free(*metaDataToReference), so take care.

Definition at line 112 of file MetaData.cpp.

 {
   if (!metaToUse)
     return 0;
   
   MetaData* retval = make();
   
   if (retval)
     retval->mMetaData = metaToUse;
  
   return retval;
 }

References com::avpkit::core::IMetaData::make().

◆ setValue() [1/2]

int32_t com::avpkit::core::MetaData::setValue	(	const char *	key,
		const char *	value
	)

virtual

Sets the value for the given key to value.

This overrides any prior setting for key, or adds key to the meta-data if appropriate.

Parameters

key	The key to set.
value	The value to set.

Implements com::avpkit::core::IMetaData.

Definition at line 98 of file MetaData.cpp.

 {
   return setValue(key, value, METADATA_NONE);
 }

References com::avpkit::core::IMetaData::METADATA_NONE.

◆ setValue() [2/2]

int32_t com::avpkit::core::MetaData::setValue	(	const char *	key,
		const char *	value,
		Flags	flag
	)

virtual

Sets the value for the given key to value.

This overrides any prior setting for key, or adds key to the meta-data if appropriate.

Parameters

key	The key to set.
value	The value to set.
flag	A flag on how this should be set.

Since: 5.0

Implements com::avpkit::core::IMetaData.

Definition at line 104 of file MetaData.cpp.

 {
   if (!key || !*key || !mMetaData)
     return -1;
   return (int32_t)av_dict_set(mMetaData, key, value, (int)flag);
 }

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

csrc/com/avpkit/core/MetaData.h
csrc/com/avpkit/core/MetaData.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDictionary()

◆ getKey()

◆ getNumKeys()

◆ getValue()

◆ make()

◆ setValue() [1/2]

◆ setValue() [2/2]