[BUGFIX] Reports module broken due to wrong status strings
[Packages/TYPO3.CMS.git] / typo3 / sysext / css_styled_content / Documentation / Configuration / Objects / Media / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../../Includes.txt
7
8
9 .. _objects-media:
10
11 Media
12 """""
13
14 The Media content element acts as a dispatcher for different media
15 output formats.
16
17
18 .. figure:: ../../../Images/MediaContentElementStructure.png
19 :alt: Media element and media formats
20
21 The MEDIA element and the various media formats
22
23
24 The Media content element is a dispatcher which gets its HTML output
25 from one of the available render objects. By default, these render
26 objects include SWFOBJECT (Flash driven by Javascript), QTOBJECT
27 (Quicktime driven by Javascript) and MULTIMEDIA (the original
28 MULTIMEDIA object rendered with EMBED tags).
29
30 The renderType defines which object is used for rendering. If set to
31 its default value of "auto", the Media content element uses the media
32 file's extension to choose the right renderer. This auto-detection may
33 not work as well for external URLs so setting the renderType manually
34 is preferable in that case.
35
36 If one of the existing renderTypes does not meet your needs, new
37 renderTypes can be registered and rendered with a custom extension.
38
39 The Media content element contains the following third-party
40 files in :file:`typo3/contrib/flashmedia`:
41
42 - :file:`qtobject/qtobject.js` (Javascript for QTOBJECT)
43
44 - :file:`swfobject/swfobject.js` (Javascript for SWFOBJECT)
45
46 - :file:`swfobject/expressInstall.swf` (this is displayed if Flash version of
47 client is too low)
48
49 - :file:`flvplayer.swf` (TYPO3 video player for flv, swf, mp4, m4u etc)
50
51 - :file:`player.swf` (Audio player from 1pixelout)
52
53 - :file:`player.txt` (License for audio player)
54
55 If you want to use a different player, it can be configured via
56 TypoScript.
57
58
59 .. _objects-media-reference:
60
61 MEDIA Reference
62 ~~~~~~~~~~~~~~~
63
64
65 .. _objects-media-reference-flexparams:
66
67 flexParams
68 ''''''''''
69
70 .. container:: table-row
71
72 Property
73 flexParams
74
75 Data type
76 :ref:`stdWrap <t3tsref:stdwrap>`
77
78 Description
79 Used for Flexform configuration of the content element
80
81 Default
82 flexParams.field = pi\_flexform
83
84
85
86 .. _objects-media-reference-alternativecontent:
87
88 alternativeContent
89 ''''''''''''''''''
90
91 .. container:: table-row
92
93 Property
94 alternativeContent
95
96 Data type
97 :ref:`stdWrap <t3tsref:stdwrap>`
98
99 Description
100 Alternative content
101
102 Default
103 alternativeContent.field = bodytext
104
105
106
107 .. _objects-media-reference-type:
108
109 type
110 ''''
111
112 .. container:: table-row
113
114 Property
115 type
116
117 Data type
118 string
119
120 Description
121 Defines media type: video/audio
122
123 Default
124 video
125
126
127
128 .. _objects-media-reference-rendertype:
129
130 renderType
131 ''''''''''
132
133 .. container:: table-row
134
135 Property
136 renderType
137
138 Data type
139 string
140
141 Description
142 Used for select the render object. Possible renderTypes are:
143 auto/swf/qt/object. Extensions may add custom renderTypes as well.
144
145 Default
146 auto
147
148
149
150 .. _objects-media-reference-allowemptyurl:
151
152 allowEmptyUrl
153 '''''''''''''
154
155 .. container:: table-row
156
157 Property
158 allowEmptyUrl
159
160 Data type
161 boolean
162
163 Description
164 If set to 0 you see a warning if no file/URL is configured. If you do
165 some advanced setup such as a Javascript-driven player with a playlist
166 you may use the object without a URL and need to set the value to 1.
167
168 Default
169 0
170
171
172
173 .. _objects-media-reference-mimehandler:
174
175 mimeHandler
176 '''''''''''
177
178 .. container:: table-row
179
180 Property
181 mimeHandler
182
183 Data type
184 array
185
186 Description
187 The mappings between file extensions and render types can be
188 configured here and will be used when renderType=auto. Possible values
189 are MEDIA, SWF, QT
190
191 Default
192 ::
193
194 mimeHandler {
195 default = MEDIA
196 mp3 = SWF
197 mp4 = SWF
198 m4v = SWF
199 mov = QT
200 avi = MEDIA
201 asf = MEDIA
202 class = MEDIA
203 swa = SWF
204 }
205
206
207
208 .. _objects-media-reference-mimeconf-swfobject:
209
210 mimeConf.swfobject
211 ''''''''''''''''''
212
213 .. container:: table-row
214
215 Property
216 mimeConf.swfobject
217
218 mimeConf.qtobject
219
220 Data type
221 array
222
223 Description
224 Copy of configuration for SWFOBJECT and QTOBJECT
225
226 Default
227 mimeConf.swfobject < tt\_content.swfobject.20
228
229 mimeConf.qtobject < tt\_content.qtobject.20
230
231
232
233 .. _objects-media-reference-video:
234
235 Video Player Reference
236 ~~~~~~~~~~~~~~~~~~~~~~
237
238
239 .. _objects-media-reference-video-player:
240
241 player
242 ''''''
243
244 .. container:: table-row
245
246 Property
247 player
248
249 Data type
250 string
251
252 Description
253 Location of video player
254
255 Default
256 {$styles.content.media.videoPlayer}
257
258 typo3/contrib/flashmedia/flvplayer.swf
259
260
261
262 .. _objects-media-reference-video-defaultwidth:
263
264 defaultWidth
265 ''''''''''''
266
267 .. container:: table-row
268
269 Property
270 defaultWidth
271
272 Data type
273 int
274
275 Description
276 Default video media width
277
278 Default
279 {$styles.content.media.defaultVideoWidth}
280
281 600
282
283
284
285 .. _objects-media-reference-video-defaultheight:
286
287 defaultHeight
288 '''''''''''''
289
290 .. container:: table-row
291
292 Property
293 defaultHeight
294
295 Data type
296 int
297
298 Description
299 Default video media height
300
301 Default
302 {$styles.content.media.defaultVideoHeight}
303
304 400
305
306
307
308 .. _objects-media-reference-video-default:
309
310 default
311 '''''''
312
313 .. container:: table-row
314
315 Property
316 default
317
318 Data type
319 array
320
321 Description
322 Default parameters for flashvars / params / attributes
323
324 **Usage:**
325
326 ::
327
328 default {
329 flashvars.allowFullScreen = true
330 params.wmode = transparent
331 attributes.align = center
332 }
333
334 flashvars are used for swf file configuration. There is no standard
335 across players, but for flvplayer see description below.
336
337 For detailed description of possible params/attributes visit this URL:
338
339 http://helpx.adobe.com/flash/kb/flash-object-embed-tag-attributes.html
340
341 Default
342 ::
343
344 default {
345 params.quality = high
346 params.wmode = transparent
347 params.menu = false
348 params.allowScriptAccess =
349 sameDomain
350 params.allowFullScreen = true
351 }
352
353
354
355 .. _objects-media-reference-video-mapping:
356
357 mapping
358 '''''''
359
360 .. container:: table-row
361
362 Property
363 mapping
364
365 Data type
366 array
367
368 Description
369 If you want to rename predefined vars you can use mapping. See
370 tt\_content.media.20.audio where it's needed
371
372
373
374
375 .. _objects-media-reference-audio:
376
377 Audio Player Reference
378 ~~~~~~~~~~~~~~~~~~~~~~
379
380
381 .. _objects-media-reference-audio-player:
382
383 player
384 ''''''
385
386 .. container:: table-row
387
388 Property
389 player
390
391 Data type
392 string
393
394 Description
395 Location of audio player
396
397 Default
398 {$styles.content.media.audioPlayer}
399
400 typo3/contrib/flashmedia/player.swf
401
402
403
404 .. _objects-media-reference-audio-defaultwidth:
405
406 defaultWidth
407 ''''''''''''
408
409 .. container:: table-row
410
411 Property
412 defaultWidth
413
414 Data type
415 int
416
417 Description
418 Default audio media width
419
420 Default
421 {$styles.content.media.defaultAudioWidth}
422
423 600
424
425
426
427 .. _objects-media-reference-audio-defaultheight:
428
429 defaultHeight
430 '''''''''''''
431
432 .. container:: table-row
433
434 Property
435 defaultHeight
436
437 Data type
438 int
439
440 Description
441 Default audio media height
442
443 Default
444 {$styles.content.media.defaultAudioHeight}
445
446 400
447
448
449
450 .. _objects-media-reference-audio-default:
451
452 default
453 '''''''
454
455 .. container:: table-row
456
457 Property
458 default
459
460 Data type
461 array
462
463 Description
464 Default parameter for flashvars / params / attributes
465
466 Usage::
467
468 default {
469 flashvars.allowFullScreen = true
470 params.wmode = transparent
471 attributes.align = center
472 }
473
474
475 Flashvars are used for swf file configuration. There is no standard
476 across players, but for flvplayer see description below.
477
478 For detailed description of possible params/attributes visit this URL:
479
480 http://helpx.adobe.com/flash/kb/flash-object-embed-tag-attributes.html
481
482 Default
483 ::
484
485 default {
486 params.quality = high
487 params.wmode = transparent
488 params.allowScriptAccess =
489 sameDomain
490 params.menu = false
491 }
492
493
494
495 .. _objects-media-reference-audio-mapping:
496
497 mapping
498 '''''''
499
500 .. container:: table-row
501
502 Property
503 mapping
504
505 Data type
506 array
507
508 Description
509 The audio player doesn't work with file, but instead expects the file
510 with the flashvar soundFile. mapping does the rename of parameter for
511 you by default.
512
513 Default
514 ::
515
516 mapping {
517 flashvars.file = soundFile
518 }
519
520
521
522 .. _objects-media-reference-swfobject:
523
524 SWFOBJECT Reference
525 ~~~~~~~~~~~~~~~~~~~
526
527
528 .. _objects-media-reference-swfobject-file:
529
530 file
531 ''''
532
533 .. container:: table-row
534
535 Property
536 file
537
538 Data type
539 :ref:`stdWrap <t3tsref:stdwrap>`
540
541 Description
542 Media file or URL
543
544
545
546 .. _objects-media-reference-swfobject-width:
547
548 width
549 '''''
550
551 .. container:: table-row
552
553 Property
554 width
555
556 Data type
557 int
558
559 Description
560 Width of swfObject
561
562
563
564 .. _objects-media-reference-swfobject-height:
565
566 height
567 ''''''
568
569 .. container:: table-row
570
571 Property
572 height
573
574 Data type
575 int
576
577 Description
578 Height of swfObject
579
580
581
582 .. _objects-media-reference-swfobject-flexparams:
583
584 flexParams
585 ''''''''''
586
587 .. container:: table-row
588
589 Property
590 flexParams
591
592 Data type
593 Flexform configuration
594
595
596 Description
597 Used for Flexform configuration of the CE
598
599 Default
600 flexParams.field = pi\_flexform
601
602
603
604 .. _objects-media-reference-swfobject-alternativecontent:
605
606 alternativeContent
607 ''''''''''''''''''
608
609 .. container:: table-row
610
611 Property
612 alternativeContent
613
614 Data type
615 :ref:`stdWrap <t3tsref:stdwrap>`
616
617 Description
618 Alternative content
619
620 Default
621 alternativeContent.field = bodytext
622
623
624
625 .. _objects-media-reference-swfobject-layout:
626
627 layout
628 ''''''
629
630 .. container:: table-row
631
632 Property
633 layout
634
635 Data type
636 :ref:`stdWrap <t3tsref:stdwrap>`
637
638 Description
639 HTML Template for the Object. ###SWFOBJECT### is replaced with the
640 sfwobject, ###ID### is replaced with the unique Id of the div/object
641
642 Default
643 ###SWFOBJECT###
644
645
646
647 .. _objects-media-reference-swfobject-video-player:
648
649 video.player
650 ''''''''''''
651
652 .. container:: table-row
653
654 Property
655 :ref:`video.player <objects-media-reference-video>`
656
657 :ref:`audio.player <objects-media-reference-audio>`
658
659 Data type
660 Array of properties
661
662 Description
663 Properties of each player.
664
665
666 .. _objects-media-reference-qtobject:
667
668 QTOBJECT Reference
669 ~~~~~~~~~~~~~~~~~~
670
671
672 .. _objects-media-reference-qtobject-file:
673
674 file
675 ''''
676
677 .. container:: table-row
678
679 Property
680 file
681
682 Data type
683 :ref:`stdWrap <t3tsref:stdwrap>`
684
685 Description
686 Media file or URL
687
688
689
690 .. _objects-media-reference-qtobject-width:
691
692 width
693 '''''
694
695 .. container:: table-row
696
697 Property
698 width
699
700 Data type
701 int
702
703 Description
704 Width of qtObject
705
706
707
708 .. _objects-media-reference-qtobject-height:
709
710 height
711 ''''''
712
713 .. container:: table-row
714
715 Property
716 height
717
718 Data type
719 int
720
721 Description
722 Height of qtObject
723
724
725
726 .. _objects-media-reference-qtobject-flexparams:
727
728 flexParams
729 ''''''''''
730
731 .. container:: table-row
732
733 Property
734 flexParams
735
736 Data type
737 Flexform configuration
738
739 Description
740 Used for Flexform configuration of the CE
741
742 Default
743 flexParams.field = pi\_flexform
744
745
746
747 .. _objects-media-reference-qtobject-alternativecontent:
748
749 alternativeContent
750 ''''''''''''''''''
751
752 .. container:: table-row
753
754 Property
755 alternativeContent
756
757 Data type
758 :ref:`stdWrap <t3tsref:stdwrap>`
759
760 Description
761 Alternative content
762
763 Default
764 alternativeContent.field = bodytext
765
766
767
768 .. _objects-media-reference-qtobject-layout:
769
770 layout
771 ''''''
772
773 .. container:: table-row
774
775 Property
776 layout
777
778 Data type
779 :ref:`stdWrap <t3tsref:stdwrap>`
780
781 Description
782 HTML Template for the Object. ###QTOBJECT### is replaced with the
783 qtobject, ###ID### is replaced with the unique Id of the div/object
784
785 Default
786 ###QTOBJECT###
787
788
789
790 .. _objects-media-reference-qtobject-video-player:
791
792 video.player
793 ''''''''''''
794
795 .. container:: table-row
796
797 Property
798 :ref:`video.player <objects-media-reference-video>`
799
800 :ref:`audio.player <objects-media-reference-audio>`
801
802 Data type
803 Array of properties
804
805 Description
806 Properties of each player.
807