Customer Sign In

upLynk

Generating playback URLs

Overview

Learn how to generate playback URLs for assets and live channels.

Protocol - HTTP vs HTTPS

The protocol defined in the playback request determines the protocol used for the ray and slice responses.

Playback Request ProtocolRay & Slice Response Protocol
HTTPHTTP
HTTPSHTTPS

Asset playback URLs

The three basic types of asset playback URLs are:

  • Asset ID: This type of playback URL identifies an asset by its system-defined ID.
  • External ID (Asset): This type of playback URL identifies an asset by its external ID.
  • Asset/External ID and Segment Number: This type of playback URL identifies a segment within an asset. This type of URL is only applicable for assets that contain ad breaks.

Key information:

Asset ID

Upon the creation of an asset, it is assigned a 32-character hexadecimal unique identifier. This ID, known as an asset ID, may be viewed via the CMS, a slicer's output, logs, the Preplay API, or the SegmentMap API. Generate a playback URL by including this asset ID.

Syntax
http://content.uplynk.com/<assetID>.m3u8

Example:

The following playback URL will play back an asset with an ID of "7731125f336c4e229c20f7307f8c3122."

Sample Playback URL
http://content.uplynk.com/7731125f336c4e229c20f7307f8c3122.m3u8

External ID (Asset)

A playback URL may be constructed by including both of the following values:

  • User ID: A unique system-defined ID is assigned to each Uplynk user. View this ID by performing the following steps:
    1. From the CMS, click the Advanced (Gears Icon) tab.
    2. Make sure that the Account Settings side navigation tab has been selected.
    3. Your ID will be listed under the User ID label.
  • External ID (Asset): A custom ID, known as an external ID, may be assigned to an asset. Typically, this ID reflects a unique value defined in an external database.

    Key information:

    • An external ID may only consist of alphanumeric characters, dashes, and underscores. All other characters, including spaces, are disallowed.
    • External IDs are not tested for validity or uniqueness. An arbitrary matching asset will be played back when multiple assets have been assigned the same external ID.
    • Use the _replace: prefix while slicing to reuse an external ID when re-encoding a new version of an existing asset.
Syntax
http://content.uplynk.com/ext/<userID>/<externalID>.m3u8

Example:

The following playback URL plays an asset with an ID of "promo_video_12" provided that it belongs to your user account (e.g.,f8c29a5f6c4e229c20f7307f8c3122ab).

Sample Playback URL
http://content.uplynk.com/ext/f8c29a5f6c4e229c20f7307f8c3122ab/promo_video_12.m3u8

Segment (ad breaks)

Server-side ad insertion ensures seamless ad integration. As a result, the type of playback URL described in this section is typically reserved for legacy client-side ad integrations or non-video ad integrations in which video playback is temporarily suspended.

An asset that contains one or more ad breaks will be split into segments (as illustrated below).

Segments

Each segment may be played back by adding the /segment/<Segment Number> URL segments to a playback URL.

Syntax
Asset ID-Based Playback URL:
http://content.uplynk.com/segment/<segmentNumber>/<assetID>.m3u8

External ID-Based Playback URL:
http://content.uplynk.com/segment/<segmentNumber>/ext/<userID>/<externalID>.m3u8

Example:

For example, an asset with a single ad break will be split into two segments. Sample playback URLs for each segment are listed below.

Sample Playback URLs
Sample Asset ID-Based Playback URL (First Segment):
http://content.uplynk.com/segment/0/7731125f336c4e229c20f7307f8c3122.m3u8		

Sample Asset ID-Based Playback URL (Second Segment):
http://content.uplynk.com/segment/1/7731125f336c4e229c20f7307f8c3122.m3u8

Playback Scope

Playback may be restricted to a portion of an asset by specifying a start and stop time. This may be achieved by including the following parameters in an authorization token:

  • start: Identifies the time offset from the start of the video at which playback will start. Playback will start from the beginning of the slice that contains the specified time.
  • stop: Identifies the time offset from the start of the video at which playback will stop. Playback will stop at the end of the slice that contains the specified time.

Live channel playback URLs

The two types of playback URLs for a live channel are:

  • Channel ID (GUID): This type of playback URL identifies a live channel by its system-defined ID.
  • External ID (Channel): This type of playback URL identifies a live channel by its external ID.

