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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
|
<?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</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</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-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">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>.</p>
<ul class="tags">
<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">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.php.html">/ID3/Frame.php</a> (line <span class="field">54</span>)
</p>
<pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a>
|
--ID3_Frame</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-const-summary">Constants</a> (<a href="#sec-consts">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_Frame_AbstractLink.html">ID3_Frame_AbstractLink</a></td>
<td>
A base class for all the URL link frames.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_AbstractText.html">ID3_Frame_AbstractText</a></td>
<td>
A base class for all the text frames.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_AENC.html">ID3_Frame_AENC</a></td>
<td>
The <em>Audio encryption</em> indicates if the actual audio stream is encrypted, and by whom.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_APIC.html">ID3_Frame_APIC</a></td>
<td>
The <em>Attached picture</em> frame contains a picture directly related to the audio file. Image format is the MIME type and subtype for the image.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_ASPI.html">ID3_Frame_ASPI</a></td>
<td>
Audio files with variable bit rates are intrinsically difficult to deal with
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_COMM.html">ID3_Frame_COMM</a></td>
<td>
The <em>Comments</em> frame is intended for any kind of full text information
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_COMR.html">ID3_Frame_COMR</a></td>
<td>
The <em>Commercial frame</em> enables several competing offers in the same tag by bundling all needed information. That makes this frame rather complex but it's an easier solution than if one tries to achieve the same result with several frames.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_ENCR.html">ID3_Frame_ENCR</a></td>
<td>
To identify with which method a frame has been encrypted the encryption method must be registered in the tag with the <em>Encryption method
registration</em> frame.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_EQU2.html">ID3_Frame_EQU2</a></td>
<td>
The <em>Equalisation (2)</em> is another subjective, alignment frame. It allows the user to predefine an equalisation curve within the audio file. There may be more than one EQU2 frame in each tag, but only one with the same identification string.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_EQUA.html">ID3_Frame_EQUA</a></td>
<td>
The <em>Equalisation</em> frame is another subjective, alignment frame. It allows the user to predefine an equalisation curve within the audio file.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_ETCO.html">ID3_Frame_ETCO</a></td>
<td>
The <em>Event timing codes</em> allows synchronisation with key events in the audio.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_GEOB.html">ID3_Frame_GEOB</a></td>
<td>
In the <em>General encapsulated object</em> frame any type of file can be encapsulated.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_GRID.html">ID3_Frame_GRID</a></td>
<td>
The <em>Group identification registration</em> frame enables grouping of otherwise unrelated frames. This can be used when some frames are to be signed. To identify which frames belongs to a set of frames a group identifier must be registered in the tag with this frame.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_IPLS.html">ID3_Frame_IPLS</a></td>
<td>
The <em>Involved people list</em> is a frame containing the names of those involved, and how they were involved. There may only be one IPLS frame in each tag.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_LINK.html">ID3_Frame_LINK</a></td>
<td>
The <em>Linked information</em> frame is used to keep information duplication
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_MCDI.html">ID3_Frame_MCDI</a></td>
<td>
This frame is intended for music that comes from a CD, so that the CD can be
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_MLLT.html">ID3_Frame_MLLT</a></td>
<td>
To increase performance and accuracy of jumps within a MPEG audio file, frames with time codes in different locations in the file might be useful.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_OWNE.html">ID3_Frame_OWNE</a></td>
<td>
The <em>Ownership frame</em> might be used as a reminder of a made transaction or, if signed, as proof. Note that the <a href="../../php-reader/ID3/ID3_Frame_USER.html">ID3_Frame_USER</a> and <a href="../../php-reader/ID3/ID3_Frame_TOWN.html">ID3_Frame_TOWN</a> frames are good to use in conjunction with this one.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_PCNT.html">ID3_Frame_PCNT</a></td>
<td>
The <em>Play counter</em> is simply a counter of the number of times a file has been played. The value is increased by one every time the file begins to play. There may only be one PCNT frame in each tag.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_POPM.html">ID3_Frame_POPM</a></td>
<td>
The purpose of the <em>Popularimeter</em> frame is to specify how good an audio
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_POSS.html">ID3_Frame_POSS</a></td>
<td>
The <em>Position synchronisation frame</em> delivers information to the listener of how far into the audio stream he picked up; in effect, it states the time offset from the first frame in the stream. There may only be one POSS frame in each tag.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_PRIV.html">ID3_Frame_PRIV</a></td>
<td>
The <em>Private frame</em> is used to contain information from a software
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_RBUF.html">ID3_Frame_RBUF</a></td>
<td>
Sometimes the server from which an audio file is streamed is aware of
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_RVA2.html">ID3_Frame_RVA2</a></td>
<td>
The <em>Relative volume adjustment (2)</em> frame is a more subjective frame than
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_RVAD.html">ID3_Frame_RVAD</a></td>
<td>
The <em>Relative volume adjustment</em> frame is a more subjective function
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_RVRB.html">ID3_Frame_RVRB</a></td>
<td>
The <em>Reverb</em> is yet another subjective frame, with which you can adjust
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_SEEK.html">ID3_Frame_SEEK</a></td>
<td>
The <em>Seek</em> frame indicates where other tags in a file/stream can be found. The minimum offset to next tag is calculated from the end of this tag to the beginning of the next. There may only be one seek frame in a tag.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_SIGN.html">ID3_Frame_SIGN</a></td>
<td>
This frame enables a group of frames, grouped with the
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_SYLT.html">ID3_Frame_SYLT</a></td>
<td>
The <em>Synchronised lyrics/text</em> frame is another way of incorporating the words, said or sung lyrics, in the audio file as text, this time, however, in sync with the audio. It might also be used to describing events e.g.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_SYTC.html">ID3_Frame_SYTC</a></td>
<td>
For a more accurate description of the tempo of a musical piece, the <em>Synchronised tempo codes</em> frame might be used.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_USER.html">ID3_Frame_USER</a></td>
<td>
The <em>Terms of use frame</em> contains a brief description of the terms of
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ID3/ID3_Frame_USLT.html">ID3_Frame_USLT</a></td>
<td>
The <em>Unsynchronised lyrics/text transcription</em> frame contains the lyrics of the song or a text transcription of other vocal activities. There may be more than one unsynchronised lyrics/text transcription frame in each tag, but only one with the same language and content descriptor.
</td>
</tr>
</table>
</div>
</div>
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendants</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</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">
<div class="const-summary">
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#COMPRESSION" title="details" class="const-name">COMPRESSION</a> = <span class="var-type"> 8</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DATA_LENGTH_INDICATOR" title="details" class="const-name">DATA_LENGTH_INDICATOR</a> = <span class="var-type"> 1</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DISCARD_ON_FILECHANGE" title="details" class="const-name">DISCARD_ON_FILECHANGE</a> = <span class="var-type"> 8192</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DISCARD_ON_TAGCHANGE" title="details" class="const-name">DISCARD_ON_TAGCHANGE</a> = <span class="var-type"> 16384</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#ENCRYPTION" title="details" class="const-name">ENCRYPTION</a> = <span class="var-type"> 4</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#GROUPING_IDENTITY" title="details" class="const-name">GROUPING_IDENTITY</a> = <span class="var-type"> 32</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#READ_ONLY" title="details" class="const-name">READ_ONLY</a> = <span class="var-type"> 4096</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#UNSYNCHRONISATION" title="details" class="const-name">UNSYNCHRONISATION</a> = <span class="var-type"> 2</span>
</div>
</div>
</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-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">string</span>
<a href="#$_data" title="details" class="var-name">$_data</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-const-summary">Constants</a> (<a href="#sec-consts">details</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</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="#getFlags" title="details" class="method-name">getFlags</a>
(<span class="var-type"></span> <span class="var-name">$flags</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getIdentifier" title="details" class="method-name">getIdentifier</a>
()
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#getSize" title="details" class="method-name">getSize</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#hasFlag" title="details" class="method-name">hasFlag</a>
(<span class="var-type">integer</span> <span class="var-name">$flag</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setData" title="details" class="method-name">setData</a>
(<span class="var-type">string</span> <span class="var-name">$data</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setFlags" title="details" class="method-name">setFlags</a>
(<span class="var-type">string</span> <span class="var-name">$flags</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setIdentifier" title="details" class="method-name">setIdentifier</a>
(<span class="var-type">string</span> <span class="var-name">$identifier</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-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$_data" id="$_data"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$_data</span>
= <span class="var-default"> ""</span> (line <span class="line-number">134</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Raw content of the frame.</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_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-const-summary">Constants</a> (<a href="#sec-consts">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">144</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">todo:</span> Only limited subset of flags are processed.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ID3_Frame</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_Object.html#method__construct">ID3_Object::__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_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>
</ul>
</div>
<a name="methodgetFlags" id="getFlags"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getFlags</span> (line <span class="line-number">230</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the frame flags byte.</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">
getFlags
</span>
(<span class="var-type"></span> <span class="var-name">$flags</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$flags</span> </li>
</ul>
</div>
<a name="methodgetIdentifier" id="getIdentifier"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getIdentifier</span> (line <span class="line-number">196</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the frame identifier string.</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">
getIdentifier
</span>
()
</div>
</div>
<a name="methodgetSize" id="getSize"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getSize</span> (line <span class="line-number">214</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the size of the data in the final frame, after encryption, compression and unsynchronisation. The size is excluding the frame header.</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">
getSize
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../../php-reader/ID3/ID3_Frame_ASPI.html#methodgetSize">ID3_Frame_ASPI::getSize()</a>
: Returns the number of index points in the frame.
</li>
</ul>
</div>
<a name="methodhasFlag" id="hasFlag"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">hasFlag</span> (line <span class="line-number">223</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether or not the flag is set. Returns <var>true</var> if the flag is set, <var>false</var> otherwise.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
hasFlag
</span>
(<span class="var-type">integer</span> <span class="var-name">$flag</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$flag</span><span class="var-description">: The flag to query.</span> </li>
</ul>
</div>
<a name="methodsetData" id="setData"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setData</span> (line <span class="line-number">244</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the frame raw data.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setData
</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> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../../php-reader/ID3/ID3_Frame_MCDI.html#methodsetData">ID3_Frame_MCDI::setData()</a>
: Sets the CD TOC binary dump.
</li>
</ul>
</div>
<a name="methodsetFlags" id="setFlags"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setFlags</span> (line <span class="line-number">237</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the frame flags byte.</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">
setFlags
</span>
(<span class="var-type">string</span> <span class="var-name">$flags</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$flags</span><span class="var-description">: The flags byte.</span> </li>
</ul>
</div>
<a name="methodsetIdentifier" id="setIdentifier"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setIdentifier</span> (line <span class="line-number">203</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the frame identifier.</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">
setIdentifier
</span>
(<span class="var-type">string</span> <span class="var-name">$identifier</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$identifier</span><span class="var-description">: The identifier.</span> </li>
</ul>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__toString</span> (line <span class="line-number">255</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">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../../php-reader/ID3/ID3_Frame_AbstractLink.html#method__toString">ID3_Frame_AbstractLink::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_WXXX.html#method__toString">ID3_Frame_WXXX::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_AbstractText.html#method__toString">ID3_Frame_AbstractText::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_TXXX.html#method__toString">ID3_Frame_TXXX::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_AENC.html#method__toString">ID3_Frame_AENC::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_APIC.html#method__toString">ID3_Frame_APIC::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_COMM.html#method__toString">ID3_Frame_COMM::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_COMR.html#method__toString">ID3_Frame_COMR::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_ENCR.html#method__toString">ID3_Frame_ENCR::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_EQU2.html#method__toString">ID3_Frame_EQU2::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_EQUA.html#method__toString">ID3_Frame_EQUA::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_ETCO.html#method__toString">ID3_Frame_ETCO::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_GEOB.html#method__toString">ID3_Frame_GEOB::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_GRID.html#method__toString">ID3_Frame_GRID::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_IPLS.html#method__toString">ID3_Frame_IPLS::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_LINK.html#method__toString">ID3_Frame_LINK::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_OWNE.html#method__toString">ID3_Frame_OWNE::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_PCNT.html#method__toString">ID3_Frame_PCNT::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_POPM.html#method__toString">ID3_Frame_POPM::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_POSS.html#method__toString">ID3_Frame_POSS::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_PRIV.html#method__toString">ID3_Frame_PRIV::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_RBUF.html#method__toString">ID3_Frame_RBUF::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_RVA2.html#method__toString">ID3_Frame_RVA2::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_RVAD.html#method__toString">ID3_Frame_RVAD::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_RVRB.html#method__toString">ID3_Frame_RVRB::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_SEEK.html#method__toString">ID3_Frame_SEEK::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_SIGN.html#method__toString">ID3_Frame_SIGN::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_SYLT.html#method__toString">ID3_Frame_SYLT::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_SYTC.html#method__toString">ID3_Frame_SYTC::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_USER.html#method__toString">ID3_Frame_USER::__toString()</a>
: Returns the frame raw data.
</li>
<li>
<a href="../../php-reader/ID3/ID3_Frame_USLT.html#method__toString">ID3_Frame_USLT::__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_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">
<a name="constCOMPRESSION" id="COMPRESSION"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">COMPRESSION</span>
= <span class="const-default"> 8</span>
(line <span class="line-number">90</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag indicates whether or not the frame is compressed. A <em>Data
Length Indicator</em> byte is included in the frame.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></li>
</ul>
</div>
<a name="constDATA_LENGTH_INDICATOR" id="DATA_LENGTH_INDICATOR"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DATA_LENGTH_INDICATOR</span>
= <span class="const-default"> 1</span>
(line <span class="line-number">118</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag indicates that a data length indicator has been added to the frame.</p>
<ul class="tags">
<li><span class="field">since:</span> ID3v2.4.0</li>
</ul>
</div>
<a name="constDISCARD_ON_FILECHANGE" id="DISCARD_ON_FILECHANGE"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DISCARD_ON_FILECHANGE</span>
= <span class="const-default"> 8192</span>
(line <span class="line-number">68</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag tells the tag parser what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data.</p>
</div>
<a name="constDISCARD_ON_TAGCHANGE" id="DISCARD_ON_TAGCHANGE"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DISCARD_ON_TAGCHANGE</span>
= <span class="const-default"> 16384</span>
(line <span class="line-number">61</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag tells the tag parser what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames.</p>
</div>
<a name="constENCRYPTION" id="ENCRYPTION"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ENCRYPTION</span>
= <span class="const-default"> 4</span>
(line <span class="line-number">102</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag indicates whether or not the frame is encrypted. If set, one byte indicating with which method it was encrypted will be added to the frame.</p>
<p class="description"><p>See description of the <a href="../../php-reader/ID3/ID3_Frame_ENCR.html">ID3_Frame_ENCR</a> frame for more information about encryption method registration. Encryption should be done after compression. Whether or not setting this flag requires the presence of a <em>Data Length Indicator</em> depends on the specific algorithm used.</p></p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></li>
</ul>
</div>
<a name="constGROUPING_IDENTITY" id="GROUPING_IDENTITY"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">GROUPING_IDENTITY</span>
= <span class="const-default"> 32</span>
(line <span class="line-number">82</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag indicates whether or not this frame belongs in a group with other frames. If set, a group identifier byte is added to the frame. Every frame with the same group identifier belongs to the same group.</p>
</div>
<a name="constREAD_ONLY" id="READ_ONLY"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">READ_ONLY</span>
= <span class="const-default"> 4096</span>
(line <span class="line-number">75</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag, if set, tells the software that the contents of this frame are intended to be read only. Changing the contents might break something, e.g. a signature.</p>
</div>
<a name="constUNSYNCHRONISATION" id="UNSYNCHRONISATION"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">UNSYNCHRONISATION</span>
= <span class="const-default"> 2</span>
(line <span class="line-number">110</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This flag indicates whether or not unsynchronisation was applied to this frame.</p>
<ul class="tags">
<li><span class="field">since:</span> ID3v2.4.0</li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:18:41 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
