DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

VIDEO

Returns a video tag with the sources defined in the property "parameter".

Defined as PHP class Html5VideoContentObject in typo3conf/ext/crystalis/Classes/ContentObject/Html5VideoContentObject.php.

Property

if

Data type

->if

Description

If "if" returns false, the video element is not generated.

Property

flexParams

Data type

string / stdWrap

Description

The FlexForm configuration of the content element.

If this is set, the parameter array will be ignored.

Default

flexParams.field = pi_flexform

Property

mimeConf.flash

Data type

array

Description

Configuration for specific formats.

At present property player is the only supported one.

Example:

mimeConf.flash.player = typo3/contrib/flashmedia/flvplayer.swf

Property

parameter

Data type

->parameter

Description

Configuration of video sources and player options.

If FlexForm is filled with values, this array will be ignored.

Property

stdWrap

Data type

stdWrap

parameter

Property

mp4

Data type

resource

Description

mp4 video source.

Can be either a relative path or a sys_file ID. The latter one has to be prepended with file:.

Example:

mp4 = fileadmin/videos/myvideo.mp4

Property

webm

Data type

resource

Description

WebM video source.

Can be either a relative path or a sys_file ID. The latter one has to be prepended with file:.

Example:

webm = file:1

Property

ogg

Data type

resource

Description

Ogg video source.

Can be either a relative path or a sys_file ID. The latter one has to be prepended with file:.

Example:

ogg = EXT:myext/Resources/Public/Videos/myvideo.ogg

Property

flash

Data type

resource

Description

Adobe Flash fallback. Will be rendered as object tag.

Can be either a relative path or a sys_file ID. The latter one has to be prepended with file:.

Example:

flash = fileadmin/videos/myvideo.swf

Property

poster

Data type

resource

Description

Poster image.

Can be either a relative path or a sys_file ID. The latter one has to be prepended with file:.

Example:

poster = fileadmin/videos/myvideo-poster.jpg

Property

width

Data type

pixels

Description

The width of the generated video element.

Default

720

Property

height

Data type

pixels

Description

The height of the generated video element.

Default

576

Property

preload

Data type

boolean

Description

Forces the browser to preload the video.

Default

0

Property

autoplay

Data type

boolean

Description

Starts the video as soon as the page has loaded.

Default

0

Property

loop

Data type

boolean

Description

Tries to restart the video as soon as it finishes.

Default

0

Property

controls

Data type

boolean

Description

Shows default player controls (depending on operating system and video player).

Default

0

Examples:

Standard rendering

 1: 10 = VIDEO
 2: 10{
 3:      flexParams{
 4:           field = pi_flexform
 5:      }
 6:      mineConf{
 7:           flash{
 8:                player = typo3/contrib/flashmedia/flvplayer.swf
 9:           }
10:      }
11: }

This returns a video tag depending on the contents of the field pi_flexform.

Autonomous rendering

 1: 10 = VIDEO
 2: 10{
 3:      mimeConf{
 4:           flash{
 5:                player = typo3/contrib/flashmedia/flvplayer.swf
 6:           }
 7:      }
 8:      parameter{
 9:           mp4 = fileadmin/name-of-mp4-source.mp4
10:           webm = fileadmin/name-of-webm-source.webm
11:           ogg = fileadmin/name-of-ogg-source.ogg
12:           flash = fileadmin/name-of-flash-source.flv
13:           poster = fileadmin/name-of-preview-image.jpg
14:           width = 1920
15:           height = 1080
16:           preload = 1
17:           autoplay = 1
18:      }
19: }

This returns:

<video width="1920" height="1080"  preload="auto" autoplay poster="fileadmin/name-of-preview-image.jpg">
    <source src="fileadmin/name-of-mp4-source.mp4" type="video/mp4">
    <source src="fileadmin/name-of-webm-source.webm" type="video/webm">
    <source src="fileadmin/name-of-ogg-source.ogg" type="video/ogg">
    <object width="1920" height="1080" type="application/x-shockwave-flash" data="typo3/contrib/flashmedia/flvplayer.swf">
        <param name="movie" value="typo3/contrib/flashmedia/flvplayer.swf">
        <param name="wmode" value="transparent">
        <param name="allowFullScreen" value="true">
        <param name="allowScriptAccess" value="sameDomain">
        <param name="flashvars" value="file=fileadmin/name-of-flash-source.flv&autoPlay=true">
        <img src="fileadmin/name-of-preview-image.jpg" width="1920" height="1080" alt="">
    </object>
</video>