Skip to main content

Downloads

The Downloads feature allows users to download supported video and audio content for offline playback on mobile devices, enabling access to content even when an internet connection is unavailable.

Prerequisites​

Data source with downloaded items and extension that indicate if the item is downloaded. Read more here.

note

Certain DRM / Paywalls might not be supported.

Add the ‘Offline Content Button Action’ plugin.

Modify the text under the Localization modal.

By default the app looks for the extensionhqme field and checks if it's set to true. If needed, align the data key of downloaded items with your DSP.

Modify the Downloads assets you want to use. You can use two flavors in case you use downloads in light background on cells or a dark background on images.

Adding the Downloads action button to the cell or the player​

In the Studio, add the downloads action to the cell. You can add it as a single action or in the actions menu modal. To do so, enable the action button and fill the identifier.

  • For single action, fill the identifier: offline-content-button
  • For actions menu, fill the identifier: open-modal-bottom-sheet-cell-action
  • In order to add the Download button to the player, add the offline-content-button identifier in the player screen itself. It is also possible to add more than one action button to the player by separating them with a comma.

Read more about Actions Menu here.

Promote your Downloads​

You can create a screen or component to promote the downloaded items. To do so, create a feed using the URL:

pipesv2://offline-content-button

Then create a screen or/and component with this data source.

Add the empty State Alert with a call-for-action message to add downloads.

Download Expiration​

Downloaded content can include an expiration date. Once the expiration date is reached, the item is automatically removed from the Downloads feed and is no longer available for offline playback.

To configure download expiration, provide the following metadata field:

{ "download_expiration_date": "2026-04-24T11:15:00" }

The value should be provided in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss).

note

Download expiration is independent of DRM expiration. If both are configured, the earliest restriction applies.