media.vimeo¶
Renders HTML code to embed a video from Vimeo.
Arguments¶
additionalAttributes¶
- DataType
- mixed
- Required
- false
- Description
- Additional tag attributes. They will be added directly to the resulting HTML tag.
data¶
- DataType
- mixed
- Required
- false
- Description
- Additional data-* attributes. They will each be added with a “data-” prefix.
aria¶
- DataType
- mixed
- Required
- false
- Description
- Additional aria-* attributes. They will each be added with a “aria-” prefix.
class¶
- DataType
- string
- Required
- false
- Description
- CSS class(es) for this element
dir¶
- DataType
- string
- Required
- false
- Description
- Text direction for this HTML element. Allowed strings: “ltr” (left to right), “rtl” (right to left)
id¶
- DataType
- string
- Required
- false
- Description
- Unique (in this file) identifier for this HTML element.
lang¶
- DataType
- string
- Required
- false
- Description
- Language for this element. Use short names specified in RFC 1766
style¶
- DataType
- string
- Required
- false
- Description
- Individual CSS styles for this element
title¶
- DataType
- boolean
- Default
- true
- Required
- false
- Description
- Show the title on the video. Defaults to TRUE.
accesskey¶
- DataType
- string
- Required
- false
- Description
- Keyboard shortcut to access this element
tabindex¶
- DataType
- integer
- Required
- false
- Description
- Specifies the tab order of this element
onclick¶
- DataType
- string
- Required
- false
- Description
- JavaScript evaluated for the onclick event
videoId¶
- DataType
- string
- Required
- false
- Description
- Vimeo ID of the video to embed.
width¶
- DataType
- integer
- Default
- 640
- Required
- false
- Description
- Width of the video in pixels. Defaults to 640 for 16:9 content.
height¶
- DataType
- integer
- Default
- 360
- Required
- false
- Description
- Height of the video in pixels. Defaults to 360 for 16:9 content.
byline¶
- DataType
- boolean
- Default
- true
- Required
- false
- Description
- Show the users byline on the video. Defaults to TRUE.
portrait¶
- DataType
- boolean
- Default
- true
- Required
- false
- Description
- Show the users portrait on the video. Defaults to TRUE.
color¶
- DataType
- string
- Default
- ‘00adef’
- Required
- false
- Description
- Specify the color of the video controls. Defaults to 00adef. Make sure that you dont include the #.
autoplay¶
- DataType
- boolean
- Required
- false
- Description
- Play the video automatically on load. Defaults to FALSE. Note that this wont work on some devices.
loop¶
- DataType
- boolean
- Required
- false
- Description
- Play the video again when it reaches the end. Defaults to FALSE.
api¶
- DataType
- boolean
- Required
- false
- Description
- Set to TRUE to enable the Javascript API.
playerId¶
- DataType
- string
- Required
- false
- Description
- An unique id for the player that will be passed back with all Javascript API responses.