mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
2.8 KiB
XML
113 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.id3-get-version" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>id3_get_version</refname>
|
|
<refpurpose>Get version of an ID3 tag</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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.
|
|
</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>
|
|
</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>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the version number of the ID3 tag of the 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>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Contains a 1.x tag
|
|
Contains a 1.1 tag
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>id3_set_tag</function></member>
|
|
<member><function>id3_get_tag</function></member>
|
|
<member><function>id3_remove_tag</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
|
|
-->
|