#BlackLivesMatter
Do you build things with AMP? Fill out the new AMP Developer Survey!
AMP

Important: this documentation is not applicable to your currently selected format stories!

amp-brightcove

Description

Displays a Brightcove Video Cloud or Perform player.

Required Scripts

<script async custom-element="amp-brightcove" src="https://cdn.ampproject.org/v0/amp-brightcove-0.1.js"></script>

An amp-brightcove component displays the Brightcove Player as used in Brightcove's Video Cloud or Brightcove Player.

Example

The width and height attributes determine the aspect ratio of the player embedded in responsive layouts.

Example:

<amp-brightcove
  data-account="12345"
  data-player="default"
  data-embed="default"
  data-video-id="1234"
  layout="responsive"
  width="480"
  height="270"
>
</amp-brightcove>

Attributes

data-account The Brightcove Video Cloud or Perform account id.
data-player or data-player-id The Brightcove player id. This is a GUID, shortid or "default". The default value is "default".
data-player is preferred. data-player-id is also supported for backwards-compatibility.
data-embed The Brightcove player id. This is a GUID or "default". The default value and most common value is "default".
data-video-id The Video Cloud video id. Most Video Cloud players will need this.
This is not used for Perform players by default; use it if you have added a plugin that expects a videoId param in the query string.
data-playlist-id

The Video Cloud playlist id. For AMP HTML uses a video id will normally be used instead. If both a playlist and a video are specified, the playlist takes precedence.

This is not used for Perform players by default; use it if you have added a plugin that expects a playlistId param in the query string.

data-referrer Sets the referrer to be used for the Video Cloud analytics within the player. Requires Brightcove Player version v6.25.0+. This supports AMP varables such as EXTERNAL_REFERRER.
data-param- All data-param- attributes will be added as query parameter to the player iframe src. This may be used to pass custom values through to player plugins, such as ad parameters or video ids for Perform players.
Keys and values will be URI encoded. Keys will be camel cased.

  • data-param-language="de" becomes &language=de
  • data-param-custom-ad-data="key:value;key2:value2" becomes &customAdData=key%3Avalue%3Bkey2%3Avalue2
autoplay If this attribute is present, and the browser supports autoplay, the video will be automatically played as soon as it becomes visible. There are some conditions that the component needs to meet to be played, which are outlined in the Video in AMP spec.
common attributes This element includes common attributes extended to AMP components.
dock Requires amp-video-docking extension. If this attribute is present and the video is playing manually, the video will be "minimized" and fixed to a corner or an element when the user scrolls out of the video component's visual area. For more details, see documentation on the docking extension itself.

Player configuration

To support AMP's video interface, which is recommended, make sure you configure players used with the AMP Support plugin. See Brightcove's support documentation for player configuration instructions.

Validation

See amp-brightcove rules in the AMP validator specification.

도움이 더 필요하신가요?

이 문서를 수십 번 읽었음에도 여전히 궁금한 점이 남아 있나요? 다른 개발자들도 같은 심정일지 모릅니다. Stack Overflow에서 소통해 보세요.

Stack Overflow로 이동
버그나 누락된 기능을 발견하셨나요?

AMP 프로젝트는 여러분의 참여와 기여를 적극 환영합니다! 오픈 소스 커뮤니티를 통해 지속적으로 활동해 주셔도 좋지만 관심 있는 주제에 한 번만 기여하셔도 큰 도움이 됩니다.

GitHub로 이동하기