Settings
Various options are available to customize the PoWa Player. All of these options are defined as data attributes inside the PoWa tag:
Core Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-debug | boolean full | - | When set to true, the player relays all events to the developer console.When set to full, the player relays all information to the developer console. |
data-debug-ima | boolean | - | When set to true, the IMA SDK script in debug mode is loaded, relaying all ad events to the developer console. |
data-api | prod sandbox | - | Decides which API to point to. |
data-env | prod sandbox | - | Decides which environment version of PoWa to load. |
data-org | string | - | The organization ID. Ensures that the proper configuration is loaded for the player. Can be obtained from your Arc engagement manager. |
data-uuid | string | - | The UUID of the video to be played. Can be obtained from Video Center. |
Playback Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-autoplay | boolean | - | When set to true, the video begins playing as soon as the player is instantiated. Note: All modern browsers Block Autoplay By Default. We recommend you use data-muted with data-autoplay. |
data-stream | string | - | Override the video stream URL (bypasses automatic stream selection). |
data-video | object | - | Video ANS object containing streams array and tracks array.It needs to be defined as a JSON. |
data-loop | boolean | false | Loop video playback. Hides controls when true. |
data-loop-with-controls | boolean | false | Loop video playback while showing controls. |
data-muted | boolean | false | Start video muted. |
data-volume | number | - | Initial volume level (0-1). |
data-live | boolean | false | Indicates this is a live stream. |
data-hls | nativejsnone | Default is determined by the player after checking browser compatibility | 'native' relies on the browser HLS engine (if available).'js' loads HLS.js to do so.'none' avoids HLS playback. |
data-preload | none metadata auto | metadata | HTML5 video preload attribute. See the MDN docs for more details. |
Controls Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-controls | powanativeboolean | powa | powa relies on the controls provided by data-theme.native relies on the controls provided by the browser.false hides all video UI controls. |
data-theme | originalrefresh2021 | original | Theme/color configuration for controls. See more here. |
Advertising Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-ads | boolean | true | Enable advertising. Ad tag required. |
data-ad-preload | boolean | false | Preload ads before playback. |
data-ad-bar | boolean | true | Displays an ad control bar with countdown and ad skip. |
data-allow-ad-destroy | boolean | - | Allow destroying IMA SDK after each ad. Cannot be used with data-ad-preload. |
Subtitle Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-subtitles | string | - | Force which subtitle track to use. Does not get stashed as a user setting. |
data-stash-subtitles | boolean | true | Persist subtitle preference in localStorage. |
data-track | string | - | Override subtitle track URL selection to be used. Only .vtt is allowed. |
Container Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-aspect-ratio | string | 0.5625 | Container aspect ratio. The default value of 0.5625 relates to a 16:9 video. A 4:3 video should have a value of 0.75. Float values (height divided by width) for other aspect ratios should be defined to ensure the promo screen and player are properly sized for the promo image and content of the video. |
data-border-radius | boolean string | - | CSS border-radius for container. This attribute rounds the borders by 8 pixels; however, if you want to define the radius as more or less than 8 pixels, you can enter any integer (instead of true) to define the radius in pixels. See Video Center Player - Round player corners. |
Promo/Thumbnail Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-promo-image | object | - | If desired, override the promotional image defined in Video Center with an image URL. |
Plugin Settings
| Data Attribute | Type | Default | Description |
|---|---|---|---|
data-playthrough | boolean | - | If your Video Center instance is configured to provide recommended videos, a value of true results in the player continuing to play recommended videos after the specified (data-uuid) video has completed. |
data-sticky | boolean | - | When set to true, this attribute makes the video player sticky. Requires the Sticky plugin provisioned. |