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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.id3-set-tag">
<refnamediv>
<refname>id3_set_tag</refname>
<refpurpose>Update information stored in an ID3 tag</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>id3_set_tag</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>array</type><parameter>tag</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>version</parameter></methodparam>
</methodsynopsis>
<para>
<function>id3_set_tag</function> is used to change the information stored
of an ID3 tag. If no tag has been present, it will be added to the file.
</para>
<note>
<simpara>Instead of a filename you may also pass a valid stream resource.</simpara>
</note>
<para>
The optional <parameter>version</parameter> parameter 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>
<example>
<title><function>id3_set_tag</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$data = array(
"title" => "Re:Start",
"artist" => "Re:\Legion",
"comment" => "A nice track"
);
$result = id3_set_tag( "path/to/example.mp3", $data, ID3_V1_0 );
if ($result === true) {
echo "Tag succesfully updated\n";
}
?>
]]>
</programlisting>
<para>
If the file is writable, this will output:
</para>
<screen>
<![CDATA[
Tag succesfully updated
]]>
</screen>
</example>
</para>
<note>
<simpara>
Currently <function>id3_set_tag</function> only supports
version 1.0 and 1.1.
</simpara>
</note>
<para>
The following keys may be used in the associative array:
</para>
<para>
<table>
<title>Keys in the associative array</title>
<tgroup cols="3">
<thead>
<row>
<entry>key</entry>
<entry>possible value</entry>
<entry>available in version</entry>
</row>
</thead>
<tbody>
<row>
<entry>title</entry>
<entry>string with maximum of 30 characters</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>artist</entry>
<entry>string with maximum of 30 characters</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>album</entry>
<entry>string with maximum of 30 characters</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>year</entry>
<entry>4 digits</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>genre</entry>
<entry>integer value between 0 and 147</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>comment</entry>
<entry>string with maximum of 30 characters (28 in v1.1)</entry>
<entry>v1.0, v1.1</entry>
</row>
<row>
<entry>track</entry>
<entry>integer between 0 and 255</entry>
<entry>v1.1</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
See also <function>id3_get_tag</function>,
<function>id3_remove_tag</function> and <function>id3_get_version</function>.
</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:"../../../../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
-->
|
