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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
|
<?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_Frame_AbstractText</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_Frame_AbstractText</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>)
<a href="#sec-consts">Constants</a>
</div>
<div class="info-box-body">
<p class="implements">
Implements interfaces:
<ul>
<li><a href="../../php-reader/ID3/ID3_Encoding.html">ID3_Encoding</a></li> </ul>
</p>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A base class for all the text frames.</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---Frame---AbstractText.php.html">/ID3/Frame/AbstractText.php</a> (line <span class="field">54</span>)
</p>
<pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a>
|
--<a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a>
|
--ID3_Frame_AbstractText</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>)
<a href="#sec-consts">Constants</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_Frame_TALB.html">ID3_Frame_TALB</a></td>
<td>
The <em>Album/Movie/Show title</em> frame is intended for the title of the recording (or source of sound) from which the audio in the file is taken.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TBPM.html">ID3_Frame_TBPM</a></td>
<td>
The <em>BPM</em> frame contains the number of beats per minute in the main part of the audio. The BPM is an integer and represented as a numerical string.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TCOM.html">ID3_Frame_TCOM</a></td>
<td>
The <em>Composer</em> frame is intended for the name of the composer.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TCON.html">ID3_Frame_TCON</a></td>
<td>
The <em>Content type</em>, which ID3v1 was stored as a one byte numeric value only, is now a string. You may use one or several of the ID3v1 types as numerical strings, or, since the category list would be impossible to maintain with accurate and up to date categories, define your own.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TCOP.html">ID3_Frame_TCOP</a></td>
<td>
The <em>Copyright message</em> frame, in which the string must begin with a
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDAT.html">ID3_Frame_TDAT</a></td>
<td>
The <em>Date</em> frame is a numeric string in the DDMM format containing the date for the recording. This field is always four characters long.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDEN.html">ID3_Frame_TDEN</a></td>
<td>
The <em>Encoding time</em> frame contains a timestamp describing when the audio was encoded. Timestamp format is described in the <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2 structure document</a>.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDLY.html">ID3_Frame_TDLY</a></td>
<td>
The <em>Playlist delay</em> defines the numbers of milliseconds of silence that should be inserted before this audio. The value zero indicates that this is a part of a multifile audio track that should be played continuously.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDOR.html">ID3_Frame_TDOR</a></td>
<td>
The <em>Original release time</em> frame contains a timestamp describing when the original recording of the audio was released. Timestamp format is described in the <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2
structure document</a>.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDRC.html">ID3_Frame_TDRC</a></td>
<td>
The <em>Recording time</em> frame contains a timestamp describing when the audio was recorded. Timestamp format is described in the <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2 structure document</a>.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDRL.html">ID3_Frame_TDRL</a></td>
<td>
The <em>Release time</em> frame contains a timestamp describing when the audio was first released. Timestamp format is described in the <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2 structure document</a>.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TDTG.html">ID3_Frame_TDTG</a></td>
<td>
The <em>Tagging time</em> frame contains a timestamp describing then the audio was tagged. Timestamp format is described in the <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2 structure document</a>.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TENC.html">ID3_Frame_TENC</a></td>
<td>
The <em>Encoded by</em> frame contains the name of the person or organisation that encoded the audio file. This field may contain a copyright message, if the audio file also is copyrighted by the encoder.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TEXT.html">ID3_Frame_TEXT</a></td>
<td>
The <em>Lyricist/Text writer</em> frame is intended for the writer of the text or lyrics in the recording.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TFLT.html">ID3_Frame_TFLT</a></td>
<td>
The <em>File type</em> frame indicates which type of audio this tag defines.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TIME.html">ID3_Frame_TIME</a></td>
<td>
The <em>Time</em> frame is a numeric string in the HHMM format containing the time for the recording. This field is always four characters long.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TIPL.html">ID3_Frame_TIPL</a></td>
<td>
The <em>Involved people list</em> is very similar to the musician credits list, but maps between functions, like producer, and names.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TIT1.html">ID3_Frame_TIT1</a></td>
<td>
The <em>Content group description</em> frame is used if the sound belongs to a larger category of sounds/music. For example, classical music is often sorted in different musical sections (e.g. "Piano Concerto", "Weather - Hurricane").
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TIT2.html">ID3_Frame_TIT2</a></td>
<td>
The <em>Title/Songname/Content description</em> frame is the actual name of the piece (e.g. "Adagio", "Hurricane Donna").
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TIT3.html">ID3_Frame_TIT3</a></td>
<td>
The <em>Subtitle/Description refinement</em> frame is used for information directly related to the contents title (e.g. "Op. 16" or "Performed live at Wembley").
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TKEY.html">ID3_Frame_TKEY</a></td>
<td>
The <em>Initial key</em> frame contains the musical key in which the sound
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TLAN.html">ID3_Frame_TLAN</a></td>
<td>
The <em>Language</em> frame should contain the languages of the text or lyrics
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TLEN.html">ID3_Frame_TLEN</a></td>
<td>
The <em>Length</em> frame contains the length of the audio file in milliseconds, represented as a numeric string.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TMCL.html">ID3_Frame_TMCL</a></td>
<td>
The <em>Musician credits list</em> is intended as a mapping between instruments and the musician that played it. Every odd field is an instrument and every even is an artist or a comma delimited list of artists.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TMED.html">ID3_Frame_TMED</a></td>
<td>
The <em>Media type</em> frame describes from which media the sound originated.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TMOO.html">ID3_Frame_TMOO</a></td>
<td>
The <em>Mood</em> frame is intended to reflect the mood of the audio with a few keywords, e.g. "Romantic" or "Sad".
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TOAL.html">ID3_Frame_TOAL</a></td>
<td>
The <em>Original album/movie/show title</em> frame is intended for the title of the original recording (or source of sound), if for example the music in the file should be a cover of a previously released song.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TOFN.html">ID3_Frame_TOFN</a></td>
<td>
The <em>Original filename</em> frame contains the preferred filename for the file, since some media doesn't allow the desired length of the filename. The filename is case sensitive and includes its suffix.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TOLY.html">ID3_Frame_TOLY</a></td>
<td>
The <em>Original lyricist/text writer</em> frame is intended for the text writer of the original recording, if for example the music in the file should be a cover of a previously released song.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TOPE.html">ID3_Frame_TOPE</a></td>
<td>
The <em>Original artist/performer</em> frame is intended for the performer of the original recording, if for example the music in the file should be a cover of a previously released song.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TORY.html">ID3_Frame_TORY</a></td>
<td>
The <em>Original release year</em> frame is intended for the year when the original recording, if for example the music in the file should be a cover of a previously released song, was released. The field is formatted as in the <a href="../../php-reader/ID3/ID3_Frame_TYER.html">ID3_Frame_TYER</a> frame.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TOWN.html">ID3_Frame_TOWN</a></td>
<td>
The <em>File owner/licensee</em> frame contains the name of the owner or licensee of the file and it's contents.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPE1.html">ID3_Frame_TPE1</a></td>
<td>
The <em>Lead artist/Lead performer/Soloist/Performing group</em> is used for the main artist.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPE2.html">ID3_Frame_TPE2</a></td>
<td>
The <em>Band/Orchestra/Accompaniment</em> frame is used for additional information about the performers in the recording.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPE3.html">ID3_Frame_TPE3</a></td>
<td>
The <em>Conductor</em> frame is used for the name of the conductor.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPE4.html">ID3_Frame_TPE4</a></td>
<td>
The <em>Interpreted, remixed, or otherwise modified by</em> frame contains more information about the people behind a remix and similar interpretations of another existing piece.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPOS.html">ID3_Frame_TPOS</a></td>
<td>
The <em>Part of a set</em> frame is a numeric string that describes which part of a set the audio came from. This frame is used if the source described in the <a href="../../php-reader/ID3/ID3_Frame_TALB.html">ID3_Frame_TALB</a> frame is divided into several mediums, e.g.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPRO.html">ID3_Frame_TPRO</a></td>
<td>
The <em>Produced notice</em> frame, in which the string must begin with a year and a space character (making five characters), is intended for the production copyright holder of the original sound, not the audio file itself.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TPUB.html">ID3_Frame_TPUB</a></td>
<td>
The <em>Publisher</em> frame simply contains the name of the label or publisher.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TRCK.html">ID3_Frame_TRCK</a></td>
<td>
The <em>Track number/Position in set</em> frame is a numeric string containing the order number of the audio-file on its original recording. This may be extended with a "/" character and a numeric string containing the total number of tracks/elements on the original recording. E.g. "4/9".
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TRDA.html">ID3_Frame_TRDA</a></td>
<td>
The <em>Recording dates</em> frame is intended to be used as complement to the <a href="../../php-reader/ID3/ID3_Frame_TYER.html">ID3_Frame_TYER</a>, <a href="../../php-reader/ID3/ID3_Frame_TDAT.html">ID3_Frame_TDAT</a> and <a href="../../php-reader/ID3/ID3_Frame_TIME.html">ID3_Frame_TIME</a> frames. E.g. "4th-7th June, 12th June" in combination with the <a href="../../php-reader/ID3/ID3_Frame_TYER.html">ID3_Frame_TYER</a> frame.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TRSN.html">ID3_Frame_TRSN</a></td>
<td>
The <em>Internet radio station name</em> frame contains the name of the internet radio station from which the audio is streamed.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TRSO.html">ID3_Frame_TRSO</a></td>
<td>
The <em>Internet radio station owner</em> frame contains the name of the owner of the internet radio station from which the audio is streamed.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSIZ.html">ID3_Frame_TSIZ</a></td>
<td>
The <em>Size</em> frame contains the size of the audiofile in bytes, excluding the ID3v2 tag, represented as a numeric string.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSOA.html">ID3_Frame_TSOA</a></td>
<td>
The <em>Album sort order</em> frame defines a string which should be used instead of the <a href="../../php-reader/ID3/ID3_Frame_TALB.html">ID3_Frame_TALB</a> album name frame for sorting purposes.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSOP.html">ID3_Frame_TSOP</a></td>
<td>
The <em>Performer sort order</em> frame defines a string which should be used instead of the <a href="../../php-reader/ID3/ID3_Frame_TPE2.html">ID3_Frame_TPE2</a> performer frame for sorting purposes.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSOT.html">ID3_Frame_TSOT</a></td>
<td>
The <em>Title sort order</em> frame defines a string which should be used instead of the <a href="../../php-reader/ID3/ID3_Frame_TIT2.html">ID3_Frame_TIT2</a> title frame for sorting purposes.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_ISRC.html">ID3_Frame_ISRC</a></td>
<td>
The <em>ISRC</em> frame should contain the International Standard Recording Code (12 characters).
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSSE.html">ID3_Frame_TSSE</a></td>
<td>
The <em>Software/Hardware and settings used for encoding</em> frame includes the used audio encoder and its settings when the file was encoded. Hardware refers to hardware encoders, not the computer on which a program was run.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TSST.html">ID3_Frame_TSST</a></td>
<td>
The <em>Set subtitle</em> frame is intended for the subtitle of the part of a set this track belongs to.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TXXX.html">ID3_Frame_TXXX</a></td>
<td>
This frame is intended for one-string text information concerning the audio
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_TYER.html">ID3_Frame_TYER</a></td>
<td>
The <em>Year</em> frame is a numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
</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>)
<a href="#sec-consts">Constants</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$_encoding" title="details" class="var-name">$_encoding</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_text" title="details" class="var-name">$_text</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-consts">Constants</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_Frame_AbstractText</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="#getEncoding" title="details" class="method-name">getEncoding</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getText" title="details" class="method-name">getText</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getTexts" title="details" class="method-name">getTexts</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setEncoding" title="details" class="method-name">setEncoding</a>
(<span class="var-type">integer</span> <span class="var-name">$encoding</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setText" title="details" class="method-name">setText</a>
(<span class="var-type">mixed</span> <span class="var-name">$text</span>, [<span class="var-type">integer</span> <span class="var-name">$encoding</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#__toString" title="details" class="method-name">__toString</a>
()
</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-consts">Constants</a>
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$_encoding" id="$_encoding"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$_encoding</span>
= <span class="var-default"> ID3_Encoding::UTF8</span> (line <span class="line-number">62</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The text encoding.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$_text" id="$_text"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_text</span>
(line <span class="line-number">69</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The text array.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ID3/ID3_Frame.html#var$_data">ID3_Frame::$_data</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ID3/ID3_Object.html#var$_reader">ID3_Object::$_reader</a></span><br>
</span>
</blockquote>
</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-consts">Constants</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="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">77</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the class with given parameters and parses object related data.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ID3_Frame_AbstractText</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">Redefinition of:</div>
<dl>
<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></dt>
<dd>Constructs the class with given parameters and reads object related data from the ID3v2 tag.</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<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>
</ul>
</div>
<a name="methodgetEncoding" id="getEncoding"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getEncoding</span> (line <span class="line-number">106</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the text encoding.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getEncoding
</span>
()
</div>
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt><a href="../../php-reader/ID3/ID3_Encoding.html#methodgetEncoding">ID3_Encoding::getEncoding()</a></dt>
<dd>Returns the text encoding.</dd>
</dl>
</div>
<a name="methodgetText" id="getText"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getText</span> (line <span class="line-number">121</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the first text chunk the frame contains.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getText
</span>
()
</div>
</div>
<a name="methodgetTexts" id="getTexts"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getTexts</span> (line <span class="line-number">128</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of texts the frame contains.</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">
getTexts
</span>
()
</div>
</div>
<a name="methodsetEncoding" id="setEncoding"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setEncoding</span> (line <span class="line-number">114</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the text encoding.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../../php-reader/ID3/ID3_Encoding.html">ID3_Encoding</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setEncoding
</span>
(<span class="var-type">integer</span> <span class="var-name">$encoding</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$encoding</span><span class="var-description">: The text encoding.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt><a href="../../php-reader/ID3/ID3_Encoding.html#methodsetEncoding">ID3_Encoding::setEncoding()</a></dt>
<dd>Sets the text encoding.</dd>
</dl>
</div>
<a name="methodsetText" id="setText"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setText</span> (line <span class="line-number">136</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the text using given encoding.</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">
setText
</span>
(<span class="var-type">mixed</span> <span class="var-name">$text</span>, [<span class="var-type">integer</span> <span class="var-name">$encoding</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$text</span><span class="var-description">: The test string or an array of strings.</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$encoding</span><span class="var-description">: The text encoding.</span> </li>
</ul>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__toString</span> (line <span class="line-number">148</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the frame raw data.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
__toString
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></dt>
<dd>Returns the frame raw data.</dd>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../../php-reader/ID3/ID3_Frame_TXXX.html#method__toString">ID3_Frame_TXXX::__toString()</a>
: Returns the frame raw data.
</li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetFlags">ID3_Frame::getFlags()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetIdentifier">ID3_Frame::getIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetSize">ID3_Frame::getSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodhasFlag">ID3_Frame::hasFlag()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetData">ID3_Frame::setData()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetFlags">ID3_Frame::setFlags()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetIdentifier">ID3_Frame::setIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__construct">ID3_Object::__construct()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeSynchsafe32">ID3_Object::decodeSynchsafe32()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeUnsynchronisation">ID3_Object::decodeUnsynchronisation()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeSynchsafe32">ID3_Object::encodeSynchsafe32()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeUnsynchronisation">ID3_Object::encodeUnsynchronisation()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString8">ID3_Object::explodeString8()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString16">ID3_Object::explodeString16()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOption">ID3_Object::getOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOptions">ID3_Object::getOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOption">ID3_Object::setOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOptions">ID3_Object::setOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__get">ID3_Object::__get()</a></span><br>
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__set">ID3_Object::__set()</a></span><br>
</blockquote>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendants</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</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">
<h4>Inherited Constants</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
<blockquote>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constCOMPRESSION">ID3_Frame::COMPRESSION</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_FILECHANGE">ID3_Frame::DISCARD_ON_FILECHANGE</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_TAGCHANGE">ID3_Frame::DISCARD_ON_TAGCHANGE</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constENCRYPTION">ID3_Frame::ENCRYPTION</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constGROUPING_IDENTITY">ID3_Frame::GROUPING_IDENTITY</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constREAD_ONLY">ID3_Frame::READ_ONLY</a></span><br>
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constUNSYNCHRONISATION">ID3_Frame::UNSYNCHRONISATION</a></span><br>
</span>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:18:14 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
