1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="function.id3-get-tag" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>id3_get_tag</refname>
<refpurpose>Get all information stored in an ID3 tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>id3_get_tag</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>version</parameter><initializer>ID3_BEST</initializer></methodparam>
</methodsynopsis>
<para>
<function>id3_get_tag</function> is used to get all information stored
in the id3 tag of the specified file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The path to the MP3 file
</para>
<para>
Instead of a filename you may also pass a valid stream resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
Allows you to specify the version of the tag as MP3 files may contain
both, version 1.x and version 2.x tags
</para>
<para>
Since version 0.2 <function>id3_get_tag</function> 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.
ID3 v2.x tags can contain a lot more information about the MP3 file
than ID3 v1.x tags.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with various keys like:
<literal>title</literal>, <literal>artist</literal>, ..
</para>
<para>
The key <literal>genre</literal> will contain an integer between 0 and
147. You may use <function>id3_get_genre_name</function> to convert it to
a human readable string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>id3_get_tag</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = id3_get_tag( "path/to/example.mp3" );
print_r($tag);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[title] => DN-38416
[artist] => Re:\Legion
[album] => Reflections
[year] => 2004
[genre] => 19
)
]]>
</screen>
</example>
<example>
<title><function>id3_get_tag</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = id3_get_tag( "path/to/example2.mp3", ID3_V2_3 );
print_r($tag);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[copyright] => Dirty Mac
[originalArtist] => Dirty Mac
[composer] => Marcus Götze
[artist] => Dirty Mac
[title] => Little Big Man
[album] => Demo-Tape
[track] => 5/12
[genre] => (17)Rock
[year] => 2001
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>id3_set_tag</function></member>
<member><function>id3_remove_tag</function></member>
<member><function>id3_get_version</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
