
{"id":10031,"date":"2022-06-21T09:10:42","date_gmt":"2022-06-21T09:10:42","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/components\/open-sourced_components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/"},"modified":"2025-03-25T05:18:34","modified_gmt":"2025-03-25T05:18:34","slug":"aamp_app_integration_universal_video_engine_uve_apis","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/","title":{"rendered":"AAMP App Integration: Universal Video Engine (UVE) APIs"},"content":{"rendered":"\n <p>Official UVE-JS API documentation.<\/p><p><span class=\"confluence-embedded-file-wrapper conf-macro output-inline\" data-hasbody=\"false\" data-macro-name=\"view-file\"><div class=\"wp-block-file\"><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/AAMP-UVE-API(V2.10).pdf\">AAMP-UVE-API(V2.10).pdf<\/a><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/AAMP-UVE-API(V2.10).pdf\" class=\"wp-block-file__button\">Download<\/a><\/div><span class=\"companion-edit-button-placeholder edit-button-overlay\" data-linked-resource-container-id=\"211788169\" data-linked-resource-id=\"211788171\" data-template-name=\"companionEditIcon\" data-source-location=\"embedded-attachment\"> <\/span><\/span><\/p><p><span class=\"confluence-embedded-file-wrapper conf-macro output-inline\" data-hasbody=\"false\" data-macro-name=\"view-file\"><div class=\"wp-block-file\"><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/UVE-EVENTS-GAP.xlsx\">UVE-EVENTS-GAP.xlsx<\/a><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/UVE-EVENTS-GAP.xlsx\" class=\"wp-block-file__button\">Download<\/a><\/div><span class=\"companion-edit-button-placeholder edit-button-overlay\" data-linked-resource-container-id=\"211788169\" data-linked-resource-id=\"211788170\" data-template-name=\"companionEditIcon\" data-source-location=\"embedded-attachment\"> <\/span><\/span><\/p><p><br><\/p><p><span><span>This document is published as part of RDKM Open Source AAMP repo, and included here for convenience.<\/span><\/span><\/p><p><span><span>Changes should never be directly pushed, but rather added incrementally to a dedicated documentation ticket under a given main federated release ticket. These changes will be reviewed and brought forward at end of sprint.<\/span><\/span><span>&nbsp;All UVE APIs and event changes must result in documentation updates.<\/span><\/p><h3 class=\"wp-sub-header\"><span>Process:<\/span><\/h3><p><span><span>-&gt; Update the document for new changes in tracking mode ,dont accept the changes . That will help us to review changes<\/span><br style=\"text-decoration: none;text-align: left\"><span>-&gt; Follow the template used : font , color , size ,tabular column format , numbering scheme etc<\/span><br style=\"text-decoration: none;text-align: left\"><span>-&gt; Rename the document with change summary : AAMP-UVE-API_&lt;SmallSummary&gt; and upload to ticket .<\/span><br style=\"text-decoration: none;text-align: left\"><span>-&gt; Add a comment in ticket update the document change added .<\/span><br style=\"text-decoration: none;text-align: left\"><strong style=\"text-decoration: none;text-align: left\">-&gt; Not to create review for sprint merge for each document change<\/strong><br style=\"text-decoration: none;text-align: left\"><span>-&gt; All document changes after review will merged together at sprint closure .<\/span><br style=\"text-decoration: none;text-align: left\"><strong style=\"text-decoration: none;text-align: left\">-&gt; Not to have separate ticket for document update.<\/strong><\/span><\/p><h3 id=\"AAMPAppIntegration:UniversalVideoEngine(UVE)APIs-UniversalVideoEngine(UVE)APIs\">Universal Video Engine (UVE) APIs<\/h3><p>This is the recommended mechanism for interfacing with the native AAMP video engine from WPE browser. &nbsp;It exposes both basic and advanced features, without limitations of HTML5 video tag interface (which was not designed with DASH\/HLS in mind).&nbsp;<\/p><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">&lt;html&gt;&lt;head&gt;&lt;title&gt;AAMP playback in WPE browser using UVE APIs&lt;\/title&gt;&lt;\/head&gt;\n&lt;script&gt;\n&nbsp;&nbsp;&nbsp;&nbsp;var url = \"http:\/\/d3rlna7iyyu8wu.cloudfront.net\/skip_armstrong\/skip_armstrong_multi_language_subs.m3u8\";\n&nbsp; &nbsp; window.onload = function() {\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;var player = new AAMPMediaPlayer();\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;player.load(url);\n&nbsp;&nbsp;&nbsp;&nbsp;}\n&lt;\/script&gt;\n&lt;body&gt;\n &lt;!-- video tag element used for hole punching, to ensure visibility of background video plane --&gt;\n    &lt;video style=\"height:100%; width:100%; position:absolute; bottom:0; left:0\" src=\"dummy.mp4\" type=\"video\/ave\"\/&gt; \n &lt;\/video&gt;\n&lt;\/body&gt;\n&lt;\/html&gt;<\/pre>\n<\/div><\/div><pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\"><br><\/pre><h3 id=\"AAMPAppIntegration:UniversalVideoEngine(UVE)APIs-HTML5VideoTagbasedPlayback\">HTML5 Video Tag based Playback<\/h3><p>AAMP can also be used for playback as a plugin directly using HTML5 &lt;video&gt; tag, by passing locator that starts with aamp:\/\/ (for http) or aamps:\/\/ (for https) for source. &nbsp;This mode of playback has a number of limitations, but is easy for quick test and may be sufficient for some partners.<\/p><p>Minimal Video Tag based Playback Example:<\/p><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">&lt;html&gt;&lt;head&gt;&lt;title&gt;AAMP playback in WPE browser using HTML5 video tag&lt;\/title&gt;&lt;\/head&gt;\n&lt;script&gt;\n    \/\/ assign HLS or DASH locator here, with protocol changed to aamp:\/\/ or aamps:\/\/\n    var url = \"aamps:\/\/d3rlna7iyyu8wu.cloudfront.net\/skip_armstrong\/skip_armstrong_multi_language_subs.m3u8\";&nbsp; &nbsp;&nbsp;\n    window.onload = function() {\n        var video = document.getElementById(\"video\");\n        video.src = url;\n video.play();\n    }\n&lt;\/script&gt;\n&lt;body\"&gt;\n    &lt;video id=\"video\" style=\"height:100%; width:100%; position:absolute; bottom:0; left:0\" src=\"\"\/&gt;\n&lt;\/body&gt;\n&lt;\/html&gt;<\/pre>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Official UVE-JS API documentation. This document is published as part of RDKM Open Source AAMP [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10015,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10031","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Official UVE-JS API documentation. This document is published as part of RDKM Open Source AAMP [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:34+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/\",\"name\":\"AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:10:42+00:00\",\"dateModified\":\"2025-03-25T05:18:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Video\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Advanced Adaptive Media Player (AAMP)\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"AAMP App Integration: Universal Video Engine (UVE) APIs\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/","og_locale":"en_US","og_type":"article","og_title":"AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation","og_description":"Official UVE-JS API documentation. This document is published as part of RDKM Open Source AAMP [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:34+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/","name":"AAMP App Integration: Universal Video Engine (UVE) APIs - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:10:42+00:00","dateModified":"2025-03-25T05:18:34+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_app_integration_universal_video_engine_uve_apis\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Video","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"Advanced Adaptive Media Player (AAMP)","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/"},{"@type":"ListItem","position":6,"name":"AAMP App Integration: Universal Video Engine (UVE) APIs"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10031","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=10031"}],"version-history":[{"count":2,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10031\/revisions"}],"predecessor-version":[{"id":11724,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10031\/revisions\/11724"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10015"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=10031"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}