Main Page   Namespace List   Compound List   File List   Namespace Members   Compound Members   File Members  

MediaInfoLib::MediaInfo Class Reference

MediaInfo. More...

#include <MediaInfo.h>

List of all members.

Public Member Functions

int Open (const std::string &File)
 Open a file.

int Save ()
 Save a file.

void Close ()
 Close a file (without saving).

std::string Inform (informoptions_t Options=InformOption_Nothing)
 Get all details about a file in one string.

std::string Get (stream_t StreamKind, int StreamNumber, int Parameter, info_t InfoKind=Info_Text)
 Get information about a file (parameter is an integer).

std::string Get (stream_t StreamKind, int StreamNumber, const std::string &Parameter, info_t InfoKind=Info_Text, info_t SearchKind=Info_Name)
 Get information about a file (parameter is a string).

int Set (const std::string &ToSet, stream_t StreamKind, int StreamNumber, int Parameter, info_t KindOfInfo=Info_Text)
 Set information about a file (parameter is an int).

int Set (const std::string &ToSet, stream_t StreamKind, int StreamNumber, const std::string &Parameter, info_t InfoKind=Info_Text, info_t SearchKind=Info_Name)
 Get information about a file (parameter is a string).

int Count_Get (stream_t StreamKind, int StreamNumber=-1)
 Count of streams of a certain kind, or count of info in this stream (if StreamNumber).

int Language_Set (const std::string &NewLanguage)
 Configure language.


Static Public Member Functions

int Complete_Get ()
 For debug, show all info (doesn't care of InfoOption_NoShow tag).

int Complete_Set (bool Complete)
 For debug, show all info (doesn't care of InfoOption_NoShow tag).

int Language_Set_Static (const std::string &NewLanguage)
 Configure language (static).

int Inform_Set (const std::string &NewView)
 Configure custom text.

std::string Info_Parameters (bool CSV=false)
 Information about what are known unique names for parameters.

std::string Info_Capacities ()
 Information about which parameters per format are supported.

std::string Info_Codecs ()
 Information about which codec is known.

std::string Info_Version ()
 Get the version of MediaInfoLib.


Detailed Description

MediaInfo.

Version:
0.4.0

Definition at line 147 of file MediaInfo.h.


Member Function Documentation

void MediaInfoLib::MediaInfo::Close  
 

Close a file (without saving).

Warning:
without have saved before, modifications are lost

int MediaInfoLib::MediaInfo::Complete_Get   [static]
 

For debug, show all info (doesn't care of InfoOption_NoShow tag).

int MediaInfoLib::MediaInfo::Complete_Set bool    Complete [static]
 

For debug, show all info (doesn't care of InfoOption_NoShow tag).

Parameters:
Complete false if you want show only intersting tags true if you want show all tags

int MediaInfoLib::MediaInfo::Count_Get stream_t    StreamKind,
int    StreamNumber = -1
 

Count of streams of a certain kind, or count of info in this stream (if StreamNumber).

Options

Parameters:
StreamKind Kind of stream (general, video, audio...)
StreamNumber Stream number in this kind of stream (first, second...)

std::string MediaInfoLib::MediaInfo::Get stream_t    StreamKind,
int    StreamNumber,
const std::string &    Parameter,
info_t    InfoKind = Info_Text,
info_t    SearchKind = Info_Name
 

Get information about a file (parameter is a string).

Parameters:
StreamKind Kind of stream (general, video, audio...)
StreamNumber Stream number in Kind of stream (first, second...)
Parameter Parameter you are looking for in the stream (Codec, width, bitrate...), in string format ("Codec", "Width"...)
See Info_Parameters() to have the full list
InfoKind Kind of info you want about the parameter (the text, the measure, the help...)
SearchKind Where to look for the parameter
Returns:
a string about info you search
an empty string if there is a problem

std::string MediaInfoLib::MediaInfo::Get stream_t    StreamKind,
int    StreamNumber,
int    Parameter,
info_t    InfoKind = Info_Text
 

Get information about a file (parameter is an integer).

Parameters:
StreamKind Kind of stream (general, video, audio...)
StreamNumber Stream number in Kind of stream (first, second...)
Parameter Parameter you are looking for in the stream (Codec, width, bitrate...), in integer format (first parameter, second parameter...)
InfoKind Kind of info you want about the parameter (the text, the measure, the help...)
Returns:
a string about info you search
an empty string if there is a problem

std::string MediaInfoLib::MediaInfo::Info_Capacities   [static]
 

Information about which parameters per format are supported.

std::string MediaInfoLib::MediaInfo::Info_Codecs   [static]
 

Information about which codec is known.

std::string MediaInfoLib::MediaInfo::Info_Parameters bool    CSV = false [static]
 

Information about what are known unique names for parameters.

Parameters:
CSV false = separated by spaces true = separated by ;

std::string MediaInfoLib::MediaInfo::Info_Version   [static]
 

Get the version of MediaInfoLib.

std::string MediaInfoLib::MediaInfo::Inform informoptions_t    Options = InformOption_Nothing
 

Get all details about a file in one string.

Inform about a file in text mode

Precondition:
change defaults with Inform_Set()

int MediaInfoLib::MediaInfo::Inform_Set const std::string &    NewView [static]
 

Configure custom text.

Parameters:
Language Description of views (CSV format)
Column 1 : code (6 lines : "General", "Video", "Audio", "Text", "Chapters", "Images")
Column 2 : The text to show (exemple : "Audio : FileName% is at BitRate_String%")
Postcondition:
See Inform() function

int MediaInfoLib::MediaInfo::Language_Set const std::string &    NewLanguage
 

Configure language.

Parameters:
Language Description of language (CSV format)
Column 1 : Unique name ("Bytes", "Title")
Column 2 : translation ("Octets", "Titre")

int MediaInfoLib::MediaInfo::Language_Set_Static const std::string &    NewLanguage [static]
 

Configure language (static).

Parameters:
Language Description of language (CSV format)
Column 1 : Unique name ("Bytes", "Title")
Column 2 : translation ("Octets", "Titre")

int MediaInfoLib::MediaInfo::Open const std::string &    File
 

Open a file.

Parameters:
File File to open
Return values:
0 File not opened
1 File opened

int MediaInfoLib::MediaInfo::Save  
 

Save a file.

Return values:
0 failed
1 suceed

int MediaInfoLib::MediaInfo::Set const std::string &    ToSet,
stream_t    StreamKind,
int    StreamNumber,
const std::string &    Parameter,
info_t    InfoKind = Info_Text,
info_t    SearchKind = Info_Name
 

Get information about a file (parameter is a string).

Parameters:
StreamKind Kind of stream (general, video, audio...)
StreamNumber Stream number in Kind of stream (first, second...)
Parameter Parameter you are looking for in the stream (Codec, width, bitrate...), in string format
InfoKind Kind of info you want about the parameter (the text, the measure, the help...)
SearchKind Where to look for the parameter
Return values:
1 suceed
0 failed

int MediaInfoLib::MediaInfo::Set const std::string &    ToSet,
stream_t    StreamKind,
int    StreamNumber,
int    Parameter,
info_t    KindOfInfo = Info_Text
 

Set information about a file (parameter is an int).

Parameters:
StreamKind Kind of stream (general, video, audio...)
StreamNumber Stream number in Kind of stream (first, second...)
Parameter Parameter you are looking for in the stream (Codec, width, bitrate...), in integer format (first parameter, second parameter...)
KindOfInfo Kind of info you want about the parameter (the text, the measure, the help...)
Return values:
1 suceed
0 failed


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 23:59:39 2003 for MediaInfoLib by doxygen1.3-rc3