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

 MediaInfo ()
 ~MediaInfo ()
int Open (const MediaInfo_String &File)
 Open a file.

int Open (const unsigned char *Begin, size_t Begin_Size, const unsigned char *End=NULL, size_t End_Size=NULL)
 Open a stream.

int Save ()
 Save the file.

void Close ()
 Close a file.

MediaInfo_String Inform (informoptions_t Options=InformOption_Nothing)
 Get all details about a file.

MediaInfo_String Get (stream_t StreamKind, int StreamNumber, int Parameter, info_t InfoKind=Info_Text)
 Get a piece of information about a file (parameter is an integer).

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

int Set (const MediaInfo_String &ToSet, stream_t StreamKind, int StreamNumber, int Parameter, const MediaInfo_String &OldValue=_T(""))
 Set a piece of information about a file (parameter is an int).

int Set (const MediaInfo_String &ToSet, stream_t StreamKind, int StreamNumber, const MediaInfo_String &Parameter, const MediaInfo_String &OldValue=_T(""))
 Set information about a file (parameter is a string).

MediaInfo_String Option (const MediaInfo_String &Option, const MediaInfo_String &Value=MediaInfo_String(_T("")))
int State_Get ()
 (NOT IMPLEMENTED YET) Get the state of the library

int Count_Get (stream_t StreamKind, int StreamNumber=-1)
 Count of streams of a stream kind (StreamNumber not filled), or count of piece of information in this stream.


Static Public Member Functions

MediaInfo_String Option_Static (const MediaInfo_String &Option, const MediaInfo_String &Value=MediaInfo_String(_T("")))

Friends

class File_Cdxa


Detailed Description

MediaInfo.

Version:
0.6

Definition at line 168 of file MediaInfo.h.


Constructor & Destructor Documentation

MediaInfoLib::MediaInfo::MediaInfo  
 

MediaInfoLib::MediaInfo::~MediaInfo  
 


Member Function Documentation

void MediaInfoLib::MediaInfo::Close  
 

Close a file.

Close a file opened before with Open() (without saving)

Warning:
without have saved before, modifications are lost

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

Count of streams of a stream kind (StreamNumber not filled), or count of piece of information in this stream.

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

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

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

Get a piece of 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 information you want about the parameter (the text, the measure, the help...)
SearchKind Where to look for the parameter
Returns:
a string about information you search
an empty string if there is a problem

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

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

Get a piece of 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 information you want about the parameter (the text, the measure, the help...)
Returns:
a string about information you search
an empty string if there is a problem

MediaInfo_String MediaInfoLib::MediaInfo::Inform informoptions_t    Options = InformOption_Nothing
 

Get all details about a file.

Get all details about a file in one string

Precondition:
You can change default presentation with Inform_Set()

int MediaInfoLib::MediaInfo::Open const unsigned char *    Begin,
size_t    Begin_Size,
const unsigned char *    End = NULL,
size_t    End_Size = NULL
 

Open a stream.

Open a stream (Begin and end of the stream) and collect information about it (technical information and tags)

Parameters:
Begin First bytes of the stream
Begin_Size Size of Begin
End Last bytes of the stream
End_Size Size of End
Return values:
0 File not opened
1 File opened

int MediaInfoLib::MediaInfo::Open const MediaInfo_String   File
 

Open a file.

Open a file and collect information about it (technical information and tags)

Parameters:
File Full name of file to open
Return values:
0 File not opened
1 File opened

MediaInfo_String MediaInfoLib::MediaInfo::Option const MediaInfo_String   Option,
const MediaInfo_String   Value = MediaInfo_String(_T(""))
 

Configure or get information about MediaInfoLib

