diff options
Diffstat (limited to 'libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Object.html')
| -rw-r--r-- | libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Object.html | 802 |
1 files changed, 802 insertions, 0 deletions
diff --git a/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Object.html b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Object.html new file mode 100644 index 0000000..15e5ca1 --- /dev/null +++ b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Object.html @@ -0,0 +1,802 @@ +<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class ID3_Object</title>
+ <link rel="stylesheet" href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class ID3_Object</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-descendents">Descendents</a>
+ | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">The base class for all ID3v2 objects.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Ryan Butterfield <<a href="mailto:buttza@gmail.com">buttza@gmail.com</a>></li>
+ <li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
+ <li><span class="field">version:</span> $Rev: 107 $</li>
+ <li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
+ <li><span class="field">abstract:</span> </li>
+ <li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_ID3---Object.php.html">/ID3/Object.php</a> (line <span class="field">49</span>)
+ </p>
+
+
+ <pre></pre>
+
+ </div>
+</div>
+
+ <a name="sec-descendents"></a>
+ <div class="info-box">
+ <div class="info-box-title">Direct descendents</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Descendents</span>
+ | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <table cellpadding="2" cellspacing="0" class="class-table">
+ <tr>
+ <th class="class-table-header">Class</th>
+ <th class="class-table-header">Description</th>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a></td>
+ <td>
+ The extended header contains information that can provide further insight in the structure of the tag, but is not vital to the correct parsing of the tag information; hence the extended header is optional.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></td>
+ <td>
+ A base class for all ID3v2 frames as described in the <a href="http://www.id3.org/id3v2.4.0-frames">ID3v2 frames document</a>.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Header.html">ID3_Header</a></td>
+ <td>
+ The first part of the ID3v2 tag is the 10 byte tag header. The header contains information about the tag version and options.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+ <a name="sec-var-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variable Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-descendents">Descendents</a> |
+ <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div class="var-title">
+ <span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
+ <a href="#$_reader" title="details" class="var-name">$_reader</a>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-descendents">Descendents</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+
+ |
+ <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div class="method-definition">
+ <span class="method-result">ID3_Object</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ ([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#decodeSynchsafe32" title="details" class="method-name">decodeSynchsafe32</a>
+ (<span class="var-type">integer</span> <span class="var-name">$val</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#decodeUnsynchronisation" title="details" class="method-name">decodeUnsynchronisation</a>
+ (<span class="var-type"></span> <span class="var-name">&$data</span>, <span class="var-type">string</span> <span class="var-name">$data</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#encodeSynchsafe32" title="details" class="method-name">encodeSynchsafe32</a>
+ (<span class="var-type">integer</span> <span class="var-name">$val</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#encodeUnsynchronisation" title="details" class="method-name">encodeUnsynchronisation</a>
+ (<span class="var-type"></span> <span class="var-name">&$data</span>, <span class="var-type">string</span> <span class="var-name">$data</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">Array</span>
+ <a href="#explodeString8" title="details" class="method-name">explodeString8</a>
+ (<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">null</span>])
+ </div>
+ <div class="method-definition">
+ <span class="method-result">Array</span>
+ <a href="#explodeString16" title="details" class="method-name">explodeString16</a>
+ (<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">null</span>])
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#getOption" title="details" class="method-name">getOption</a>
+ (<span class="var-type">string</span> <span class="var-name">$option</span>, [<span class="var-type">mixed</span> <span class="var-name">$defaultValue</span> = <span class="var-default">false</span>])
+ </div>
+ <div class="method-definition">
+ <span class="method-result">Array</span>
+ <a href="#getOptions" title="details" class="method-name">getOptions</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setOption" title="details" class="method-name">setOption</a>
+ (<span class="var-type">string</span> <span class="var-name">$option</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setOptions" title="details" class="method-name">setOptions</a>
+ (<span class="var-type"></span> <span class="var-name">&$options</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#__get" title="details" class="method-name">__get</a>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#__set" title="details" class="method-name">__set</a>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-descendents">Descendents</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$_reader" id="$_reader"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
+ <span class="var-name">$_reader</span>
+ (line <span class="line-number">56</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">The reader object.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-descendents">Descendents</a> |
+ <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
+ <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="method__construct" id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">72</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Constructs the class with given parameters and reads object related data from the ID3v2 tag.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">ID3_Object</span>
+ <span class="method-name">
+ __construct
+ </span>
+ ([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
+ <span class="var-name">$reader</span><span class="var-description">: The reader object.</span> </li>
+ <li>
+ <span class="var-type">Array</span>
+ <span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">&$options</span> </li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a href="../../php-reader/ID3/ID3_ExtendedHeader.html#method__construct">ID3_ExtendedHeader::__construct()</a>
+ : Constructs the class with given parameters and reads object related data from the ID3v2 tag.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a>
+ : Constructs the class with given parameters and reads object related data from the ID3v2 tag.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_AbstractLink.html#method__construct">ID3_Frame_AbstractLink::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_WXXX.html#method__construct">ID3_Frame_WXXX::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_AbstractText.html#method__construct">ID3_Frame_AbstractText::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_TXXX.html#method__construct">ID3_Frame_TXXX::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_AENC.html#method__construct">ID3_Frame_AENC::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_APIC.html#method__construct">ID3_Frame_APIC::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_ASPI.html#method__construct">ID3_Frame_ASPI::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_COMM.html#method__construct">ID3_Frame_COMM::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_COMR.html#method__construct">ID3_Frame_COMR::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_ENCR.html#method__construct">ID3_Frame_ENCR::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_EQU2.html#method__construct">ID3_Frame_EQU2::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_EQUA.html#method__construct">ID3_Frame_EQUA::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_ETCO.html#method__construct">ID3_Frame_ETCO::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_GEOB.html#method__construct">ID3_Frame_GEOB::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_GRID.html#method__construct">ID3_Frame_GRID::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_IPLS.html#method__construct">ID3_Frame_IPLS::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_LINK.html#method__construct">ID3_Frame_LINK::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_MLLT.html#method__construct">ID3_Frame_MLLT::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_OWNE.html#method__construct">ID3_Frame_OWNE::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_PCNT.html#method__construct">ID3_Frame_PCNT::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_POPM.html#method__construct">ID3_Frame_POPM::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_POSS.html#method__construct">ID3_Frame_POSS::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_PRIV.html#method__construct">ID3_Frame_PRIV::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_RBUF.html#method__construct">ID3_Frame_RBUF::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_RVA2.html#method__construct">ID3_Frame_RVA2::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_RVAD.html#method__construct">ID3_Frame_RVAD::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_RVRB.html#method__construct">ID3_Frame_RVRB::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_SEEK.html#method__construct">ID3_Frame_SEEK::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_SIGN.html#method__construct">ID3_Frame_SIGN::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_SYLT.html#method__construct">ID3_Frame_SYLT::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_SYTC.html#method__construct">ID3_Frame_SYTC::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_USER.html#method__construct">ID3_Frame_USER::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Frame_USLT.html#method__construct">ID3_Frame_USLT::__construct()</a>
+ : Constructs the class with given parameters and parses object related data.
+ </li>
+ <li>
+ <a href="../../php-reader/ID3/ID3_Header.html#method__construct">ID3_Header::__construct()</a>
+ : Constructs the class with given parameters and reads object related data from the ID3v2 tag.
+ </li>
+ </ul>
+ </div>
+<a name="methoddecodeSynchsafe32" id="decodeSynchsafe32"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">decodeSynchsafe32</span> (line <span class="line-number">165</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Decodes the given 28-bit synchsafe integer to regular 32-bit integer.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">integer</span>
+ <span class="method-name">
+ decodeSynchsafe32
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$val</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$val</span><span class="var-description">: The integer to decode</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methoddecodeUnsynchronisation" id="decodeUnsynchronisation"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">decodeUnsynchronisation</span> (line <span class="line-number">203</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Reverses the unsynchronisation scheme from the given data string.</p>
+ <ul class="tags">
+ <li><span class="field">see:</span> encodeUnsyncronisation</li>
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ decodeUnsynchronisation
+ </span>
+ (<span class="var-type"></span> <span class="var-name">&$data</span>, <span class="var-type">string</span> <span class="var-name">$data</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$data</span><span class="var-description">: The input data.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">&$data</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodencodeSynchsafe32" id="encodeSynchsafe32"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">encodeSynchsafe32</span> (line <span class="line-number">153</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Encodes the given 32-bit integer to 28-bit synchsafe integer, where the most significant bit of each byte is zero, making seven bits out of eight available.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">integer</span>
+ <span class="method-name">
+ encodeSynchsafe32
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$val</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$val</span><span class="var-description">: The integer to encode.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodencodeUnsynchronisation" id="encodeUnsynchronisation"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">encodeUnsynchronisation</span> (line <span class="line-number">184</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Applies the unsynchronisation scheme to the given data string.</p>
+<p class="description"><p>Whenever a false synchronisation is found within the data, one zeroed byte is inserted after the first false synchronisation byte. This has the side effect that all 0xff00 combinations have to be altered, so they will not be affected by the decoding process. Therefore all the 0xff00 combinations have to be replaced with the 0xff0000 combination during the unsynchronisation.</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ encodeUnsynchronisation
+ </span>
+ (<span class="var-type"></span> <span class="var-name">&$data</span>, <span class="var-type">string</span> <span class="var-name">$data</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$data</span><span class="var-description">: The input data.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">&$data</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodexplodeString8" id="explodeString8"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">explodeString8</span> (line <span class="line-number">248</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Splits UTF-8 or ISO-8859-1 formatted binary data according to null terminators residing in the string, up to a given limit.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">Array</span>
+ <span class="method-name">
+ explodeString8
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: The input string.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">$limit</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodexplodeString16" id="explodeString16"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">explodeString16</span> (line <span class="line-number">221</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Splits UTF-16 formatted binary data up according to null terminators residing in the string, up to a given limit.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">Array</span>
+ <span class="method-name">
+ explodeString16
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type"></span> <span class="var-name">$limit</span> = <span class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: The input string.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">$limit</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodgetOption" id="getOption"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getOption</span> (line <span class="line-number">92</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the given option value, or the default value if the option is not defined.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ getOption
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$option</span>, [<span class="var-type">mixed</span> <span class="var-name">$defaultValue</span> = <span class="var-default">false</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$option</span><span class="var-description">: The name of the option.</span> </li>
+ <li>
+ <span class="var-type">mixed</span>
+ <span class="var-name">$defaultValue</span><span class="var-description">: The default value to be returned.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodgetOptions" id="getOptions"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getOptions</span> (line <span class="line-number">83</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the options array.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">Array</span>
+ <span class="method-name">
+ getOptions
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetOption" id="setOption"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">setOption</span> (line <span class="line-number">112</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the given option the given value.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ setOption
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$option</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$option</span><span class="var-description">: The name of the option.</span> </li>
+ <li>
+ <span class="var-type">mixed</span>
+ <span class="var-name">$value</span><span class="var-description">: The value to set for the option.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetOptions" id="setOptions"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">setOptions</span> (line <span class="line-number">104</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the options array. See <a href="../../php-reader/ID3/ID3v2.html">ID3v2</a> class for available options.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ setOptions
+ </span>
+ (<span class="var-type"></span> <span class="var-name">&$options</span>, <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">Array</span>
+ <span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">&$options</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__get" id="__get"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">__get</span> (line <span class="line-number">123</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Magic function so that $obj->value will work.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ __get
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: The field name.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__set" id="__set"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">__set</span> (line <span class="line-number">137</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Magic function so that assignments with $obj->value will work.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ __set
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: The field name.</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: The field value.</span> </li>
+ </ul>
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 05 Sep 2008 20:19:10 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file |