RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
<Work in progress>
Unified Video Engine (UVE) APIs
This document explains how users can evaluate/adopt AAMP for media player applications.
Overview
AAMP is an open source native video engine that is built on top of GStreamer and optimized for performance, memory use, and
code size. AAMP Reference Player demonstrates how to use the Unified Video Engine (UVE) JavaScript binding APIs to
interact with an AAMP player.
The bindings are made available in JavaScript with the help of the injectedbundle component once the DOM elements are
loaded by WebKit.
Target Audience
This document is targeted to OTT app vendors and HTML5 developers who are interested in evaluating/adopting AAMP for
their media player applications on settops running RDKV based firmware.
Features
- Formats: HLS, DASH, Fragmented MP4 HLS
- DRM Systems: Clear Key, Adobe Access, Vanilla AES-128, PlayReady, Widevine
- Captions: CEA-608/708 Captions , WebVTT
Roadmap
- Video Guard (VGC) DRM
- DVB, EBU-TT captions
Release Version
| co1 | col2 | |
|---|---|---|
Minimal Sample Player
<html><head><title>IP Video Playback in WPE browser using UVE API</title></head>
<script>
window.onload = function() {
var player = new AAMPMediaPlayer();
var url = "https://cpetestutility.stb.r53.xcal.tv/multilang/main.m3u8";
player.load(url);
}
</script>
<body>
<div id="videoContainer">
<video style="height:100%; width:100%; position:absolute; bottom:0; left:0">
<source src="dummy.mp4" type=”video/ave”> <!-- hole punching -->
</video>
</div>
</body>
</html>
General Setup
To setup the AAMP Reference Player in RDK devices(Comcast):
- Host the ReferencePlayer folder in a web server.
- Use Comcast's IBIS tool (https://ibis.comcast.com/app-dev-tool/send-html-app) to launch the reference player in the
device:
a. Under Launch HTML App, select Select a device to get started.
b. From the list, find your device (it should be registered previously).
c. Enter the ReferencePlayer URL in the URL field.
d. Enter any name in the App name field.
e. Click Launch.
Folder Structure: Full Reference Player
-icons // UI elements of reference players and homepage
-UVE
-index.html // Homepage of UVE reference player
-UVEMediaPlayer.js // Includes "AAMPPlayer" JS class which wraps UVE binding object AAMPMediaPlayer
-UVEPlayerUI.js // JS code for the UI elements and their functionality
-UVERefPlayer.js // Main JS file
-UVERefPlayerStyle.js // JS code for reference player and its UI
-index.html // Homepage of reference player
-ReferencePlayer.js // JS code for Homepage and redirection to respective reference players
-URLs.js // list of selectable streams
-ReferencePlayerStyle.css // CSS for Homepage and its UI
Universal Video Engine APIs
PROPERTIES:
| Name | Type | Description |
|---|---|---|
| version | number | May be used to confirm if RDKV build in use supports a newer feature |
| AAMP.version | number | Global variable for applications to get UVE API version without creating a player instance. Value will be same as player.version. |
METHODS:
load( uri, autoplay, tuneParams)
- Begin streaming
| Name | Type | Description |
|---|---|---|
| Uri | String | URI of the Media to be played by the Video Engine |
| autoplay | Boolean | optional 2nd parameter (defaults to true) If false, causes stream to be prerolled/prebuffered only, but not immediately automatically presented. Available starting with version 0.8. |
| tuneParams | Object | optional 3rd parameter The tuneParams Object includes four elements contentType, traceId, isInitialAttempt and isFinalAttempt. Details provided in below table |
| Name | Type | Description |
|---|---|---|
| contentType | String | Content Type of the asset taken for playback. Eg: CDVR, VOD, LINEAR_TV, IVOD, EAS, PPV, OTT, OTA, HDMI_IN, COMPOSITE_IN, SLE |
| traceId | String | Trace ID which is unique for a tune. |
| isInitialAttempt | Boolean | Flag indicates if it’s the first tune initiated, tune is neither a retry nor a rollback. |
| isInitialAttempt | Boolean | Flag indicates if it’s the first tune initiated, tune is neither a retry nor a rollback. |
play()
Overview
Community Forums
Content Tools
Tasks