libtaginfo  0.2.1
Public Member Functions | List of all members
TagInfo::InfoRef Class Reference

A simple, value based wrapper round Info. More...

#include <taginfo.h>

Public Member Functions

 InfoRef (const String &filename)
 
 InfoRef (const String &filename, MediaFileType format)
 
 InfoRef (const String &filename, const String &mime)
 
 ~InfoRef ()
 
Infoinfo () const
 
bool is_valid () const
 
bool load () const
 
bool save ()
 

Detailed Description

A simple, value based wrapper round Info.

Constructor & Destructor Documentation

◆ InfoRef() [1/3]

InfoRef::InfoRef ( const String &  filename)

Create a InfoRef object from a media file.

This will internally create a Info object and takes care of its deletion

Parameters
filenameis the path to a media file.

This is a recommended wrapper for RAII creation. If you want to use a pointer to InfoRef, then you can also avoid it and use Info directly.

◆ InfoRef() [2/3]

InfoRef::InfoRef ( const String &  filename,
MediaFileType  type 
)

Create a InfoRef object from a media file.

This will internally create a Info object and takes care of its deletion

Parameters
filenameis the path to a media file.
typeMediaFileType of the media file.

This is a recommended wrapper for RAII creation. If you want to use a pointer to InfoRef, then you can also avoid it and use Info directly.

◆ InfoRef() [3/3]

InfoRef::InfoRef ( const String &  filename,
const String &  mime 
)

Create a InfoRef object from a media file.

This will internally create a Info object and takes care of its deletion

Parameters
filenameis the path to a media file.
mimeMime type of the media file.

This is a recommended wrapper for RAII creation. If you want to use a pointer to InfoRef, then you can also avoid it and use Info directly.

◆ ~InfoRef()

InfoRef::~InfoRef ( )

Destructor for InfoRef

Member Function Documentation

◆ info()

TagInfo::Info * InfoRef::info ( ) const

Get the Info object for actual tag access

Returns
Pointer to Info

◆ is_valid()

bool InfoRef::is_valid ( ) const

Check wether the info object pointers could be created internally

◆ load()

bool InfoRef::load ( ) const

This function forwards the load call to the internal Info object

Returns
True on success

◆ save()

bool InfoRef::save ( void  )

This function forwards the save call to the internal Info object

Returns
True on success

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