Parameters:
Option The name of option
Value The value of option
Returns:
Depend of the option : by default "" (nothing) means No, other means Yes
Postcondition:
Known options are :
(NOT IMPLEMENTED YET) "BlockMethod" : Configure when Open Method must return (default or not command not understood : "1")
"0" : Immediatly
"1" : After geting local information
"2" : When user interaction is needed, or whan Internet information is get "Complete" : For debug, configure if MediaInfoLib::Inform() show all information (doesn't care of InfoOption_NoShow tag) : shows all information if true, shows only useful for user information if false (No by default)
"Complete_Get" : return the state of "Complete"
"Language" : Configure language (default language, and this object); Value is Description of language (format : "Column1;Colum2
...)
Column 1 : Unique name ("Bytes", "Title")
Column 2 : translation ("Octets", "Titre")
"Language_Get" : Get the language file in memory "Language_Update" : Configure language of this object only (for optimisation); Value is Description of language (format : "Column1;Colum2
...)
Column 1 : Unique name ("Bytes", "Title")
Column 2 : translation ("Octets", "Titre")
"Inform" : Configure custom text, See MediaInfoLib::Inform() function; Description of views (format : "Column1;Colum2...)
Column 1 : code (11 lines : "General", "Video", "Audio", "Text", "Chapters", "Images", "Begin", "End", "Page_Begin", "Page_Middle", "Page_End")
Column 2 : The text to show (exemple : "Audio : FileName% is at BitRate_String%")
"Inform_Get" : Get custom text
(NOT IMPLEMENTED YET) "TagSeparator" : Configure the separator if there are multiple same tags (" | " by default)
(NOT IMPLEMENTED YET) "TagSeparator_Get" : return the state of "TagSeparator"
(NOT IMPLEMENTED YET) "Internet" : Authorize Internet connection (Yes by default) (NOT IMPLEMENTED YET) "Internet_Title_Get" : When State=5000, give all possible titles for this file (one per line)
Form : Author TagSeparator Title TagSeparator Year
... (NOT IMPLEMENTED YET) "Internet_Title_Set" : Set the Good title (same as given by Internet_Title_Get)
Form : Author TagSeparator Title TagSeparator Year "Info_Parameters" : Information about what are known unique names for parameters
"Info_Parameters_CSV" : Information about what are known unique names for parameters, in CSV format
"Info_Capacities" : Information about which parameters per format are supported
"Info_Codecs" : Information about which codec is known
"Info_Version" : Information about the version of MediaInfoLib

MediaInfo_String MediaInfoLib::MediaInfo::Option_Static const MediaInfo_String   Option,
const MediaInfo_String   Value = MediaInfo_String(_T(""))
[static]
 

int MediaInfoLib::MediaInfo::Save  
 

Save the file.

Save the file opened before with Open() (modifications of tags)

Return values:
0 failed
1 suceed

int MediaInfoLib::MediaInfo::Set const MediaInfo_String   ToSet,
stream_t    StreamKind,
int    StreamNumber,
const MediaInfo_String   Parameter,
const MediaInfo_String   OldValue = _T("")
 

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

Set a piece of 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
OldValue The old value of the parameter
if OldValue is empty and ToSet is filled : tag is added
if OldValue is filled and ToSet is filled : tag is replaced
if OldValue is filled and ToSet is empty : tag is deleted
Return values:
>=0 suceed
<0 failed

int MediaInfoLib::MediaInfo::Set const MediaInfo_String   ToSet,
stream_t    StreamKind,
int    StreamNumber,
int    Parameter,
const MediaInfo_String   OldValue = _T("")
 

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

Set a piece of 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...)
OldValue The old value of the parameter
if OldValue is empty and ToSet is filled : tag is added
if OldValue is filled and ToSet is filled : tag is replaced
if OldValue is filled and ToSet is empty : tag is deleted
Return values:
>=0 suceed
<0 failed

int MediaInfoLib::MediaInfo::State_Get  
 

(NOT IMPLEMENTED YET) Get the state of the library

Return values:
<1000 No information is available for the file yet
>=1000_<5000 Only local (into the file) information is available, getting Internet information (titles only) is no finished yet
5000 (only if Internet connection is accepted) User interaction is needed (use Option() with "Internet_Title_Get")
Warning : even there is only one possible, user interaction (or the software) is needed
>5000<=10000 Only local (into the file) information is available, getting Internet information (all) is no finished yet
<10000 Done


Friends And Related Function Documentation

friend class File_Cdxa [friend]
 

Definition at line 300 of file MediaInfo.h.


The documentation for this class was generated from the following file:
Generated on Sun Jun 26 23:45:42 2005 for MediaInfoLib by doxygen1.3-rc3