From 6e47fd8447358eb9677deb7027bc074ac1d96c84 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 14 Jan 2007 04:29:26 +0000 Subject: [PATCH] WS, preparing for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227193 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../id3/functions/id3-get-frame-long-name.xml | 72 +++--- .../functions/id3-get-frame-short-name.xml | 80 +++---- reference/id3/functions/id3-get-genre-id.xml | 76 +++---- .../id3/functions/id3-get-genre-list.xml | 78 +++---- .../id3/functions/id3-get-genre-name.xml | 72 +++--- reference/id3/functions/id3-get-tag.xml | 134 +++++------ reference/id3/functions/id3-get-version.xml | 86 ++++---- reference/id3/functions/id3-remove-tag.xml | 104 ++++----- reference/id3/functions/id3-set-tag.xml | 208 +++++++++--------- 9 files changed, 455 insertions(+), 455 deletions(-) diff --git a/reference/id3/functions/id3-get-frame-long-name.xml b/reference/id3/functions/id3-get-frame-long-name.xml index 6048dfe349..141074f114 100644 --- a/reference/id3/functions/id3-get-frame-long-name.xml +++ b/reference/id3/functions/id3-get-frame-long-name.xml @@ -1,49 +1,49 @@ - - - - id3_get_frame_long_name - Get the long name of an ID3v2 frame - - - Description - - stringid3_get_frame_long_name - stringframeId - - - id3_get_frame_long_name returns the long name for an - ID3v2 frame. - - - - - - - <function>id3_get_frame_long_name</function> example - + + + + id3_get_frame_long_name + Get the long name of an ID3v2 frame + + + Description + + stringid3_get_frame_long_name + stringframeId + + + id3_get_frame_long_name returns the long name for an + ID3v2 frame. + + + + + + + <function>id3_get_frame_long_name</function> example + ]]> - - - This will output: - - + + + This will output: + + - - - - - See also id3_get_frame_short_name. - - - + + + + + See also id3_get_frame_short_name. + + + - - - id3_get_frame_short_name - Get the short name of an ID3v2 frame - - - Description - - stringid3_get_frame_short_name - stringframeId - - - id3_get_frame_short_name returns the short name for an - ID3v2 frame. - - - - - - - <function>id3_get_frame_short_name</function> example - + + + + id3_get_frame_short_name + Get the short name of an ID3v2 frame + + + Description + + stringid3_get_frame_short_name + stringframeId + + + id3_get_frame_short_name returns the short name for an + ID3v2 frame. + + + + + + + <function>id3_get_frame_short_name</function> example + ]]> - - - This will output: - - + + + This will output: + + - - - - - The values returned by id3_get_short_name are used in the - array returned by id3_get_tag. - - - See also id3_get_frame_long_name. - - - + + + + + The values returned by id3_get_short_name are used in the + array returned by id3_get_tag. + + + See also id3_get_frame_long_name. + + + - - - id3_get_genre_id - Get the id for a genre - - - Description - - intid3_get_genre_id - stringgenre - - - id3_get_genre_id returns the id for a genre. If the - specified genre is not available in the genre list, id3_get_genre_id - will return &false; - - - In an ID3 tag, the genre is stored using a integer ranging from 0 to - 147. - - - - <function>id3_get_genre_id</function> example - + + + + id3_get_genre_id + Get the id for a genre + + + Description + + intid3_get_genre_id + stringgenre + + + id3_get_genre_id returns the id for a genre. If the + specified genre is not available in the genre list, id3_get_genre_id + will return &false; + + + In an ID3 tag, the genre is stored using a integer ranging from 0 to + 147. + + + + <function>id3_get_genre_id</function> example + ]]> - - - This will output: - - + + + This will output: + + - - - - - See also id3_get_genre_list and id3_get_genre_name. - - - + + + + + See also id3_get_genre_list and id3_get_genre_name. + + + - - - id3_get_genre_list - Get all possible genre values - - - Description - - arrayid3_get_genre_list - - - - id3_get_genre_list returns an array containing all - possible genres that may be stored in an ID3 tag. This list has been created - by Eric Kemp and later extended by WinAmp. - - - This function is useful to provide you users a list of genres from which - they may choose one. When updating the ID3 tag you will always have to - specify the genre as an integer ranging from 0 to 147. - - - - <function>id3_get_genre_list</function> example - + + + + id3_get_genre_list + Get all possible genre values + + + Description + + arrayid3_get_genre_list + + + + id3_get_genre_list returns an array containing all + possible genres that may be stored in an ID3 tag. This list has been created + by Eric Kemp and later extended by WinAmp. + + + This function is useful to provide you users a list of genres from which + they may choose one. When updating the ID3 tag you will always have to + specify the genre as an integer ranging from 0 to 147. + + + + <function>id3_get_genre_list</function> example + ]]> - - - This will output: - - + + + This will output: + + SynthPop ) ]]> - - - - - See also id3_get_genre_name and id3_get_genre_id. - - - + + + + + See also id3_get_genre_name and id3_get_genre_id. + + + - - - id3_get_genre_name - Get the name for a genre id - - - Description - - stringid3_get_genre_name - intgenre_id - - - id3_get_genre_name returns the name for a genre id. - - - In an ID3 tag, the genre is stored using a integer ranging from 0 to - 147. - - - - <function>id3_get_genre_name</function> example - + + + + id3_get_genre_name + Get the name for a genre id + + + Description + + stringid3_get_genre_name + intgenre_id + + + id3_get_genre_name returns the name for a genre id. + + + In an ID3 tag, the genre is stored using a integer ranging from 0 to + 147. + + + + <function>id3_get_genre_name</function> example + ]]> - - - This will output: - - + + + This will output: + + - - - - - See also id3_get_genre_list and id3_get_genre_id. - - - + + + + + See also id3_get_genre_list and id3_get_genre_id. + + + - - - id3_get_tag - Get all information stored in an ID3 tag - - - Description - - arrayid3_get_tag - stringfilename - intversion - - - id3_get_tag is used to get all information stored - in the id3 tag of the specified file. - - - Instead of a filename you may also pass a valid stream resource. - - - The optional version parameter allows you to - specify the version of the tag as MP3 files may contain both, version 1.x and - version 2.x tags. - - - - <function>id3_get_tag</function> example - + + + + id3_get_tag + Get all information stored in an ID3 tag + + + Description + + arrayid3_get_tag + stringfilename + intversion + + + id3_get_tag is used to get all information stored + in the id3 tag of the specified file. + + + Instead of a filename you may also pass a valid stream resource. + + + The optional version parameter allows you to + specify the version of the tag as MP3 files may contain both, version 1.x and + version 2.x tags. + + + + <function>id3_get_tag</function> example + ]]> - - - This will output something like: - - + + + This will output something like: + + 19 ) ]]> - - - - - The key genre will contain an integer between 0 and 147. You may - use id3_get_genre_name to convert it to a human readable string. - - - Since version 0.2 id3_get_tag also supports ID3 tags of version 2.2, 2.3 and 2.4. - To extract information from these tags, pass one of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the - second parameter. - - - - <function>id3_get_tag</function> example - + + + + + The key genre will contain an integer between 0 and 147. You may + use id3_get_genre_name to convert it to a human readable string. + + + Since version 0.2 id3_get_tag also supports ID3 tags of version 2.2, 2.3 and 2.4. + To extract information from these tags, pass one of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the + second parameter. + + + + <function>id3_get_tag</function> example + ]]> - - - This will output something like: - - + + + This will output something like: + + 2001 ) ]]> - - - - - ID3 v2.x tags can contain a lot more information about the MP3 file than ID3 v1.x tags. - - - See also id3_set_tag, - id3_remove_tag and id3_get_version. - - - + + + + + ID3 v2.x tags can contain a lot more information about the MP3 file than ID3 v1.x tags. + + + See also id3_set_tag, + id3_remove_tag and id3_get_version. + + + - - - id3_get_version - Get version of an ID3 tag - - - Description - - intid3_get_version - stringfilename - - - id3_get_version retrieves the version(s) of the ID3 tag(s) in - the MP3 file. As a tag can contain ID3 v1.x and v2.x tags, the return value of this - function should be bitwise compared with the predefined constants ID3_V1_0, - ID3_V1_1 and ID3_V2. - - - Instead of a filename you may also pass a valid stream resource. - - - - <function>id3_get_version</function> example - + + + + id3_get_version + Get version of an ID3 tag + + + Description + + intid3_get_version + stringfilename + + + id3_get_version retrieves the version(s) of the ID3 tag(s) in + the MP3 file. As a tag can contain ID3 v1.x and v2.x tags, the return value of this + function should be bitwise compared with the predefined constants ID3_V1_0, + ID3_V1_1 and ID3_V2. + + + Instead of a filename you may also pass a valid stream resource. + + + + <function>id3_get_version</function> example + ]]> - - - This will output something like: - - + + + This will output something like: + + - - - - - If a file contains an ID3 v1.1 tag, it always contains - a 1.0 tag, as version 1.1 is just an extension of 1.0. - - - See also id3_get_tag, id3_set_tag and - id3_remove_tag. - - - + + + + + If a file contains an ID3 v1.1 tag, it always contains + a 1.0 tag, as version 1.1 is just an extension of 1.0. + + + See also id3_get_tag, id3_set_tag and + id3_remove_tag. + + + - - - id3_remove_tag - Remove an existing ID3 tag - - - Description - - boolid3_remove_tag - stringfilename - intversion - - - id3_remove_tag is used to remove the information stored - of an ID3 tag. If no tag has been present, it will return &false; and leave the file - as it was. - - - Instead of a filename you may also pass a valid stream resource. - - - The optional version parameter allows you to - specify the version of the tag as MP3 files may contain both, version 1.x and - version 2.x tags. - - - - <function>id3_remove_tag</function> example - + + + + id3_remove_tag + Remove an existing ID3 tag + + + Description + + boolid3_remove_tag + stringfilename + intversion + + + id3_remove_tag is used to remove the information stored + of an ID3 tag. If no tag has been present, it will return &false; and leave the file + as it was. + + + Instead of a filename you may also pass a valid stream resource. + + + The optional version parameter allows you to + specify the version of the tag as MP3 files may contain both, version 1.x and + version 2.x tags. + + + + <function>id3_remove_tag</function> example + ]]> - - - If the file is writable and contained a 1.0 tag, this will output: - - + + + If the file is writable and contained a 1.0 tag, this will output: + + - - - - - - Currently id3_remove_tag only supports - version 1.0 and 1.1. If you choose to remove a 1.0 tag and the file - contains a 1.1 tag, this tag will be removed, as v1.1 is only an - extension of 1.0. - - - - See also id3_get_tag, - id3_set_tag and id3_get_version. - - - + + + + + + Currently id3_remove_tag only supports + version 1.0 and 1.1. If you choose to remove a 1.0 tag and the file + contains a 1.1 tag, this tag will be removed, as v1.1 is only an + extension of 1.0. + + + + See also id3_get_tag, + id3_set_tag and id3_get_version. + + + - - - id3_set_tag - Update information stored in an ID3 tag - - - Description - - boolid3_set_tag - stringfilename - arraytag - intversion - - - id3_set_tag is used to change the information stored - of an ID3 tag. If no tag has been present, it will be added to the file. - - - Instead of a filename you may also pass a valid stream resource. - - - The optional version parameter allows you to - specify the version of the tag as MP3 files may contain both, version 1.x and - version 2.x tags. - - - - <function>id3_set_tag</function> example - + + + + id3_set_tag + Update information stored in an ID3 tag + + + Description + + boolid3_set_tag + stringfilename + arraytag + intversion + + + id3_set_tag is used to change the information stored + of an ID3 tag. If no tag has been present, it will be added to the file. + + + Instead of a filename you may also pass a valid stream resource. + + + The optional version parameter allows you to + specify the version of the tag as MP3 files may contain both, version 1.x and + version 2.x tags. + + + + <function>id3_set_tag</function> example + ]]> - - - If the file is writable, this will output: - - + + + If the file is writable, this will output: + + - - - - - - Currently id3_set_tag only supports - version 1.0 and 1.1. - - - - The following keys may be used in the associative array: - - - - Keys in the associative array - - - - key - possible value - available in version - - - - - title - string with maximum of 30 characters - v1.0, v1.1 - - - artist - string with maximum of 30 characters - v1.0, v1.1 - - - album - string with maximum of 30 characters - v1.0, v1.1 - - - year - 4 digits - v1.0, v1.1 - - - genre - integer value between 0 and 147 - v1.0, v1.1 - - - comment - string with maximum of 30 characters (28 in v1.1) - v1.0, v1.1 - - - track - integer between 0 and 255 - v1.1 - - - -
- - - See also id3_get_tag, - id3_remove_tag and id3_get_version. - - - + + + + + + Currently id3_set_tag only supports + version 1.0 and 1.1. + + + + The following keys may be used in the associative array: + + + + Keys in the associative array + + + + key + possible value + available in version + + + + + title + string with maximum of 30 characters + v1.0, v1.1 + + + artist + string with maximum of 30 characters + v1.0, v1.1 + + + album + string with maximum of 30 characters + v1.0, v1.1 + + + year + 4 digits + v1.0, v1.1 + + + genre + integer value between 0 and 147 + v1.0, v1.1 + + + comment + string with maximum of 30 characters (28 in v1.1) + v1.0, v1.1 + + + track + integer between 0 and 255 + v1.1 + + + +
+ + + See also id3_get_tag, + id3_remove_tag and id3_get_version. + + +