DOCSEARCHbyAlgolia
Submit Docs

Uplynk Documentation

website·Indexed 37 days ago

https://docs.uplynk.com/

Documentation for Uplynk's video management platform, featuring guides on VOD and Live linear channel setup, Cloud Slicer Live (CSL) and on-premises Slicer configuration, and Slicer Failover API. Includes technical details on encoding profiles, captions, subtitles, and SSO integrations with Okta via OIDC and SAML.

Tokens
171.2K
Snippets
594
Records
1.3K
Agent score
56%

What's inside Uplynk

  1. Overview of Uplynk Live Events

    Live Events allow you to broadcast near real-time content (such as concerts, sporting events, or lectures) with operator controls. This service is distinct from live channels, which are intended for continuous live streams. Key capabilities include testing streams before the event starts, controlling audio/video feed sources, and managing the timing of ad breaks and slate insertions. Live events must have a defined starting and ending point and can be tracked via a calendar.

  2. Overview of Uplynk Blackout functionality

    Blackout is a server-side feature used to limit the distribution of restricted content (e.g., sporting events or licensed movies) based on the viewer's location. When a viewer is in a blacked-out region, the system replaces the regularly scheduled program with alternate content from a different source. Because this is handled on the server, no special client-side SDKs are required.

  3. Overview of Uplynk SAML integration with Okta

    Uplynk CMS supports SAML-based Single Sign-On (SSO) using Okta as the Identity Provider (IdP). Currently, the integration is not self-service and must be completed in coordination with the Uplynk team. The process involves the customer configuring the Okta application and providing SAML metadata (such as the IdP metadata URL, Entity ID, and certificates) to Uplynk, who then configures the Service Provider (SP) side of the CMS.

  4. Overview of Syndication Notifications

    Syndication provides automated notifications for key publishing job events via Amazon SNS. These notifications allow users to monitor job health and alert downstream systems based on event severity (Info, Warning, Critical).

  5. Overview of Live Slicer Monitoring Rules

    Monitoring rulesets define the metrics and thresholds used to determine if a Live Slicer is unhealthy (Warning or Critical status).

    Key constraints and behaviors:

    • Default Rules: Live Slicers use a read-only default set of rules unless a custom set is assigned.
    • Single Assignment: A Live Slicer can only be associated with one ruleset at a time. Assigning a new ruleset replaces the previous one.
    • Update Frequency: Most metrics update every 4 seconds, except for 'Closed Captioning Last Seen', which updates every 10 seconds.
    • Reporting State: Monitoring data is only reported when the Live Slicer is actively slicing content. Data is not reported during ad breaks, replace content, or blackout states.
    • Organization Rulesets: Users with admin or read/write permissions can create organization-wide rulesets available to all members.

  6. Overview of Cloud Slicer Live (CSL)

    Cloud Slicer Live (CSL) is a cloud-hosted service that allows users to instance a slicer within the Uplynk cloud environment. It eliminates the need for on-premises hardware, installation, and maintenance. The service is free when paired with an active encode; otherwise, a standby fee applies. Users are responsible for delivering the stream to the platform in a compatible format and reliable fashion.

  7. Overview of Ad Inspector and Ad Jobs

    Ad Inspector provides near real-time data on ad requests and responses to help verify ad insertions, troubleshoot errors, and audit playback sessions. Data is organized into 'Ad Jobs'.

    Ad Job Scope:

    • Live Stream: A new ad job is generated whenever playback encounters an upcoming ad break.
    • VOD: A single ad job is generated upon initiating playback, containing data for all ad breaks in the asset.

    Ad Job Components:

    • Ads: Details on whether an ad was selected, its position in the break, and asset status.
    • Transactions: Contains the ad request (raw URL, macros, HTTP headers) and the response (raw XML from the ad decision server, VMAP/VAST wrappers, and errors).
    • Beacons: Tracking data reported by the system to the ad decision server.

  8. Overview of Prebid integration in Uplynk

    Prebid integrates a real-time bidding (RTB) step into the ad workflow, allowing Uplynk to gather bids from demand partners before submitting the request to an ad decision server. This ensures that the ad decision server can choose the highest value creative from three sources: Direct ads (prenegotiated), Standard third-party ads (requested by the ad server), and Prebid third-party ads (requested via the Prebid service). This process maximizes monetization and diversifies the ads served to viewers.

  9. Overview of Uplynk Playback URL capabilities

    Uplynk allows the construction and signing of playback URLs for various content types, including Assets, Virtual Linear Playlists, Live Channels, and Live Events. These URLs can be secured using tokens, application keys, and encrypted query strings.

  10. Overview of Apple FairPlay Streaming (FPS) DRM

    Apple FairPlay Streaming (FPS) provides Digital Rights Management (DRM) for HTTP Live Streaming (HLS) encrypted video content. It is supported on iOS, Apple TV, and Safari on macOS 10.10.3 or later.

    Key requirements:

    • Safari playback requires Encrypted Media Extensions (EME).
    • Safari on mobile devices requires iOS 11.2 or later.
    • Supports stopping playback on mobile and Apple TV when an expired Content Key (CK) is detected.
    • Uses a device identifier within the Server Playback Context (SPC) message to identify devices anonymously.

  11. Overview of the Live Slicer API

    The Live Slicer API (v2) is exposed via an internal web server and allows developers to mark ads, replacement content, or content boundaries, set metadata on assets, and retrieve detailed Live Slicer status information. It is used specifically for controlling stream behavior. For retrieving the last known status of multiple Live Slicers or updating slicing schedules, the Slicer API should be used instead.

  12. Overview of SmartPlay: Ingest

    SmartPlay: Ingest allows users to bring pre-encoded HLS content into the Smartplay engine for scalable playback and Server-Side Ad Insertion (SSAI). Unlike the standard Uplynk Slicing, Encoding, and Storage pipeline, this pipeline is specifically for content that is already encoded. The engine manages individual playback sessions at scale, providing unique manifests to each viewer, which enables targeted SSAI, regional blackouts, and device-specific streaming protocols.