Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Official Latest published UVE-JS API documentation as of 2009_sprintspecification (also available in rdkcentral aamp repo).

dev_sprint_23_1/AAMP-UVE-API.md

View file
nameAAMP-UVE-API.pdf
height250

View file
nameUVE-EVENTS-GAP.xlsx
height250


This document is published as part of RDKM Open Source AAMP repo, and included here for convenience.

Changes should never be directly pushed, but rather added incrementally to a dedicated documentation ticket under a given main federated release ticket.  These These changes will be reviewed and brought forward at end of sprint. All UVE APIs and event changes must result in documentation updates.

...

This is the recommended mechanism for interfacing with the native AAMP video engine from WPE browser.  It exposes both basic and advanced features, without limitations of HTML5 video tag interface (which was not designed with DASH/HLS in mind). 

Code Block
languagexml
themeMidnight
<html><head><title>AAMP playback in WPE browser using UVE APIs</title></head>

...


<script>

...


    var url = "

...

http://

...

d3rlna7iyyu8wu.

...

cloudfront.net/skip_armstrong/skip_armstrong_multi_language_subs.m3u8";

...


    window.onload = function() {

...


        var player = new AAMPMediaPlayer();

...


        player.load(url);

...


    }

...


</script>

...


<body>

...


 <!-- video tag element used for hole punching, to ensure visibility of background video plane -->

...


    <video style="height:100%; width:100%; position:absolute; bottom:0; left:0" src="dummy.mp4" type="video/ave"/> 

...


 </video>

...


</body>

...


</html>

HTML5 Video Tag based Playback

...

Minimal Video Tag based Playback Example:

Code Block
languagexml
themeMidnight
<html><head><title>AAMP playback in WPE browser using HTML5 video tag</title></head>

...


<script>

...


    // assign HLS or DASH locator here, with protocol changed to aamp:// or aamps://

...


    var url = "aamps://

...

d3rlna7iyyu8wu.

...

cloudfront.net/skip_armstrong/skip_armstrong_multi_language_subs.m3u8";    

...


    window.onload = function() {

...


        var video = document.getElementById("video");

...


        video.src = url;

...


 video.play();

...


    }

...


</script>

...


<body">

...


    <video id="video" style="height:100%; width:100%; position:absolute; bottom:0; left:0" src=""/>

...


</body>

...


</html>

...