User Guides

Smartplay: Ingest – VOD

Suggest Edits

Ingest pre-encoded VOD content into Uplynk for scalable playback and full Smartplay functionality. This page covers how to create ingest jobs for on-demand assets, configure metadata and encryption settings, and manage resulting content in the Uplynk CMS.

Ingesting Pre-Encoded VOD Assets

To ingest a pre-encoded VOD asset using Smartplay: Ingest:

  1. Prepare Your Asset
    Ensure the asset meets Smartplay requirements and is hosted in an accessible location. Take note of the URL to the m3u8 manifest file.

  2. Create a New Ingest Job
    Navigate to the VOD Jobs tab and click + Job.

  3. Enter Job Details
    Provide a name for the asset and enter the URL of the pre-encoded m3u8 stream.

  4. Save Configuration
    Add any optional details (e.g., description, metadata, library assignment) and click Save.

  5. Start the Ingest Job
    Launch the job from the modal or using the Start button in the job list.

  6. Wait for Ingest to Complete
    Once complete, the asset will appear in the main Content tab under the name you specified. If a library was configured, the asset will appear there instead.

  7. Interact with the Asset
    You can now:

    • Add it to playlists
    • Schedule it on channels
    • Update metadata
    • Embed it using HTML
    • Retrieve the m3u8 link for playback

📘

Assets created via Smartplay: Ingest will appear as external sources. Some features (e.g., CMAF, DASH, DRM, clipping, MP4 export) may be unavailable at launch. These limitations are visually indicated in the CMS and will be supported in future updates. Contact your account manager for specific workflow requirements.


Quick Start

The Smartplay: Ingest VOD feature is designed for easy integration into workflows that rely on externally encoded content. To quickly ingest VOD assets:

  1. Go to the VOD Jobs tab and click + Job.
  2. Enter a name for the asset (Asset Name, required) and its m3u8 URL (required).
  3. Click Create.
  4. Click Start from either the job details or the job list view.
  5. Wait for the ingest to finish.
  6. Once complete, your asset will be available in the Content tab or assigned library.
  7. Use the asset freely: playlist, schedule, edit metadata, embed, or stream using the m3u8 URL.

Detailed Job Setup

This section outlines the full configuration options available when creating a Smartplay: Ingest VOD job. It builds on the quick start steps with additional controls and flexibility.

Mandatory Steps

  1. Go to the VOD Jobs tab and click + Job to open the modal.

  2. Enter a unique Asset Name and the m3u8 URL for your pre-encoded content (both required).

  3. Check the Edit after creation box. This enables advanced configuration after the job is created.

  4. Click Create to continue to the Single View configuration screen.

  5. If needed, configure:

    • External ID
    • Auto Delete (Hours)
    • DRM Mode
    • Add to Libraries

  6. In the Advanced section, you can choose to Copy Video Segments to Uplynk for enhanced playback features.

  7. Click Save to commit your changes.

  8. Start the job using the Start button (available in both job view and list view).

  9. Wait for the job to complete. Once finished, the asset will appear in the Content tab or the configured library.

  10. You can now schedule, tag, embed, or play back the asset as needed.


Single View

The Single View screen is your main interface for reviewing and editing ingest jobs. It includes configuration options, metadata, advanced settings, and real-time job status.

You can access the Single View by:

  • Checking the "Edit after creation" box during job creation
  • Clicking an existing job from the list view

Use this screen to update job parameters, monitor progress, or investigate errors.


General Configuration Fields

Asset Name
The required name for your asset in Uplynk. It must be a unique string with no spaces. It is used throughout the CMS to identify and manage the asset.

m3u8 URL
The manifest location for your pre-encoded stream. This is what Smartplay: Ingest uses to access and process the content.

External ID
A user-defined ID that can be used to generate predictable playback URLs. External IDs must:

  • Be unique within your account
  • Only include letters, numbers, dashes, or underscores

For more on playback URLs and External IDs, refer to the Deliver documentation.

Auto Delete
Set how long (in hours) the ingested VoD asset should be retained. A value of 0 disables auto-deletion. Leaving the field empty will apply your account's default retention policy.

