{% include "@bolt-components-video/video.twig" with {
videoId: "5609376179001",
accountId: "1900410236",
playerId: "r1CAdLzTW",
showMeta: true,
showMetaTitle: false
} only %}
| Prop Name | Description | Type | Default Value | Option(s) |
|---|---|---|---|---|
|
attributes
|
A Drupal-style attributes object with extra attributes to append to this component. |
object
| — |
|
|
videoId
|
Brightcove ID for this video. |
string
, number
|
— |
|
|
playerId
|
Brightcover Player ID. |
string
| — |
|
|
accountID
|
ID of the Brightcove account that owns the video. |
string
, number
|
— |
|
|
videoUuid
|
A unique identifying string, randomly generated if not provided. |
string
| — |
|
|
share_description
|
A custom title to use in the share overlay |
string
|
Share This Video
|
|
|
ratio
|
Maintain video ratio. |
boolean
| — |
|
|
collapsed
|
Should the video be collapsed on load. |
boolean
| — |
|
|
showMeta
|
Should the video show meta data. |
boolean
|
true
|
|
|
showMetaTitle
|
Should the video show meta title. |
boolean
|
true
|
|
|
controls
|
Should the video controls be available. |
boolean
|
true
|
|
|
autoplay
|
Should the video auto-play on load. |
boolean
|
false
|
|
|
loop
|
Should the video loop. |
boolean
|
false
|
|
|
on_init
|
The |
string
| — |
|
|
enabled_plugins
|
Space-separated list of built-in |
string
| — |
|
|
disabled_plugins
|
Space-separated list of any built-in |
string
| — |
|
|
errorMessage
|
A custom message to be display upon a brigthcove error, will default to 'This video didnt load correctly. Refresh page to view.' is this field is left blank. |
string
| — |
|
|
isBackgroundVideo
(deprecated) |
Background video feature will be removed with Bolt v3.0 |
— | — |
|
|
default_plugins
|
An array of the default |
array
| — |
|
|
available_plugins
|
The built-in |
array
| — |
|
npm install @bolt/components-video
This video has controls set to false, you cannot interact with the video player but you can create external control to interact with it:
This video has external controls and an inline script:
This video has showMetaTitle set to false to hide the title from the video player, so you can pass the title to other markup.
This is an example of a Brightcove video with the default error message displayed.
This is an example of a Brightcove video with a custom error message displayed.
This video has disabled_plugins set to playback. Therefore disabling the default playback plugin.
Accepted plugins: cue, social, playback, and email.
This video has enabled_plugins set to a few values. Therefore enabling the plugins defined in the values.
Accepted plugins: cue, social, playback, and email.
This video has an external plugins script defined through on_init.
This video has an external plugins script defined through on_init and enabled_plugins set to certain values.