Channel ID (GUID)

Upon the creation of a live channel, it is assigned a 32-character hexadecimal unique identifier. View this ID, known as a channel ID, by performing the following steps:

  1. From the CMS, click the LIVE CHANNELS tab.
  2. Select the desired live channel from the side navigation tab.
  3. From the Editor pane, click the Advanced (Gears) tab.
  4. The live channel's system-defined ID will be listed under the GUID label.

Generate a playback URL for a live channel by including its channel ID.

Syntax
http://content.uplynk.com/channel/<channelID>.m3u8

Example:

The following playback URL plays a live channel with an ID of "cd772adbd60a4e898d1c3b1f46c58cea."

Sample Playback URL
http://content.uplynk.com/channel/cd772adbd60a4e898d1c3b1f46c58cea.m3u8

External ID (Channel)

A playback URL may be constructed by including both of the following values:

  • User ID
  • External ID (Channel): This external ID is a custom ID that may be assigned to a live channel. Typically, this ID reflects a unique value defined in an external database.

    Key information:

    • An external ID may only consist of alphanumeric characters, dashes, and underscores. All other characters, including spaces, are disallowed.
    • External IDs are not tested for validity or uniqueness. An arbitrary matching live channel will be played back when multiple live channels have been assigned the same external ID.
    • View a live channel's external ID from the CMS by performing the following steps:
      1. From the CMS, click the LIVE CHANNELS tab.
      2. Select the desired live channel from the side navigation tab.
      3. Look for the live channel's external ID in the External ID option. This option may be found on the Details tab on the Editor pane.
Syntax
http://content.uplynk.com/channel/ext/<userID>/<externalID>.m3u8

Example:

The following playback URL plays a live channel with an ID of "live_feed_east" provided that it belongs to your user account (e.g.,f8c29a5f6c4e229c20f7307f8c3122ab).

Sample Playback URL
http://content.uplynk.com/ext/f8c29a5f6c4e229c20f7307f8c3122ab/live_feed_east.m3u8

Live Event playback URLs

The two types of playback URLs for a live event are:

  • Event ID (GUID): This type of playback URL identifies a live event by its system-defined ID.
  • External ID (Event): This type of playback URL identifies a live event by its external ID.

Event ID (GUID)

An event ID is automatically generated upon scheduling a live event via the Live Events Integration API. It is reported by the id response parameter when creating, updating, or retrieving a live event.

Generate a playback URL for a live event by including its event ID.

Syntax
http://content.uplynk.com/event/<eventID>.m3u8

Example:

The following playback URL plays a live event with an ID of "f21c3336c35f47baa59345e2879b6edb."

Sample Playback URL
http://content.uplynk.com/event/f21c3336c35f47baa59345e2879b6edb.m3u8

External ID (Event)

A playback URL may be constructed by including both of the following values:

  • User ID
  • External ID (Event): This external ID is a custom ID that may be assigned to a live event when creating or updating via the Live Events Integration API. Typically, this ID reflects a unique value defined in an external database.

    Key information:

    • An external ID may only consist of alphanumeric characters, dashes, and underscores. All other characters, including spaces, are disallowed.
    • External IDs are not tested for validity or uniqueness. An arbitrary matching live event will be played back when multiple live events have been assigned the same external ID.
    • The live event's External ID is reported by the external_id response parameter when creating, updating, or retrieving a live event.
Syntax
http://content.uplynk.com/event/ext/<userID>/<externalID>.m3u8

Example:

The following playback URL plays a live event with an ID of "live_feed_east" provided that it belongs to your user account (e.g.,1855369d5db040539700c6cb724d1f16).

Sample Playback URL
http://content.uplynk.com/ext/1855369d5db040539700c6cb724d1f16/live_feed_east.m3u8

Application keys

An application key provides an additional layer of security when authorizing playback via an application (e.g., media player). However, this type of setup requires modifying the file name extension defined in a playback URL from "m3u8" to "json." All other aspects of the playback URL, including query string parameters, should not be modified.

Sample Playback URL
http://content.uplynk.com/channel/ext/8bb3fcf33d134160848b3051fa15ea21/live_feed_east.json?tok=...