DRM Mode
When supported, this lets you enforce DRM on the asset. Currently, this should remain set to None.

Add to Libraries
Choose an existing library (configured in the Content tab) where this asset should be placed. This helps organize content by theme, purpose, or access scope.


Metadata Configuration

Metadata can be assigned to assets during the ingest process using key/value pairs. This is useful for categorization, automation, or tagging within the CMS.

To add metadata:

  1. Go to the Single View of the ingest job.
  2. Enter a key in the left-hand field.
  3. Enter a value in the right-hand field.
  4. Press Return to add the entry and open a new row.
  5. Repeat for additional key/value pairs as needed.
  6. To remove a pair, click the red minus icon on the right.

Advanced Configuration

Copy Video Segments to Uplynk (Recommended)

Enabling this option tells Uplynk to:

  • Parse the manifest and locate media segments
  • Ingest the content
  • Decrypt, repackage, and re-encrypt it using AES-128
  • Store the processed content in Uplynk storage

Benefits of storing the content within Uplynk:

  • Enables Smartplay to inject AES keys into HLS manifests
  • Prevents dependency on the original hosting location
  • Makes assets editable in Uplynk Studio (e.g., clipping, ad breaks)
  • Supports Multi-CDN delivery with Uplynk acting as the origin
  • Prepares content for future CMAF, DASH, and DRM capabilities
  • Ensures compatibility with the channel scheduler

⚠️

If this option is not selected, assets:

  • Will be unencrypted
  • Cannot be repackaged or edited via Studio
  • Must scale independently for delivery
  • May be deleted or become unavailable at the source without notice, leading to playback failures or ingest errors

Job Details Panel

Found on the right side of the Single View, this panel shows the current status and identifiers for the job.

Job Status
Indicates the current state of the ingest job:

  • Stopped: The job exists but is not active. It may have completed or not yet started.
  • Scheduled: The job has been initiated and is allocating system resources.
  • Running: The job is actively ingesting the asset.
  • Error: An issue occurred during ingest, usually due to an unreachable or invalid m3u8. An error message will be shown alongside the status.

Job ID
A unique identifier for the job, used for support or troubleshooting purposes.


Actionable Options

You can manage VOD ingest jobs using the following controls available in both the Single View and List View:

  • Start: Launches the ingest job. Can be used to initiate a new job or restart a job that has been stopped or errored.
  • Stop: Gracefully halts a running job. The job's settings and ingest URL remain intact for future use.
  • Reset (visible only for errored jobs): Clears the job's error state and restarts the ingest process.
  • Save: Commits any changes made to the job configuration in Single View.
  • Delete Job: Permanently deletes the ingest job record. This does not delete the asset from Uplynk.

Manage – List View

The VOD Jobs tab provides an overview of all external VOD ingest jobs within your account. Each row includes metadata and controls that allow for rapid job management.

Sorting and Filtering Tools
Located at the top right of the table:

  • Search: Filter jobs by name, ID, or status
  • Sort: Organize by job status, creation date, etc.
  • Column Controls: Toggle which fields are visible

Navigating to Job Details
Click any job row to open its Single View, where you can modify settings, monitor status, and resolve issues.


Job Table Fields and Statuses

Each row displays key job properties:

  • Asset Name: The label assigned during job creation; also appears in the Content tab

  • Status:

    • Stopped: The job exists but isn’t currently ingesting
    • Scheduled: The job is acquiring resources and will start soon
    • Running: Actively ingesting the asset
    • Error: A failure occurred (e.g., invalid or unreachable m3u8 URL)

  • URL: The ingest source URL (m3u8)

  • Added: Date the job was created

  • Job ID: Unique identifier. Click the icon to copy it to your clipboard

  • Start/Stop Icons: Inline buttons to control individual job state


Footer Controls

  • + Job: Opens the creation modal for a new VOD ingest job
  • Delete Job: Allows multi-select and bulk deletion. Confirming the action is required.

Deleting a job only removes the ingest job record. It does not impact the underlying VOD asset stored in Uplynk.

Updated 6 days ago