@financial-times/o-video
v7.3.1
Published
Creates a video player and attaches analytics. Also supports pre roll ads.
Downloads
3,084
Readme
o-video
Creates a video player and attaches analytics. Also supports pre roll ads.
Usage
Check out how to include Origami components in your project to get started with o-video
.
Markup
<div class="o-video" data-o-component="o-video"></div>
Videos can be styled in three different sizes, namely 'small', 'medium' and 'large', which can be added to the element as class modifiers, e.g.
<div class="o-video o-video--large" data-o-component="o-video"></div>
Sass
In order to output every size and attribute of o-video
, you'll need to include the following:
@import '@financial-times/o-video/main';
@include oVideo();
You can be more selective about which sizes and attributes you would like to output, by using an $opts
map. It accepts the following lists:
attributes
'ads'
'info'
'placeholder'
sizes
'small'
'medium'
'large'
@import '@financial-times/o-video';
@include oVideo($opts:(
'attributes': ('ads'),
'sizes': ('small', 'large')
))
// outputs small and large video styles, and styling support for ads
JavaScript
In order to initialise o-video
, you will need the following:
import Video from '@financial-times/o-video';
const opts = {
id: 4165329773001,
optimumwidth: 710,
placeholder: true,
classes: ['video'],
systemcode: 'my-biz-ops-code'
};
const video = new Video(document.body, opts);
Config
Where opts
is an optional object with properties
id
[String]
Source's ID of the video (brightcoveId
oruuid
)autorender
[Boolean]
Whether to have the video render automatically. If-false* then you will need to callinit()
when readyoptimumwidth
[Number]
The optimum width of the video placeholder imageoptimumvideowidth
[Number]
The optimum width of the video itself, used when there are multiple video renditions available to decide which to display (the smallest one that's at least as large as this width, if it exists)placeholder
[Boolean]
Show just the poster image, load (and play) video on clickplaceholderHint
[String]
An optional hint to display alongside the play icon (defaults to empty)placeholderInfo
[Array]
A list of extra information to display on the placeholder (Available: title, description, brand)playsinline
[Boolean]
Whether to play the video inline on iOS smallscreen (defaults to fullscreen)classes
[Array]
Classes to add to the video (and placeholder) elementadvertising
[Boolean]
whether or not to show ads on the videoshowCaptions
[Boolean]
whether or not to add captions to the video. Defaults totrue
.data
[Object]
JSON object representing a response from next-media-api. If used, the component will not make a call to the API and use this data instead.systemcode
[String]
a valid Bizops system code for the project usingo-video
.adsTargeting
(previouslytargeting
)[Object]
object containing the targeting data used to configure, serve and track video ads. If targeting is passed as an option but is missing properties, it will use the properties set in thedefaultTargeting
object instead. here is what each property on the targeting object affects:site:
refers to the ad unit that contains the line items for video creatives (part of the ad request).position:
sets thepos
param on the ad request which is used to target video ads similar to howpos: native
is used to target partner content.sizes:
also added to ad request to specify video ad sizes to be returned.videoId:
added to targeting as a param for targeting ads at a specific video.customParams
[Object]
object containing custom parameters that are used to request video ads. Values include, but are not limited to: user ID, page type, subscription level, resolution.
The config options can also be set as data attribute to instantiate the module declaratively:
<div data-o-component="o-video o-video--large"
data-o-video-id="4165329773001"
data-o-video-optimumwidth="710">
</div>
With a playlist
Playlists may take a queue of videos and play them one after another.
import Video from '@financial-times/o-video';
const queue = [
'4165329773001',
'4907997821001',
'4165329773001'
];
const player = new Video(document.body, { autorender: false, systemcode: 'my-biz-ops-code' });
const playlist = new Video.Playlist({ player, queue });
document.querySelector('.next-btn').onclick = () => playlist.next();
document.querySelector('.prev-btn').onclick = () => playlist.prev();
The queue is an array
containing Brightcove video ID strings.
Testing
See Origami build tools.
$ obt test
Requires Firefox (v38.0.0 to test with polyfills and mirror CI)
Migration
State | Major Version | Last Minor Release | Migration guide | :---: | :---: | :---: | :---: ✨ active | 7 | N/A | migrate to v7 | ⚠ maintained | 6 | 6.1 | migrate to v6 | ╳ deprecated | 5 | 5.1 | migrate to v5 | ╳ deprecated| 4 | 4.1 | migrate to v4 | ╳ deprecated | 3 | 3.1 | migrate to v3 | ╳ deprecated | 2 | 2.5 | migrate to v2 | ╳ deprecated | 1 | 1.4 | N/A |
Contact
If you have any questions or comments about this component, or need help using it, please either raise an issue, visit #origami-support or email Origami Support.
Licence
This software is published by the Financial Times under the MIT licence.