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.
Reference¶
Constants¶
plugin.tx_aipvimeo.view
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
layoutRootPath
Data type
String
Description
Layouts file path (contains the reference to the javascript libraries)
Default
EXT:aip_vimeo/Resources/Private/Layouts/
Property
partialRootPath
Data type
String
Description
Partials file path (not used)
Default
EXT:aip_vimeo/Resources/Private/Partials/
Property
templateRootPath
Data type
String
Description
Templates file path (contains the video player template inside the video folder)
Default
EXT:aip_vimeo/Resources/Private/Templates/
plugin.tx_aipvimeo.settings
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
autoplay
Data type
Boolean
Description
Play the video automatically on load
Default
1
Property
loop
Data type
Boolean
Description
Play the video (or the first video of the list) again when it reaches the end
Default
1
Property
mute
Data type
Boolean
Description
Enables or disables the audio of the videoSet this to 1if you want audio on when the video starts(the volume is automatically activated when the mouse hovers on the video player)
Default
1
Property
random
Data type
Boolean
Description
Enables or disables the random start of the video list
Default
1
plugin.tx_aipvimeo.settings.default
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
height
Data type
Integer
Description
Height of the video player (in pixels)
Default
300
Property
width
Data type
Integer
Description
Width of the video player (in pixels)
Default
300
plugin.tx_aipvimeo.settings.lib
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
aip_vimeo
Data type
String
Description
Reference to the javascript library
Default
EXT:aip_vimeo/Resources/Public/js/aip_vimeo.js
Property
css_style
Data type
String
Description
Reference to the css file
Default
EXT:aip_vimeo/Resources/Public/css/style_vimeo.css
Property
froogaloop
Data type
String
Description
Reference to the froogaloop2 javascript library (required to use the Vimeo API)
Default
EXT:aip_vimeo/Resources/Public/js/froogaloop2.min.js
Setup¶
plugin.tx_aipvimeo.view
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
layoutRootPath
Data type
String
Description
Layouts file path (contains the reference to the javascript libraries)
Default
$plugin.tx_aipvimeo.view.layoutRootPath
Property
partialRootPath
Data type
String
Description
Partials file path (not used)
Default
$plugin.tx_aipvimeo.view.partialRootPath
Property
templateRootPath
Data type
String
Description
Templates file path (contains the video player template inside the video folder)
Default
$plugin.tx_aipvimeo.view.templateRootPath
plugin.tx_aipvimeo.settings
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
autoplay
Data type
Boolean
Description
Play the video automatically on load
Default
$plugin.tx_aipvimeo.settings.autoplay
Property
badge
Data type
Boolean
Description
Enables or disables the badge on the video
Default
0
Property
byline
Data type
Boolean
Description
Show the user’s byline on the video
Default
0
Property
color
Data type
Boolean
Description
Specify the color of the video controls. Make sure that you don’t include the #
Default
F18E00
Property
loop
Data type
Boolean
Description
Play the video (or the first video of the list) again when it reaches the end
Default
$plugin.tx_aipvimeo.settings.loop
Property
mute
Data type
Boolean
Description
Enables or disables the audio of the videoSet this to 1if you want audio on when the video starts(the volume is automatically activated when the mouse hovers on the video player)
Default
$plugin.tx_aipvimeo.settings.mute
Property
portrait
Data type
Boolean
Description
Show the user’s portrait on the video as defined by the Vimeo's API
Default
0
Property
random
Data type
Boolean
Description
Enables or disables the random startof the video list
Default
$plugin.tx_aipvimeo.settings.random
Property
title
Data type
Boolean
Description
Show the title on the video
Default
0
plugin.tx_aipvimeo.settings.default
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
height
Data type
Integer
Description
Height of the video player (in pixels)
Default
$plugin.tx_aipvimeo.settings.default.height
Property
width
Data type
Integer
Description
Width of the video player (in pixels)
Default
$plugin.tx_aipvimeo.settings.default.width
plugin.tx_aipvimeo.settings.lib
Property
Property:
Data type
Data type:
Description
Description:
Default
Default:
Property
aip_vimeo
Data type
String
Description
Reference to the javascript library
Default
$plugin.tx_aipvimeo.settings.lib.aip_vimeo
Property
css_style
Data type
String
Description
Reference to the css file
Default
$plugin.tx_aipvimeo.settings.lib.css_style
Property
froogaloop
Data type
String
Description
Reference to the froogaloop2 javascript library (required to use the Vimeo API)
Default
$plugin.tx_aipvimeo.settings.lib.froogaloop
Example¶
Here you can find an example of the plugin configuration that sets the width and height to 300 pixels; autoplay, loop at random and true; mute to false:
plugin.tx_aipvimeo {
settings {
autoplay = 1
random = 1
loop = 1
mute = 0
default{
width = 300
height = 300
}
}
}