File: id3-get-version.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (83 lines) | stat: -rw-r--r-- 2,327 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
  <refentry id="function.id3-get-version">
   <refnamediv>
    <refname>id3_get_version</refname>
    <refpurpose>Get version of an ID3 tag</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>id3_get_version</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>id3_get_version</function> 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 <constant>ID3_V1_0</constant>,
     <constant>ID3_V1_1</constant> and  <constant>ID3_V2</constant>.
    </para>
    <note>
     <simpara>Instead of a filename you may also pass a valid stream resource.</simpara>
    </note>
    <para>
     <example>
      <title><function>id3_get_version</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$version = id3_get_version( "path/to/example.mp3" );
if ($version & ID3_V1_0) {
    echo "Contains a 1.x tag\n";
}
if ($version & ID3_V1_1) {
    echo "Contains a 1.1 tag\n";
}
if ($version & ID3_V2) {
    echo "Contains a 2.x tag\n";
}
?>
]]>
      </programlisting>
      <para>
       This will output something like:
      </para>
      <screen>
<![CDATA[
Contains a 1.x tag
Contains a 1.1 tag
]]>
      </screen>
     </example>
    </para>
    <para>
      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.
    </para>
    <para>
     See also <function>id3_get_tag</function>, <function>id3_set_tag</function> and
     <function>id3_remove_tag</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
-->