{"id":10122,"date":"2022-06-21T09:10:49","date_gmt":"2022-06-21T09:10:49","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/components\/open-sourced_components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/"},"modified":"2025-03-25T05:18:35","modified_gmt":"2025-03-25T05:18:35","slug":"aamp_uve_-_api","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/","title":{"rendered":"AAMP UVE – API"},"content":{"rendered":"\n
\n
\n
\n
\n
<\/div><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n

Unified Video Engine (UVE) APIs<\/h2>


<\/p><\/div>\n<\/div>\n<\/div>\n

\n
\n
\n

Overview<\/h3>
<\/div>

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.<\/p>


<\/p><\/div>\n<\/div>\n<\/div>\n

\n
\n
\n

Target Audience<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n

This document is targeted towards OTT app vendors and HTML5 developers who are interested in evaluating\/adopting AAMP for 
their media player applications on set-tops running RDKV based firmware. <\/p>

Features <\/h3>
  • Formats: HLS, DASH, Fragmented MP4 HLS <\/li>
  • DRM Systems: Clear Key, Adobe Access, Vanilla AES-128, PlayReady, Widevine <\/li>
  • Captions: CEA-608\/708 Captions , WebVTT <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
    \n
    \n
    \n


    <\/p>


    <\/p>

    Roadmap<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
    \n
    \n
    \n
    • Video Guard (VGC) DRM <\/li>
    • DVB, EBU-TT captions<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
      \n
      \n
      \n


      <\/p>


      <\/p>

      Release Version<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
      \n
      \n
      \n
      <\/colgroup>
      S.No.<\/th>Release Version<\/th>Release Notes <\/th><\/tr>
      1<\/td>0.7 <\/td>Initial draft of UVE APIs implemented <\/td><\/tr>
      2<\/td>0.8 <\/td>CDAI support, configuration options for tune optimization 
      API: 
      • setAlternateContent <\/li>
      • notifyReservationCompletion <\/li>
      • addCustomHTTPHeader <\/li><\/ul>


        <\/p>

        Configuration: <\/p>

        • stereoOnly <\/li>
        • bulkTimedMetadata <\/li>
        • useWesterosSink <\/li>
        • parallelPlaylistDownload <\/li><\/ul>


          <\/p>

          Events: <\/p>

          • bufferingChanged <\/li>
          • timedMetadata <\/li>
          • adResolved <\/li>
          • reservationStart <\/li>
          • reservationEnd <\/li>
          • placementStart <\/li>
          • placementEnd <\/li>
          • placementProgress <\/li>
          • placementError<\/li><\/ul><\/td><\/tr>
      3<\/td>0.9 <\/td>“Player Switching” Feature
      • load (autoplay=false support) <\/li>
      • detach() method<\/li><\/ul><\/td><\/tr>
      4<\/td>1.0<\/td>

      Added support to get available audio track and closed captioning info<\/p>

      API: <\/p>

      • getAvailableAudioTracks<\/li>
      •  getAvailableTextTracks <\/li><\/ul>


        Configuration: <\/p>

        • playlistTimeout<\/li>
        • parallelPlaylistRefresh<\/li>
        • useAverageBandwidth<\/li>
        • preCachePlaylistTime<\/li>
        • progressReportingInterval<\/li>
        • useRetuneForUnpairedDiscontinuity<\/li>
        • drmDecryptFailThreshold <\/li><\/ul><\/td><\/tr>
      5<\/td>2.4 <\/td>

      April 2020 Release Update <\/p>

      Configuration:<\/p>

      • initialBuffer<\/li>
      • useMatchingBaseUrl<\/li>
      • initFragmentRetryCount<\/li><\/ul>

        Event Notification <\/p><\/td><\/tr>

      6<\/td>2.6 <\/td>

      June 2020 Release Update 
      Seek while paused, get\/set audio and text track supported <\/p>

      API:<\/p>

      • getAudioTrack<\/li>
      • setAudioTrack<\/li>
      • getTextTrack<\/li>
      • setTextTrack<\/li>
      • setClosedCaptionStatus<\/li>
      • setTextStyleOptions<\/li>
      • getTextStyleOptions <\/li><\/ul>

        Configuration:<\/p>

        • nativeCCRendering<\/li>
        • langCodePreferenc<\/li>
        • descriptiveTrackName  <\/li><\/ul><\/td><\/tr>
      7<\/td>2.7 <\/td>

      Aug 2020 Release Update <\/p>

      Configuration:<\/p>

      • Deprecated useWesterosSink <\/li><\/ul><\/td><\/tr>
      8<\/td>2.9 <\/td>

      Sept 2020 Release Update <\/p>

      Configuration:<\/p>

      • authToken<\/li>
      • useRetuneForGstInternalError<\/li><\/ul><\/td><\/tr>
      9<\/td>3<\/td>

      Oct 2020 Release update. <\/p>

      • Updated getAvailableAudioTracks \/ getAvailableTextTracks <\/li><\/ul>

        API: <\/p>

        • setAudioLanguage <\/li><\/ul>

          Configuration: <\/p>

          • propagateUriParameters 
            reportVideoPTS<\/li><\/ul>

            ATSC – UVE Features Added .  <\/span><\/p><\/td><\/tr>

      10<\/td>3.1<\/td>

      Jan 2021 Release update. 
      ATSC New APIs \/ Events<\/p>

      API: <\/p>

      • getAvailableThumbnailTracks<\/li>
      • setThumbnailTrack<\/li>
      • getThumbnail <\/li><\/ul>

        Configuration: <\/p>

        • sslVerifyPeer<\/li>
        • persistBitrateOverSeek<\/li>
        • setLicenseCaching<\/li>
        • maxPlaylistCacheSize<\/li>
        • enableSeekableRange  <\/li><\/ul><\/td><\/tr>
      11<\/td>3.2<\/td>

      Mar 2021 Release update 
      API: <\/p>

      • setPreferredAudioLanguage<\/li>
      • setAudioTrack <\/li><\/ul>

        Configuration:  <\/p>

        • livePauseBehavior<\/li>
        • limitResolution <\/li><\/ul><\/td><\/tr>
      12<\/td>3.3<\/td>

      May 2021 Release update 
      Configuration:<\/p>

      • useAbsoluteTimeline asyncTune <\/li><\/ul>

        Events : <\/p>

        • Updated bitrateChanged for ATSC <\/li><\/ul><\/td><\/tr>
      13<\/td>3.4<\/td>

      Events :  <\/p>

      • audioTracksChanged<\/li>
      • textTracksChanged<\/li>
      • seeked<\/li>
      • vttCueDataListener<\/li>
      • id3Metadata<\/li><\/ul><\/td><\/tr>
      14<\/td>3.5<\/td>

      Aug 2021 Release update 
      API:<\/p>

      • load (updated)<\/li>
      • setPreferredAudioLanguage (updated)<\/li>
      • getAvailableAudioTracks (updated)<\/li>
      • getAvailableTextTracks (updated)<\/li>
      • downloadBuffer default value(updated) <\/li><\/ul>

        Events :<\/p>

         id3Metadata<\/p><\/td><\/tr>

      15<\/td>3.6 <\/td>

      Sept 2021 Release update <\/p>

      Configuration:<\/p>

      • disable4K<\/li>
      • sharedSSL<\/li>
      • preferredAudioRendition<\/li>
      • preferredAudioCodec  <\/li><\/ul>

        Events: <\/p>

        • mediaMetadata (updated) <\/li><\/ul><\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n


          <\/p>


          <\/p>

          Minimal Sample Player<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          \n
          <html><head><title>IP Video Playback in WPE browser using UVE API<\/title><\/head>\n<script>\nwindow.onload = function() { \nvar player = new AAMPMediaPlayer(); \nvar url = \"https:\/\/cpetestutility.stb.r53.xcal.tv\/multilang\/main.m3u8\"; \n player.load(url); \n} \n<\/script>\n<body>\n <div id=\"videoContainer\">\n <video style=\"height:100%; width:100%; position:absolute; bottom:0; left:0\">\n <source src=\"dummy.mp4\" type=”video\/ave”> <!-- hole punching -->\n <\/video>\n <\/div>\n<\/body>\n<\/html><\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n

          <\/p>

          <\/p>
          Folder Structure: Full Reference Player<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          -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<\/p>

          <\/p><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          Universal Video Engine APIs  <\/h2>

          <\/p><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          Properties<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
           <\/colgroup>
          Name<\/th>Type <\/th>Description<\/th><\/tr>
          version <\/td>number<\/td>May be used to confirm if RDKV 
          build in use supports a newer 
          feature <\/td><\/tr>
          AAMP.version <\/td>number<\/td>Global variable for applications to 
          get UVE API version without 
          creating a player instance. Value 
          will be same as player.version. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n

          <\/p>

          <\/p>
          Methods<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          load( uri, autoplay, tuneParams) <\/h3><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          • Begin streaming<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
            \n
            \n
            \n
             <\/colgroup>
            Name<\/th>Type <\/th>Description<\/th><\/tr>
            Uri<\/td>String <\/td>URI of the Media to be played by the Video Engine<\/td><\/tr>
            autoplay<\/td>Boolean<\/td>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. <\/td><\/tr>
            tuneParams<\/td>Object<\/td>optional 3rd parameter 
            The tuneParams Object includes four elements contentType, traceId, 
            isInitialAttempt and isFinalAttempt. Details provided in below table <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
            \n
            \n
            \n
             <\/colgroup>
            Name<\/th>Type<\/th>Description<\/th><\/tr>
            contentType <\/td>String <\/td>Content Type of the asset taken for playback. 
            Eg: CDVR, VOD, LINEAR_TV, IVOD, EAS, PPV, OTT, OTA, HDMI_IN, 
            COMPOSITE_IN, SLE  <\/td><\/tr>
            traceId<\/td>String<\/td>Trace ID which is unique for a tune. <\/td><\/tr>
            isInitialAttempt <\/td>Boolean<\/td>Flag indicates if it’s the first tune initiated, tune is neither a retry nor a 
            rollback. <\/td><\/tr>
            isInitialAttempt <\/td>Boolean <\/td>Flag indicates if it’s the first tune initiated, tune is neither a retry nor a 
            rollback. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
            \n
            \n
            \n
            play() <\/h3><\/div>\n<\/div>\n<\/div>\n
            \n
            \n
            \n
            • Supported UVE version 0.7 and above.<\/li>
            • Start playback (if stream is in prebuffered state), or resume playback at normal speed. Equivalent to 
              setPlaybackRate(1).  <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
              \n
              \n
              \n
              pause()<\/h3><\/div>\n<\/div>\n<\/div>\n
              \n
              \n
              \n
              • Supported UVE version 0.7 and above.<\/li>
              • Pauses playback. Equivalent to setPlaybackRate(0). <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                \n
                \n
                \n
                stop()<\/h3><\/div>\n<\/div>\n<\/div>\n
                \n
                \n
                \n
                • Supported UVE version 0.7 and above.<\/li>
                • Stop playback and free resources associated with playback.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                  \n
                  \n
                  \n
                  seek( offset )<\/h3><\/div>\n<\/div>\n<\/div>\n
                  \n
                  \n
                  \n
                  • Supported UVE version 0.7 and above.<\/li>
                  • Specify initial or new stream playback position. May be called prior to first load() call (or implicitly using 
                    initConfig’s “offset” parameter), or while streaming.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                    \n
                    \n
                    \n
                     <\/colgroup>
                    Name <\/th>Type <\/th>Description<\/th><\/tr>
                    offset <\/td>Number (s)<\/td>Offset from beginning of VOD asset. For live playback, offset is relative to 
                    eldest portion of initial window. Offset value should be in seconds 
                    Note that ability to seek is currently limited to fragment granularity.<\/td><\/tr>
                    keepPause<\/td>Boolean<\/td>Flag indicates if player was in paused state before seek then maintain the 
                    same state post seek 
                    Available starting with version 2.6 <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                    \n
                    \n
                    \n
                    getCurrentPosition()<\/h3><\/div>\n<\/div>\n<\/div>\n
                    \n
                    \n
                    \n
                    • Supported UVE version 0.7 and above.<\/p><\/li>
                    • Returns current playback position in seconds.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                      \n
                      \n
                      \n
                      getCurrentState() <\/h3><\/div>\n<\/div>\n<\/div>\n
                      \n
                      \n
                      \n
                      • Supported UVE version 0.7 and above.<\/li>
                      • Returns one of below logical player states as number: <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                        \n
                        \n
                        \n
                         <\/colgroup>
                        State Name<\/th>Value <\/th>Semantics<\/th>Remarks <\/th><\/tr>
                        idle<\/td>0<\/td>eSTATE_IDLE <\/td>Player is idle<\/td><\/tr>
                        initializing<\/td>1<\/td>eSTATE_INITIALIZING<\/td>Player is initializaing resources to 
                        start playback <\/td><\/tr>

                        <\/td>                        		2<\/td>eSTATE_INITIALIZED<\/td>Player is initializaing resources to 
                        start playback <\/td><\/tr>

                        <\/td>                        		3<\/td>eSTATE_PREPARING<\/td>Create internal resources required 
                        for DRM decryption and playback <\/td><\/tr>

                        <\/td>                        		4<\/td>eSTATE_PREPARED <\/td>Required resources are initialized 
                        successfully<\/td><\/tr>

                        <\/td>                        		5<\/td>eSTATE_BUFFERING<\/td>When player does internal buffering 
                        mid-playback. Note -send out in 
                        initial buffering<\/td><\/tr>

                        <\/td>                        		6<\/td>eSTATE_PAUSED<\/td>Indicates player is paused <\/td><\/tr>

                        <\/td>                        		7<\/td>eSTATE_SEEKING<\/td>Indicates player is seeking<\/td><\/tr>

                        <\/td>                        		8<\/td>eSTATE_PLAYING<\/td>Indicates player is seeking<\/td><\/tr>

                        <\/td>                        		9<\/td>eSTATE_STOPPING<\/td>Not supported, for future <\/td><\/tr>

                        <\/td>                        		10<\/td>eSTATE_STOPPED<\/td>Not supported, for future <\/td><\/tr>

                        <\/td>                        		11<\/td>eSTATE_COMPLETE <\/td>When the media reaches end. <\/td><\/tr>

                        <\/td>                        		12<\/td>eSTATE_ERROR<\/td>In case any error occurred<\/td><\/tr>

                        <\/td>                        		13<\/td>eSTATE_RELEASED <\/td>Not supported, for future  <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                        \n
                        \n
                        \n
                        getDurationSec()<\/h3><\/div>\n<\/div>\n<\/div>\n
                        \n
                        \n
                        \n
                        • Supported UVE version 0.7 and above.<\/li>
                        • Returns current duration of content in seconds. Duration is fixed for VOD content, but may grow with DVR 
                          content. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                          \n
                          \n
                          \n
                          getVolume()<\/h3><\/div>\n<\/div>\n<\/div>\n
                          \n
                          \n
                          \n
                          • Supported UVE version 0.7 and above.<\/li>
                          • Get current volume (value between 0 and 100). Default audio volume is 100. Volume is normally mapped from 
                            remote directly to TV, with video engine used to manage an independent mute\/unmute state for parental 
                            control.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                            \n
                            \n
                            \n
                            setVolume ( volume )<\/h3><\/div>\n<\/div>\n<\/div>\n
                            \n
                            \n
                            \n
                            • Supported UVE version 0.7 and above.<\/li>
                            • Sets the current volume (value between 0 and 100). Updated value reflected in subsequent calls to getVolume() <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                              \n
                              \n
                              \n
                               <\/colgroup>
                              Name<\/th>Name<\/th>Description<\/th><\/tr>
                              volume<\/td>Number<\/td>Pass zero to mute audio. 
                              Pass 100 for normal (max) audio volume.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                              \n
                              \n
                              \n
                              setVideoMute( enabled )<\/h3><\/div>\n<\/div>\n<\/div>\n
                              \n
                              \n
                              \n
                              • Supported UVE version 0.7 and above.<\/li>
                              • Enable or black out video for parental control purposes, default is false<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                \n
                                \n
                                \n
                                 <\/colgroup>
                                Name<\/th>Type<\/th>Description<\/th><\/tr>
                                volume <\/td>Number<\/td>Pass false to black out video. 
                                Pass true to resume presenting video. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                \n
                                \n
                                \n
                                getPlaybackRate()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                \n
                                \n
                                \n
                                • Supported UVE version 0.7 and above.<\/li>
                                • Returns the current playback rate.  <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                  \n
                                  \n
                                  \n
                                  setPlaybackRate( rate )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                  \n
                                  \n
                                  \n
                                  • Supported UVE version 0.7 and above.<\/li>
                                  • Change playback rate, supported speeds are given below – <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                    \n
                                    \n
                                    \n
                                     <\/colgroup>
                                    Value<\/th>Description<\/th><\/tr>
                                    0<\/td>Pause<\/td><\/tr>
                                    1<\/td>Normal Play <\/td><\/tr>
                                    4<\/td>2x Fast Forward (using iframe track) <\/td><\/tr>
                                    16<\/td>4x Fast Forward (using iframe track) <\/td><\/tr>
                                    32<\/td>8x Fast Forward (using iframe track) <\/td><\/tr>
                                    64<\/td>16x Fast Forward (using iframe track)<\/td><\/tr>
                                    -4<\/td>2x Rewind (using iframe track)<\/td><\/tr>
                                    -16<\/td>4x Rewind (using iframe track)<\/td><\/tr>
                                    -32<\/td>4x Rewind (using iframe track)<\/td><\/tr>
                                    -64<\/td>16x Rewind (using iframe track) <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                    \n
                                    \n
                                    \n
                                    getVideoBitrates()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                    \n
                                    \n
                                    \n
                                    • Supported UVE version 0.7 and above.<\/li>
                                    • Return array of available video bitrates across profiles. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                      \n
                                      \n
                                      \n
                                      getCurrentVideoBitrate()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                      \n
                                      \n
                                      \n
                                      • Supported UVE version 0.7 and above.<\/li>
                                      • Return current video bitrate, as bits per second.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                        \n
                                        \n
                                        \n
                                        setVideoBitrate( bitrate )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                        \n
                                        \n
                                        \n
                                        • Supported UVE version 0.7 and above.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                          \n
                                          \n
                                          \n
                                           <\/colgroup>
                                          Name<\/th>Type <\/th>Description<\/th><\/tr>
                                          bitrate <\/td>Number<\/td>Pass bitrate from getVideoBitrates to disable ABR and lock playback to single 
                                          profile. 
                                          Pass zero to (re)enable ABR, allowing Video Engine to select from available 
                                          bitrates based on network bandwidth.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                          \n
                                          \n
                                          \n
                                          getCurrentAudioBitrate()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                          \n
                                          \n
                                          \n
                                          • Supported UVE version 0.7 and above.<\/li>
                                          • Return current audio bitrate, as bits per second. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                            \n
                                            \n
                                            \n
                                            setVideoRect( x, y, w, h )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                            \n
                                            \n
                                            \n
                                            • Supported UVE version 0.7 and above.<\/li>
                                            • Set display video rectangle coordinates. Note that by default video will be fullscreen.<\/li>
                                            • Rectangle specified in “graphics resolution” coordinates (coordinate space used by graphics overlay).<\/li>
                                            • Window size is typically 1280×720, but can be queried at runtime as follows: 
                                              var w = window.innerWidth || document.documentElement.clientWidth ||document.body.clientWidth; 
                                              var h = window.innerHeight|| document.documentElement.clientHeight|| document.body.clientHeight;<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                              \n
                                              \n
                                              \n
                                               <\/colgroup>
                                              Name<\/th>Type <\/th>Description<\/th><\/tr>
                                              X <\/td>Number<\/td>Left position for video  <\/td><\/tr>
                                              Y<\/td>Number<\/td>Top position for video<\/td><\/tr>
                                              W<\/td>Number<\/td>Video width<\/td><\/tr>
                                              H<\/td>Number<\/td>Video height<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                              \n
                                              \n
                                              \n
                                              setVideoZoom( videoZoom )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                              \n
                                              \n
                                              \n
                                              • Supported UVE version 0.7 and above.<\/li>
                                              • Set video zoom, by default its set to “full”<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                \n
                                                \n
                                                \n
                                                 <\/colgroup>
                                                Name <\/th>Type <\/th>Description<\/th><\/tr>
                                                videoZoom<\/td>String<\/td>“none” to disable video zoom mode. “full” to enable video zoom mode.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                \n
                                                \n
                                                \n
                                                addCustomHTTPHeader( headerName, headerValue, isLicenseRequest )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                \n
                                                \n
                                                \n
                                                • Supported UVE version 0.8 and above.<\/li>
                                                • Add custom headers to HTTP requests<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                  \n
                                                  \n
                                                  \n
                                                   <\/colgroup>
                                                  Name<\/th>Type<\/th>Description<\/th><\/tr>
                                                  headerName <\/td>String<\/td>HTTP header name<\/td><\/tr>
                                                  headerValue isLicenseRequest<\/td>String Array Boolean<\/td>
                                                  HTTP header value<\/p>
                                                  (defaults to false) indicates if the HTTP header is for exclusive use with <\/span>PlayReady\/Widevine license requests <\/span><\/p><\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                  \n
                                                  \n
                                                  \n
                                                  removeCustomHTTPHeader( headerName )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                  \n
                                                  \n
                                                  \n
                                                  • Supported UVE version 0.8 and above.<\/li>
                                                  • Remove a custom header set previously. If called with no arguments, will remove all custom headers. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                    \n
                                                    \n
                                                    \n
                                                     <\/colgroup>
                                                    Name <\/th>Type<\/th>Description<\/th><\/tr>
                                                    headerName <\/td>String <\/td>HTTP header name<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                    \n
                                                    \n
                                                    \n
                                                    getAvailableAudioTracks()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                    \n
                                                    \n
                                                    \n
                                                    • Supported UVE version 1.0 and above.<\/li>
                                                    • Returns the available audio tracks information in the content.<\/li><\/ul>
                                                      DASH <\/p><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                       <\/colgroup>
                                                      Name<\/th>Type <\/th>Description <\/th><\/tr>
                                                      name <\/td>String <\/td>Human readable language name 
                                                      e.g: Spanish, English<\/td><\/tr>
                                                      language<\/td>String <\/td>Specifies dominant language of the audio
                                                      e.g: spa, eng<\/td><\/tr>
                                                      rendition<\/td>String <\/td>Role for DASH 
                                                      If not present, the role is assumed to be main 
                                                      e.g: caption, subtitle, main<\/td><\/tr>
                                                      characteristics <\/td>String <\/td>Not mapped<\/td><\/tr>
                                                      Channels <\/td>String <\/td>Indicates the maximum number of audio channels 
                                                      1 = mono, 2=stereo, up to 8 for DD+<\/td><\/tr>
                                                      bandwidth<\/td>String <\/td>Represents variants of the bitrates available for the media type 
                                                      e.g: 288000<\/td><\/tr>
                                                      codec <\/td>String <\/td>codec associated with Adaptation Set.
                                                      e.g: mp4a.40.2  <\/td><\/tr>
                                                      accessibilityType<\/td>String <\/td>Accessibility value for descriptive, visually impaired signaling 
                                                      e.g: description, captions <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      Example<\/b><\/div>
                                                      \n
                                                      { \n\"name\": \"5\", \n\"language\": \"ger\", \n\"codec\": \"mp4a.40.2\", \n\"rendition\": \"german\", \n\"accessibiltyType\": \"description\", \n\"bandwidth\": 288000 \n} \n<\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      Reference<\/b><\/div>
                                                      \n
                                                       <AdaptationSet id=\"3\" contentType=\"audio\" segmentAlignment=\"true\" bitstreamSwitching=\"true\" lang=\"ger\"> \n<Role schemeIdUri=\"urn:mpeg:dash:role:2011\" value=\"german\"\/> \n<Accessibility schemeIdUri=\"urn:mpeg:dash:role:2011\" value=\"description\" \/> \n<Representation id=\"5\" mimeType=\"audio\/mp4\" codecs=\"mp4a.40.2\" bandwidth=\"288000\" audioSamplingRate=\"48000\"\n> \n<AudioChannelConfiguration schemeIdUri=\"urn:mpeg:dash:23003:3:audio_channel_configuration:2011\" value=\"1\"\/> \n<\/AdaptationSet> <\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      HLS<\/p><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                       <\/colgroup>
                                                      Name <\/th>Type<\/th>Description <\/th><\/tr>
                                                      name<\/td>String<\/td>Human-readable description of the Rendition.
                                                      e.g:english, spanish<\/td><\/tr>
                                                      type <\/td>String<\/td>Specifies the media type. Valid strings are AUDIO, VIDEO, SUBTITLES 
                                                      and CLOSED-CAPTIONS. This attribute is REQUIRED. 
                                                      e.g: CLOSED-CAPTIONS <\/td><\/tr>
                                                      language <\/td>String<\/td>Identifies the primary language used in the Rendition. This attribute 
                                                      is OPTIONAL. 
                                                      e.g: es<\/td><\/tr>
                                                      rendition <\/td>String<\/td>Specifies the group to which the Rendition belongs. 
                                                      GROUP-ID for HLS.  <\/td><\/tr>
                                                      instreamId <\/td>String<\/td>Specifies a Rendition within the segments in the Media Playlist. This 
                                                      attribute is REQUIRED if the TYPE attribute is CLOSED-CAPTIONS 
                                                      e.g: “CC1”, “CC2”, “CC3”, “CC4”, or “SERVICEn” where n MUST be an 
                                                      integer between 1 and 63<\/td><\/tr>
                                                      codec<\/td>String<\/td>Comma-delimited list of formats, where each format specifies a media 
                                                      sample type that is present in one or more Renditions specified by 
                                                      the Variant Stream.<\/td><\/tr>
                                                      characteristics <\/td>String<\/td>Pne or more comma-delimited Uniform Type Identifiers [UTI]. This 
                                                      attribute is OPTIONAL.  <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      Example<\/b><\/div>
                                                      \n
                                                       { \n \"name\": \"Deutsch\", \n \"type\": \"SUBTITLES\", \n \"language\": \"de\", \n \"rendition\": \"subs\" \n } \nReference \n#EXT-X-MEDIA:TYPE=SUBTITLES,GROUPID=\"subs\",NAME=\"Deutsch\",DEFAULT=NO,AUTOSELECT=YES,FORCED=NO,LANGUAGE=\"de\",URI=\"subtitles_de.m3u8\" \n#EXT-X-STREAM-INF:PROGRAMID=1,BANDWIDTH=258157,CODECS=\"avc1.4d400d,mp4a.40.2\",AUDIO=\"stereo\",RESOLUTION=422x180,SUBTITLES=\"subs\" <\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      getVideoRectangle()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                      \n
                                                      \n
                                                      \n
                                                      • Supported UVE version 1.0 and above.<\/li>
                                                      • Returns the current video rectangle co-ordinates. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                        \n
                                                        \n
                                                        \n
                                                        getAudioTrack( )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                        \n
                                                        \n
                                                        \n
                                                        • Supported UVE version 2.6 and above.<\/li>
                                                        • Returns the index of current audio track in available audio track list.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                          \n
                                                          \n
                                                          \n
                                                          setAudioTrack(index ) <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                          \n
                                                          \n
                                                          \n
                                                          • Supported UVE version 2.6 and above.<\/li>
                                                          • Set the audio track language from available audio track list.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                            \n
                                                            \n
                                                            \n
                                                             <\/colgroup>
                                                            Name<\/th>Type <\/th>Description<\/th><\/tr>
                                                            index<\/td>Number <\/td>Track Index of desired audio track in available audio track list <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                            \n
                                                            \n
                                                            \n
                                                            setAudioTrack( trackDescriptorObj )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                            \n
                                                            \n
                                                            \n
                                                            • Supported UVE version 3.2 and above.<\/li>
                                                            • Set the audio track by language and rendition from available audio track list.<\/li>
                                                            • “language” match always takes precedence over “rendition” match.<\/li>
                                                            • While playing passively to new periods with different track order\/availability, or when tuning to new locator, 
                                                              heuristic for track selection is automatically re-applied.<\/li>
                                                            • Note that for now, “best” codec (ATMOS > DD+ > Stereo) is always selected, subject to filtering configuration.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                              \n
                                                              \n
                                                              \n
                                                               <\/colgroup>
                                                              Name <\/th>Type <\/th>Description<\/th><\/tr>
                                                              language<\/td>String<\/td>Language of desired audio track in available audio track list <\/td><\/tr>
                                                              rendition<\/td>String<\/td>Rendition of desired audio track in available audio track list<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                              \n
                                                              \n
                                                              \n
                                                              Example<\/b><\/div>
                                                              \n
                                                              var trackDescriptorObject = \n{ \n\"language\": \"ger\", \n\"rendition\": \"commentary\" \n} \nplayerInstance.setAudioTrack( trackDescriptorObject ); <\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                              \n
                                                              \n
                                                              \n
                                                              setPreferredAudioLanguage( languages, rendition, accessibility)<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                              \n
                                                              \n
                                                              \n
                                                              • Supported UVE version 3.2 and above.<\/li>
                                                              • Set the audio track preference by languages, rendition and accessibility.<\/li>
                                                              • This is functionally equivalent to passing a trackDescriptorObject to setAudioTrack above.<\/li>
                                                              • May be called pre-tune or post tune.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                \n
                                                                \n
                                                                \n
                                                                 <\/colgroup>
                                                                Name<\/th>Type <\/th>Description<\/th><\/tr>
                                                                languages <\/td>String <\/td>ISO-639 audio language preference; for more than one language, provide comma delimited list from highest to lowest priority: ‘,<…>,’ <\/td><\/tr>
                                                                rendition <\/td>String <\/td>Optional preferred rendition for automatic audio selection.<\/td><\/tr>
                                                                accessibility<\/td>String <\/td>Optional preferred accessibility type for descriptive audio. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                \n
                                                                \n
                                                                \n
                                                                setAudioLanguage ( language )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                \n
                                                                \n
                                                                \n
                                                                • Supported UVE version 3.0 and above.<\/li>
                                                                • Set the audio track language from available audio track list.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                  \n
                                                                  \n
                                                                  \n
                                                                   <\/colgroup>
                                                                  Name<\/th>Type <\/th>Type <\/th><\/tr>
                                                                  language<\/td>String <\/td>Language of desired audio track in the available audio track list. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                  \n
                                                                  \n
                                                                  \n
                                                                  getTextTrack( ) <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                  \n
                                                                  \n
                                                                  \n
                                                                  • Supported UVE version 2.6 and above.<\/li>
                                                                  • Returns the index of current text track in available text track list.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                    \n
                                                                    \n
                                                                    \n
                                                                    setTextTrack( trackIndex )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                    \n
                                                                    \n
                                                                    \n
                                                                    • Supported UVE version 2.6 and above.<\/li>
                                                                    • Set the text track at trackIndex in available text track list.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                      \n
                                                                      \n
                                                                      \n
                                                                       <\/colgroup>
                                                                      Name <\/th>Type<\/th>Description <\/th><\/tr>
                                                                      trackIndex<\/td>Number<\/td>Index of desired text track in available text track list<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                      \n
                                                                      \n
                                                                      \n
                                                                      setClosedCaptionStatus ( status )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                      \n
                                                                      \n
                                                                      \n
                                                                      • Supported UVE version 2.6 and above.<\/li>
                                                                      • Set the ClosedCaption rendering to on\/off.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                        \n
                                                                        \n
                                                                        \n
                                                                         <\/colgroup>
                                                                        Name <\/th>Type <\/th>Description<\/th><\/tr>
                                                                         Status <\/td>Boolean <\/td>To turn on\/off ClosedCaption rendering.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                        \n
                                                                        \n
                                                                        \n
                                                                        getTextStyleOptions ( )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                        \n
                                                                        \n
                                                                        \n
                                                                        • Supported UVE version 2.6 and above.<\/li>
                                                                        • Returns the JSON formatted string of current ClosedCaption style options and values.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                          \n
                                                                          \n
                                                                          \n
                                                                          setTextStyleOptions ( options ) <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                          \n
                                                                          \n
                                                                          \n
                                                                          • Supported UVE version 2.6 and above.<\/li>
                                                                          • Set the ClosedCaption style options to be used for rendering.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                            \n
                                                                            \n
                                                                            \n
                                                                             <\/colgroup>
                                                                            Name<\/th>Type<\/th>Description<\/th><\/tr>
                                                                            options <\/td>String <\/td>JSON formatted string of different rendering style options and its values.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                            \n
                                                                            \n
                                                                            \n
                                                                            getAvailableThumbnailTracks ( )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                            \n
                                                                            \n
                                                                            \n
                                                                            •  Returns json array of each thumbnail track’s metadata.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                              \n
                                                                              \n
                                                                              \n
                                                                               <\/colgroup>
                                                                              Name <\/th>Type<\/th>Description <\/th><\/tr>
                                                                              Resolution <\/td>String<\/td>String indicating the width x height of the thumbnail images.<\/td><\/tr>
                                                                              Bandwidth <\/td>String<\/td>Decimal-Integer encoding – bits per second. Represents bit rate of the 
                                                                              thumbnail track.  <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                              \n
                                                                              \n
                                                                              \n
                                                                              Example<\/b><\/div>
                                                                              \n
                                                                              [{ \n \"RESOLUTION\": \"416x234\", \n \"BANDWIDTH\": 71416 \n }, { \n \"RESOLUTION\": \"336x189\", \n \"BANDWIDTH\": 52375 \n }, { \n \"RESOLUTION\": \"224x126\", \n \"BANDWIDTH\": 27413 \n }] \n\n<\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                              \n
                                                                              \n
                                                                              \n
                                                                              setThumbnailTrack(index)<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                              \n
                                                                              \n
                                                                              \n
                                                                              • Set the desired thumbnail track from the list of available thumbnail track metadata.<\/li>
                                                                              • Returns Boolean value true or false to indicate Success or Failure configuring the thumbnail track. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                \n
                                                                                \n
                                                                                \n
                                                                                 <\/colgroup>
                                                                                Name<\/th>Type <\/th>Description <\/th><\/tr>
                                                                                Index<\/td>Number<\/td>Index value based on the available thumbnail tracks. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                \n
                                                                                \n
                                                                                \n
                                                                                getThumbnail(startPosition, endPosition) <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                \n
                                                                                \n
                                                                                \n
                                                                                •  Get the thumbnail data for the time range “startPosition” till “endPosition”.  <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                   <\/colgroup>
                                                                                  Name<\/th>Type <\/th>Description<\/th><\/tr>
                                                                                  startPosition<\/td>Number<\/td>Start value from which the thumbnail data is fetched. <\/td><\/tr>
                                                                                  endPosition<\/td>Number<\/td>End value till which the thumbnail data is fetched. <\/td><\/tr>
                                                                                  baseUrl <\/td>String <\/td>The base url which is appended to tile url to fetch the required thumbnail 
                                                                                  image. <\/td><\/tr>
                                                                                  raw_w <\/td>String <\/td>Original width of the thumbnail sprite sheet. <\/td><\/tr>
                                                                                  raw_h <\/td>String <\/td>Original height of the thumbnail sprite sheet.  <\/td><\/tr>
                                                                                  width <\/td>String <\/td>Width of each thumbnail tile present in the sprite sheet.<\/td><\/tr>
                                                                                  height <\/td>String<\/td>Height of each thumbnail tile present in the sprite sheet. <\/td><\/tr>
                                                                                  tile <\/td>String<\/td>JSON array of multiple thumbnail tile information.<\/td><\/tr>
                                                                                  url <\/td>String<\/td>Url for each tile, which is appended with base url to form complete url.  <\/td><\/tr>
                                                                                  t <\/td>String <\/td>Presentation time for each tile. <\/td><\/tr>
                                                                                  d <\/td>String<\/td>Duration value of each tile.  <\/td><\/tr>
                                                                                  x<\/td>String<\/td>X co-ordinate position to locate the tile from sprite sheet. <\/td><\/tr>
                                                                                  y <\/td>String <\/td>Y co-ordinate position to locate the tile from sprite sheet.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  Example<\/b><\/div>
                                                                                  \n
                                                                                  { \n \"baseUrl\": \"https:\/\/g004-c-13a10cpeacockvodstg.s.llnwi.net\/pub\/global\/aOb\/kIc\/PCK_1604349987778_01\/cmaf_thumbtest_segtime_d\/mpeg_2sec\/\nimages\/416x234\/\", \n \"raw_w\": 3744, \n \"raw_h\": 3978, \n \"width\": 416, \n \"height\": 234, \n \"tile\": [{ \n \"url\": \"pckimage-1.jpg\", \n \"t\": 328.0, \n “d”: 2, \n \"x\": 832, \n \"y\": 234 \n }] \n} \n\n<\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n

                                                                                  <\/p>

                                                                                  <\/p>
                                                                                  Events<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                   <\/colgroup>
                                                                                  Event Name <\/th>Event Payload<\/th>Description<\/th><\/tr>
                                                                                  playbackStarted <\/td>
                                                                                  <\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired when playback starts<\/td><\/tr>
                                                                                  playbackStateChanged<\/td>state: number<\/td>– Supported UVE version 0.7 and above. 
                                                                                  – fired as state changes across play\/pause 
                                                                                  seek\/not-seek quadruplet <\/td><\/tr>
                                                                                  playbackProgressUpdate <\/td>durationMiliseconds: 
                                                                                  number, 
                                                                                  positionMiliseconds: 
                                                                                  number, 
                                                                                  playbackSpeed: 
                                                                                  number, 
                                                                                  startMiliseconds: 
                                                                                  number, 
                                                                                  endMiliseconds: 
                                                                                  number, 
                                                                                  currentPTS: number, 
                                                                                  videoBufferedMiliseco
                                                                                  nds : number <\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired based on the interval set 
                                                                                  – Added video PTS reporting if enabled 
                                                                                  with reportVideoPTS config 
                                                                                  – Added video buffer value (2.4 version)<\/td><\/tr>
                                                                                  bufferingChanged <\/td>buffering: bool <\/td>– Supported UVE version 0.8 and above.
                                                                                  – fired when AAMP encounters buffering 
                                                                                  mid-playback, buffering flag indicates 
                                                                                  buffer status 
                                                                                  FALSE -> No buffer for 
                                                                                  playback(Underflow) 
                                                                                  TRUE -> Buffer available for playback  <\/td><\/tr>
                                                                                  playbackCompleted<\/td>
                                                                                  <\/td>                                                                                  		– Supported UVE version 0.7 and above.
                                                                                  – fired when there is nothing left to play <\/td><\/tr>
                                                                                  playbackSpeedChanged<\/td>speed: number, 
                                                                                  reason: string<\/td>                                                                                  		– Supported UVE version 0.7 and above. <\/td><\/tr>
                                                                                  playbackFailed<\/td>shouldRetry: boolean,
                                                                                  code: number, 
                                                                                  description: string<\/td>                                                                                  		– Supported UVE version 0.7 and above.
                                                                                  – fired when an error occurs. <\/td><\/tr>
                                                                                  decoderAvailable <\/td>decoderHandle: 
                                                                                  number <\/td>                                                                                  		– Supported UVE version 0.7 and above.
                                                                                  – fired when video decoder handle 
                                                                                  becomes available, required for 
                                                                                  closedcaption parsing + rendering by RDK 
                                                                                  ClosedCaptions module<\/td><\/tr>
                                                                                  mediaMetadata <\/td>
                                                                                  durationMiliseconds: 
                                                                                  number, 
                                                                                  languages: string[], 
                                                                                  bitrates: number[],  <\/p>
                                                                                  playbackSpeeds: 
                                                                                  number[], 
                                                                                  width: number, 
                                                                                  height: number, 
                                                                                  hasDrm: boolean 
                                                                                  isLive: boolean 
                                                                                  programStartTime: 
                                                                                  DRM: string[]  <\/p><\/td>
                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired with metadata of the asset 
                                                                                  currently played, includes duration(in 
                                                                                  ms), audio language list, available bitrate 
                                                                                  list, hasDrm, supported playback speeds.<\/td><\/tr>
                                                                                  speedsChanged<\/td>playbackSpeeds: 
                                                                                  number[] <\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired when supported playback speeds 
                                                                                  changes (based on iframe availability).<\/td><\/tr>
                                                                                  id3Metadata <\/td>schemeIdUri : string 
                                                                                  value : string 
                                                                                  timescale : number 
                                                                                  presentationTime : 
                                                                                  number 
                                                                                  eventDuration : 
                                                                                  number 
                                                                                  id : number 
                                                                                  timestampOffset : 
                                                                                  number 
                                                                                  data : array 
                                                                                  length: number <\/td>                                                                                  		– This event is fired when 
                                                                                  ID3Metadata is parsed from the 
                                                                                  stream playlist. <\/td><\/tr>
                                                                                  vttCueDataListener<\/td>
                                                                                  start : number <\/p>
                                                                                  duration: number 
                                                                                  text:string<\/p><\/td>
                                                                                  – This event is fired for VTT cue.<\/p>
                                                                                  parsed from the WebVTT playlist. <\/p><\/td><\/tr>
                                                                                  audioTracksChanged<\/td>
                                                                                  <\/td>                                                                                  		– fired when Audio track is changed 
                                                                                  during playback.  <\/td><\/tr>
                                                                                  textTracksChanged <\/td>Position: number<\/td>– fired when Seek is triggered with a 
                                                                                  position.  <\/td><\/tr>
                                                                                  vttCueDataListener<\/td>code: number, 
                                                                                  description: string<\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired for VTT cue parsed from the 
                                                                                  WebVTT playlist in the asset.<\/td><\/tr>
                                                                                  drmMetadata <\/td>code: number, 
                                                                                  description: string<\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired when there is a change in DRM 
                                                                                  metadata (especially expiration of DRM 
                                                                                  auth data).<\/td><\/tr>
                                                                                  enteringLive<\/td>
                                                                                  <\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired when entering live point of a live 
                                                                                  playlist during\/after a seek\/trickplay 
                                                                                  operation.<\/td><\/tr>
                                                                                  timedMetadata<\/td>
                                                                                  time: number, 
                                                                                  duration: number, 
                                                                                  name: string, 
                                                                                  content: string, 
                                                                                  type: number, 
                                                                                  metadata: object,<\/p>
                                                                                  id: string <\/span><\/p><\/td>
                                                                                  		– Supported UVE version 0.8 and above. 
                                                                                  – fired when a subscribed tag is found in 
                                                                                  the playlist.<\/td><\/tr>
                                                                                  bitrateChanged <\/td>time: number, 
                                                                                  bitRate: number, 
                                                                                  description: string, 
                                                                                  width: number, 
                                                                                  height: number, 
                                                                                  framerate: number 
                                                                                  position: number 
                                                                                  cappedProfile:bool 
                                                                                  displayWidth:number 
                                                                                  displayHeight:number  <\/td>                                                                                  		– Supported UVE version 0.7 and above. 
                                                                                  – fired when video profile is switched by 
                                                                                  ABR with the metadata associated with 
                                                                                  newly selected profile.<\/td><\/tr>
                                                                                  adResolved <\/td>resolvedStatus: bool, 
                                                                                  placementId: string, 
                                                                                  placementStartTime: 
                                                                                  number, 
                                                                                  placementDuration: 
                                                                                  number  <\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – Confirmation that an upcoming ad’s main 
                                                                                  manifest has been successfully 
                                                                                  downloaded and parsed.<\/td><\/tr>
                                                                                  reservationStart <\/td>adbreakId: string, 
                                                                                  time: number <\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – Sent upon playback into an ad break (one 
                                                                                  or more ads).<\/td><\/tr>
                                                                                  reservationEnd<\/td>adbreakId: string, 
                                                                                  time: number<\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – Sent upon completion of an ad break 
                                                                                  (back to main content) – it is NOT sent 
                                                                                  (per previously agreed contract) if user 
                                                                                  does trickplay or seek to abort ad 
                                                                                  playback.<\/td><\/tr>
                                                                                  placementStart<\/td>adId: string, 
                                                                                  time: number<\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – This is sent in real time when injecting 
                                                                                  first frame of a new ad on content->ad or 
                                                                                  ad->ad transition. Should be accurate 
                                                                                  compared to onscreen frames.<\/td><\/tr>
                                                                                  placementEnd<\/td>adId: string, 
                                                                                  time: number <\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – This is sent in real time after passively 
                                                                                  playing to end of an ad – it is NOT sent (per 
                                                                                  previously agreed contract) if user does 
                                                                                  trickplay or seek to abort ad playback. <\/td><\/tr>
                                                                                  placementProgress <\/td>adId: string,
                                                                                  time: number <\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – Sent periodically while ad is being played 
                                                                                  out, giving an estimate percentagewatched metric. It’s interpolated based on 
                                                                                  elapsed time, and should repeat same 
                                                                                  value if paused.<\/td><\/tr>
                                                                                  placementError<\/td>adId: string, 
                                                                                  time: number, 
                                                                                  error: number  <\/td>                                                                                  		– Supported UVE version 0.8 and above.
                                                                                  – Generated only for exception while 
                                                                                  attempting to play out ad content.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  addEventListener( name, handler )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                   <\/colgroup>
                                                                                  Name<\/th>Type <\/th>Description<\/th><\/tr>
                                                                                  name <\/td>String<\/td>Event Name<\/td><\/tr>
                                                                                  handler<\/td>Function<\/td>Callback for processing event.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  removeEventListener( name, handler )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                   <\/colgroup>
                                                                                  Name<\/th>Type <\/th>Description<\/th><\/tr>
                                                                                  Name<\/td>String <\/td>Event Name<\/td><\/tr>
                                                                                  handler <\/td>Function <\/td>Callback for processing event.<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n

                                                                                  <\/p>

                                                                                  <\/p>
                                                                                  CDAI Mechanism#1 – Engine Managed CDAI  <\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  Supported for DASH Linear, working with period structure and SCTE35 markers, with optional replacement 
                                                                                  for like-amount of content. <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  setSubscribedTags( tagNames )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                  \n
                                                                                  \n
                                                                                  \n
                                                                                  • Supported UVE version 0.8 and above.<\/li>
                                                                                  • Subscribe to specific tags \/ metadata in manifest.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                    \n
                                                                                    \n
                                                                                    \n
                                                                                     <\/colgroup>
                                                                                    Name <\/th>Type<\/th>Description<\/th><\/tr>
                                                                                    tagNames <\/td>String Array <\/td>List of tag names of interest.
                                                                                    Examples:
                                                                                    #EXT-X-IDENTITY-ADS 
                                                                                    #EXT-X-MESSAGE-REF 
                                                                                    #EXT-X-CUE 
                                                                                    #EXT-X-ASSET-ID 
                                                                                    #EXT-X-TRICKMODE-RESTRICTION 
                                                                                    #EXT-X-CONTENT-IDENTIFIER <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                    \n
                                                                                    \n
                                                                                    \n
                                                                                    setAlternateContent( reservationObject, promiseCallback )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                    \n
                                                                                    \n
                                                                                    \n
                                                                                    •  Supported UVE version 0.8 and above.  <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                      \n
                                                                                      \n
                                                                                      \n
                                                                                       <\/colgroup>
                                                                                      Name <\/th>Type<\/th>Description <\/th><\/tr>
                                                                                      reservationObject <\/td>Object<\/td>
                                                                                      reservationObject provides context for alternate content to be played out at ad 
                                                                                      opportunities. <\/p>
                                                                                      \n
                                                                                      { \n \"reservationId\": \"1234\", \/\/ period id from DASH manifest \n \"reservationBehavior\": number, \n \"placementRequest\": \n { \n \/\/ uuid generated to identify this placement \n \"id\": string, \n \/\/ position at which placement will begin playback on the main timeline \n \"pts\": number, \n \"url\": \"\", \n }, \n}<\/pre>\n<\/div><\/div><\/div><\/td><\/tr>
                                                                                      promiseCallback<\/td>Function<\/td>Signals success\/failure while retrieving ad manifest and preparing for 
                                                                                      playback. <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                      \n
                                                                                      \n
                                                                                      \n
                                                                                      notifyReservationCompletion( reservationId, time )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                      \n
                                                                                      \n
                                                                                      \n
                                                                                      • Supported UVE version 0.8 and above.<\/li>
                                                                                      • Notify video engine when all ad placements for a particular reservation have been set via setAlternateContent.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                        \n
                                                                                        \n
                                                                                        \n
                                                                                         <\/colgroup>
                                                                                        Name <\/th>Type <\/th>Description <\/th><\/tr>
                                                                                        reservationId <\/td>String<\/td>Period ID of reservation of Ad placed.<\/span><\/td><\/tr>
                                                                                        Time<\/td>Number<\/td>Time of Ad reservation done.<\/span><\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                        \n
                                                                                        \n
                                                                                        \n

                                                                                        <\/p>

                                                                                        <\/p>
                                                                                        CDAI Mechanism#2 – “Player Prebuffering” Feature <\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                        \n
                                                                                        \n
                                                                                        \n
                                                                                        Can be leveraged for quick stream transitions. Suitable for preroll, and midroll insertions. No limitations 
                                                                                        with respect to content type – can transition between DASH and HLS. <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                        \n
                                                                                        \n
                                                                                        \n
                                                                                        detach()<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                        \n
                                                                                        \n
                                                                                        \n
                                                                                        • Supported UVE version 0.9 and above.<\/li>
                                                                                        • Optional API that can be used to quickly stop playback of active stream before transitioning to 2nd prebuffered stream. <\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          Example use of detach and buffering:<\/p>
                                                                                          \n
                                                                                          var player = new AAMPMediaPlayer(); \nplayer.load( “http:\/\/test.com\/content.m3u8” ); \/\/ begin streaming main content \n… \nvar adPlayer = new AAMPMediaPlayer(); \/\/ create background player \nadPlayer.load( “http:\/\/test.com\/ad.m3u8”, false ); \/\/ preroll \n… \nplayer.detach(); \/\/ stop playback of active player \nadPlayer.play(); \/\/ activate background player (fast transition) \nplayer.stop(); \/\/ release remaining resources for initial player instance<\/pre>\n<\/div><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          Example of midroll Ad insertions and resume main content playback:<\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          Main content 
                                                                                          (0 – 180 Sec)  <\/th>                                                                                          		AD1 
                                                                                          (0 -40 Sec) <\/th>                                                                                          		AD2 
                                                                                           (0 – 30 Sec) <\/th>                                                                                          		Main Content 
                                                                                          (180 – 600 Sec)  <\/th><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          Main Content 
                                                                                          (0 – 180 sec)  <\/td>                                                                                          		create foreground player and start streaming of main content <\/strong>
                                                                                          var player = new AAMPMediaPlayer(); 
                                                                                          player.load( “http:\/\/test.com\/content.mpd<\/a>” ); 
                                                                                          create background player and preload AD1 <\/strong>
                                                                                          var adPlayer1 = new AAMPMediaPlayer(); 
                                                                                          adPlayer1.load( “                                                                                          http:\/\/test.com\/ad1.mpd<\/a>”, false ); <\/td><\/tr>
                                                                                          AD1 
                                                                                          (0 – 40 sec)  <\/td>                                                                                          		time of AD1 start, stop active player and activate background player for AD1 <\/strong>
                                                                                          var position = Player. getCurrentPosition() \/\/ get current playback position 
                                                                                          player.detach(); 
                                                                                          adPlayer1.play(); 
                                                                                          player.stop(); 
                                                                                          preload AD2 in background player <\/strong>
                                                                                          var adPlayer2 = new AAMPMediaPlayer(); 
                                                                                          adPlayer2.load( “http:\/\/test.com\/ad2.mpd<\/a>”, false );  <\/td><\/tr>
                                                                                          AD2 
                                                                                          (0 – 30 sec) <\/td>                                                                                          		EOS of AD1, stop active player and activate background player for AD2<\/strong>
                                                                                          adPlayer1.detach(); 
                                                                                          adPlayer2.play(); 
                                                                                          adPlayer1.stop(); 
                                                                                          preload Main content in background and set last playback position <\/strong>
                                                                                          var player = new AAMPMediaPlayer(); 
                                                                                          player. Seek (position) 
                                                                                          player.load( “http:\/\/test.com\/content.mpd<\/a>”, false ); <\/td><\/tr>
                                                                                          Main Content 
                                                                                          (180 – 600 sec)  <\/td>                                                                                          		EOS of AD2, stop active player and activate background player for main content <\/strong>
                                                                                          adPlayer2.detach(); 
                                                                                          player.play(); 
                                                                                          adPlayer2.stop(); <\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n

                                                                                          <\/p>

                                                                                          <\/p>
                                                                                          Configuration<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          initConfig( config )<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          Configuration options are passed to AAMP using the UVE initConfig method. This allows the application override 
                                                                                          default configuration used by AAMP player to give more control over player behavior. Parameter is a JSON Object with 
                                                                                          one or more attribute\/value pairs as follows:  <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          Property <\/th>Type <\/th>Default 
                                                                                          Value<\/th>                                                                                          		Description<\/th><\/tr>
                                                                                          initialBitrate <\/td>Number<\/td>2500000 <\/td>max initial bitrate (bps)<\/td><\/tr>
                                                                                          initialBitrate4K <\/td>
                                                                                          Number<\/p><\/td>
                                                                                          13000000<\/p><\/td>
                                                                                          		max initial bitrate for 4k video playback (bps) <\/td><\/tr>
                                                                                          Offset<\/td>Number (s) <\/td>0<\/td>start position offset in seconds(same as seek() method) <\/td><\/tr>
                                                                                          networkTimeout<\/td>Number (s)<\/td>10 <\/td>network request timeout for fragment\/playlist\/manifest 
                                                                                          downloads (in seconds) <\/td><\/tr>
                                                                                          manifestTimeout <\/td>Number (s) <\/td>10<\/td>Manifest download timeout; overrides networkTimeout if both present; available starting with version 0.8 . Applied to Main manifest in HLS and DASH manifest download. (in seconds) <\/td><\/tr>
                                                                                          playlistTimeout<\/td>playlistTimeout<\/td>10 <\/td>HLS playlist download timeout; overrides networkTimeout if 
                                                                                          both present; available starting with version 1.0 (in seconds) <\/td><\/tr>
                                                                                          downloadBuffer<\/td>Number <\/td>4<\/td>max amount of time to download ahead of playhead 
                                                                                          (fragments) 
                                                                                          example: 
                                                                                          – with a downloadBuffer of 4 (default) there will be 4 
                                                                                          fragments (typically 2s each) of video or audio harvested and 
                                                                                          buffered in advance, in additional to internal playback 
                                                                                          buffering <\/td><\/tr>
                                                                                          minBitrate <\/td>Number<\/td>– <\/td>Optional profile clamping (in bps) <\/td><\/tr>
                                                                                          maxBitrate<\/td>Number <\/td>–<\/td>Optional profile clamping (in bps) <\/td><\/tr>
                                                                                          preferredAudioLanguage <\/td>String <\/td>en<\/td>
                                                                                          ISO-639 audio language preference; for more than one language, provide comma delimited list from highest to lowest priority: ‘<HIGHEST>,<…>,<LOWEST>’ <\/span><\/p><\/td><\/tr>
                                                                                          timeShiftBufferLength<\/td>Number<\/td>–<\/td>(not supported, for future) <\/td><\/tr>
                                                                                          stereoOnly <\/td>Boolean <\/td>False <\/td>Optional forcing of playback to only select stereo audio track 
                                                                                          available starting with version 0.8 <\/td><\/tr>
                                                                                          liveOffset<\/td>Number (s) <\/td>15<\/td>Allows override default\/stream-defined distance from live 
                                                                                          point for live stream playback (in seconds)<\/td><\/tr>
                                                                                          bulkTimedMetadata<\/td>Boolean<\/td>False<\/td>Send timed metadata using single stringified JSON array 
                                                                                          instead of individual events available starting with version 0.8<\/td><\/tr>
                                                                                          networkProxy<\/td>String<\/td>–<\/td>
                                                                                          Network proxy to use (Format <SCHEME>:\/\/<PROXY<\/p>
                                                                                          IP:PROXY PORT>) <\/p><\/td><\/tr>
                                                                                          licenseProxy<\/td>String<\/td>– <\/td>Network proxy to use for license requests (Format same as 
                                                                                          network proxy)<\/td><\/tr>
                                                                                          downloadStallTimeout<\/td>Number (s) <\/td>–<\/td>Optional optimization – Allow fast-failure for class of curl-detectable mid-download stalls (in seconds)<\/td><\/tr>
                                                                                          downloadStartTimeout<\/td>Number (s) <\/td>–<\/td>Optional optimization – Allow fast-failure for class of curl-detectable stall at start of download (in seconds)<\/td><\/tr>
                                                                                          preferredSubtitleLanguage <\/td>String <\/td>en<\/td>ISO-639 language code used with VTT OOB captions<\/td><\/tr>
                                                                                          parallelPlaylistDownload<\/td>Boolean<\/td>True<\/td>Optional optimization – download audio and video playlists in 
                                                                                          parallel for HLS; available starting with version 0.8<\/td><\/tr>
                                                                                          parallelPlaylistRefresh <\/td>Boolean <\/td>True<\/td>Optionally disable audio video playlist parallel download for 
                                                                                          linear (only for HLS)<\/td><\/tr>
                                                                                          useAverageBandwidth <\/td>Boolean<\/td>False<\/td>Optional Average bandwidth for ABR switching ( version 1.0) <\/td><\/tr>
                                                                                          preCachePlaylistTime<\/td>Number (s) <\/td>– <\/td>Optionally enable PreCaching of Playlist and TimeWindow for 
                                                                                          Cache(minutes) ( version 1.0) <\/td><\/tr>
                                                                                          progressReportingInterval <\/td>Number (s)<\/td>1 <\/td>Optionally change Progress Report Interval (in seconds)<\/td><\/tr>
                                                                                          useRetuneForUnpairedDiscont
                                                                                          inuity<\/td>                                                                                          		Boolean<\/td>True <\/td>Optional unpaired discontinuity retune config ( version 1.0)<\/td><\/tr>
                                                                                          drmDecryptFailThreshold<\/td>Number<\/td>–<\/td>Optional pre-tune buffering (in seconds) before playback start 
                                                                                          (version 2.4)<\/td><\/tr>
                                                                                          useMatchingBaseUrl <\/td>Boolean<\/td>False<\/td>use DASH main manifest hostname to select from multiple 
                                                                                          base urls in DASH (when present). By default, will always 
                                                                                          choose first (version 2.4) <\/td><\/tr>
                                                                                          initFragmentRetryCount<\/td>Number <\/td>1 <\/td>Maximum number of retries for MP4 header fragment <\/td><\/tr>
                                                                                          nativeCCRendering <\/td>Boolean<\/td>False <\/td>Use native ClosedCaption support in AAMP (version 2.6)<\/td><\/tr>
                                                                                          langCodePreference<\/td>Number<\/td>0 <\/td>Set the preferred format for language codes in other 
                                                                                          events\/APIs (version 2.6) 
                                                                                          NO_LANGCODE_PREFERENCE = 0, 
                                                                                          3_CHAR_BIBLIOGRAPHIC_LANGCODE = 1, 
                                                                                          3_CHAR_TERMINOLOGY_LANGCODE = 2, 
                                                                                          2_CHAR_LANGCODE = 3<\/td><\/tr>
                                                                                          descriptiveTrackName<\/td>Boolean <\/td>False <\/td>Use descriptive audio track naming format which is a combination of – (version 2.6) <\/td><\/tr>
                                                                                          authToken<\/td>String<\/td>–<\/td>Optional field to set AuthService token for license 
                                                                                          acquisition (version 2.7) <\/td><\/tr>
                                                                                          useRetuneForGstInternalError <\/td>Boolean<\/td>True <\/td>Optional field to disable propagating URI parameters from 
                                                                                          Main manifest to segment downloads  <\/td><\/tr>
                                                                                          reportVideoPTS<\/td>Boolean<\/td>False<\/td>Optional field to enable Video PTS reporting along with 
                                                                                          progressReport (version 3.0)<\/td><\/tr>
                                                                                          propagateUriParameters <\/td>Boolean<\/td>True <\/td>Optional field to disable propagating URI parameters from 
                                                                                          Main manifest to segment downloads  <\/td><\/tr>
                                                                                          enableSeekableRange<\/td>Boolean <\/td>False<\/td>Optional field to enable reporting of seekable range for linear 
                                                                                          scrubbing<\/td><\/tr>
                                                                                          maxPlaylistCacheSize<\/td>Number <\/td>0 <\/td>Optional field to configure maximum cache size in Kbytes to 
                                                                                          store different profile HLS VOD playlist<\/td><\/tr>
                                                                                          setLicenseCaching <\/td>Boolean<\/td>True<\/td>Optional field to disable License Caching in player. By default 
                                                                                          3 DRM Sessions are Cached<\/td><\/tr>
                                                                                          persistBitrateOverSeek<\/td>Boolean<\/td>False<\/td>To enable AAMP persisting video profile during 
                                                                                          Seek\/Trickplay\/Audio switching operation<\/td><\/tr>
                                                                                          sslVerifyPeer<\/td>Boolean <\/td>False<\/td>Optional field to enable SSL peer verification <\/td><\/tr>
                                                                                          livePauseBehavior <\/td>Number<\/td>0<\/td>Optional field to configure player live pause behavior on linear 
                                                                                          streams when live window touches eldest position. 
                                                                                          Options: 
                                                                                          0 – Autoplay immediate 
                                                                                          1 – Live immediate 
                                                                                          2 – Autoplay defer 
                                                                                          3 – Live defer 
                                                                                          Default – Autoplay immediate <\/td><\/tr>
                                                                                          limitResolution<\/td>Boolean<\/td>False<\/td>Optional field to set maximum video profile resolution based 
                                                                                          on TV display resolution setting . Default Off.<\/td><\/tr>
                                                                                          asyncTune <\/td>Boolean<\/td>False <\/td>Optional field to enable asynchronous player API processing. 
                                                                                          Application \/ UI caller threads returned immediately without 
                                                                                          any processing delays. <\/td><\/tr>
                                                                                          useAbsoluteTimeline<\/td>Boolean<\/td>False<\/td>Optional field to enable progress reporting based on 
                                                                                          Availability Start Time of stream (DASH Only)<\/td><\/tr>
                                                                                          sharedSSL<\/td>Boolean<\/td>True<\/td>Optional field to disable sharing SSL context for all download 
                                                                                          sessions, across manifest, playlist and segments. <\/td><\/tr>
                                                                                          disable4K<\/td>Boolean<\/td>False<\/td>Optional field to disable 4K profile playback and restrict only 
                                                                                          to non-4k video profiles.<\/td><\/tr>
                                                                                          preferredAudioRendition<\/td>String<\/td>
                                                                                          <\/td>                                                                                          		Optional field to set preferred Audio rendition setting 
                                                                                          DASH : caption,subtitle,main 
                                                                                          HLS : GROUP-ID  <\/td><\/tr>
                                                                                          preferredAudioCodec <\/td>String <\/td>
                                                                                          <\/td>                                                                                          		Optional field to set preferred Audio Codec 
                                                                                          Comma-delimited list of formats, where each format specifies a 
                                                                                          media sample type that is present in one or more Renditions 
                                                                                          specified by the Variant Stream. 
                                                                                          e.g: mp4a.40.2,avc1.4d401e<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          setDRMConfig( config ) <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          DRM configuration options are passed to AAMP using the setDRMConfig method. Parameter is JSON object with pairs of 
                                                                                          protectionScheme: licenseServerUrl pairs, along with preferredKeySystem specifying a preferred protectionScheme.<\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          Property<\/th>Type<\/th>Description<\/th><\/tr>
                                                                                          com.microsoft.playready<\/td>String<\/td>License server endpoint to use with PlayReady DRM. 
                                                                                          Example: 
                                                                                          http:\/\/test.playready.microsoft.com\/service\/rightsmanager.asmx<\/a><\/td><\/tr>
                                                                                          com.widevine.alpha<\/td>String<\/td>License server endpoint to use with Widevine DRM.
                                                                                          Example: https:\/\/widevine-proxy.appspot.com\/proxy<\/td><\/tr>
                                                                                          preferredKeysystem <\/td>String<\/td>Used to disambiguate which DRM type to use, when manifest advertises 
                                                                                          multiple supported DRM systems. 
                                                                                          Example: com.widevine.alpha<\/td><\/tr><\/tbody><\/table> <\/div>

                                                                                          <\/p>

                                                                                          <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n

                                                                                          <\/p>

                                                                                          <\/p>
                                                                                          Universal Video Engine Player Errors<\/h3><\/div>

                                                                                          <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          Error code<\/th>Code <\/th>Error String<\/th><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED<\/td>10<\/td>AAMP: init failed <\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_MANIFEST_DNLD_ERROR <\/td>10<\/td>AAMP: init failed (unable to download manifest) <\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_MANIFEST_CONTENT_ERROR<\/td>10<\/td>AAMP: init failed (manifest missing tracks)<\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_MANIFEST_PARSE_ERROR <\/td>10<\/td>AAMP: init failed (corrupt\/invalid manifest)<\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_TRACK_SYNC_ERROR <\/td>10<\/td>AAMP: init failed (unsynchronized tracks) <\/td><\/tr>
                                                                                          AAMP_TUNE_MANIFEST_REQ_FAILED <\/td>10<\/td>AAMP: Manifest Download failed 
                                                                                          Playlist refresh failed<\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_PLAYLIST_VIDEO_DNLD_ERR
                                                                                          OR<\/td>                                                                                          		10 <\/td>AAMP: init failed (unable to download video playlist)<\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FAILED_PLAYLIST_AUDIO_DNLD_ERR
                                                                                          OR<\/td>                                                                                          		10<\/td>AAMP: init failed (unable to download audio playlist)<\/td><\/tr>
                                                                                          AAMP_TUNE_FRAGMENT_DOWNLOAD_FAILURE <\/td>10 <\/td>AAMP: fragment download failures<\/td><\/tr>
                                                                                          AAMP_TUNE_INIT_FRAGMENT_DOWNLOAD_FAILURE<\/td>10<\/td>AAMP: init fragment download failed<\/td><\/tr>
                                                                                          AAMP_TUNE_INVALID_MANIFEST_FAILURE<\/td>10 <\/td>AAMP: Invalid Manifest, parse failed  <\/td><\/tr>
                                                                                          AAMP_TUNE_MP4_INIT_FRAGMENT_MISSING <\/td>10<\/td>AAMP: init fragments missing in playlist<\/td><\/tr>
                                                                                          AAMP_TUNE_CONTENT_NOT_FOUND<\/td>20 <\/td>AAMP: Resource was not found at the URL(HTTP 404)  <\/td><\/tr>
                                                                                          AAMP_TUNE_AUTHORISATION_FAILURE <\/td>40<\/td>AAMP: Authorization failure <\/td><\/tr>
                                                                                          AAMP_TUNE_UNTRACKED_DRM_ERROR<\/td>50<\/td>AAMP: DRM error untracked error<\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_INIT_FAILED <\/td>50 <\/td>AAMP: DRM Initialization Failed <\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_DATA_BIND_FAILED<\/td>50 <\/td>AAMP: InitData-DRM Binding Failed<\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_SESSIONID_EMPTY<\/td>50 <\/td>AAMP: DRM Session ID Empty<\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_CHALLENGE_FAILED<\/td>50<\/td>AAMP: DRM License Challenge Generation Failed<\/td><\/tr>
                                                                                          AAMP_TUNE_LICENCE_TIMEOUT <\/td>50 <\/td>AAMP: DRM License Request Timed out<\/td><\/tr>
                                                                                          AAMP_TUNE_LICENCE_REQUEST_FAILED <\/td>50 <\/td>AAMP: DRM License Request Failed<\/td><\/tr>
                                                                                          AAMP_TUNE_INVALID_DRM_KEY <\/td>50<\/td>AAMP: Invalid Key Error, from DRM<\/td><\/tr>
                                                                                          AAMP_TUNE_UNSUPPORTED_STREAM_TYPE<\/td>50<\/td>AAMP: Unsupported Stream Type 
                                                                                          Unable to determine stream type for DRM Init <\/td><\/tr>
                                                                                          AAMP_TUNE_UNSUPPORTED_AUDIO_TYPE<\/td>50 <\/td>AAMP: No supported Audio Types in Manifest <\/td><\/tr>
                                                                                          AAMP_TUNE_FAILED_TO_GET_KEYID<\/td>50 <\/td>AAMP: Failed to parse key id from PSSH<\/td><\/tr>
                                                                                          AAMP_TUNE_FAILED_TO_GET_ACCESS_TOKEN<\/td>50<\/td>AAMP: Failed to get access token from Auth Service<\/td><\/tr>
                                                                                          AAMP_TUNE_CORRUPT_DRM_METADATA <\/td>50<\/td>AAMP: DRM failure due to Bad DRMMetadata in 
                                                                                          stream <\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_DECRYPT_FAILED<\/td>50<\/td>AAMP: DRM Decryption Failed for Fragments<\/td><\/tr>
                                                                                          AAMP_TUNE_DRM_KEY_UPDATE_FAILED<\/td>50 <\/td>AAMP: Failed to process DRM key<\/td><\/tr>
                                                                                          AAMP_TUNE_CORRUPT_DRM_DATA <\/td>51<\/td>AAMP: DRM failure due to Corrupt DRM files <\/td><\/tr>
                                                                                          AAMP_TUNE_DEVICE_NOT_PROVISIONED<\/td>52 <\/td>AAMP: Device not provisioned<\/td><\/tr>
                                                                                          AAMP_TUNE_HDCP_COMPLIANCE_ERROR<\/td>53<\/td>AAMP: HDCP Compliance Check Failure<\/td><\/tr>
                                                                                          AAMP_TUNE_GST_PIPELINE_ERROR<\/td>80<\/td>AAMP: Error from gstreamer pipeline<\/td><\/tr>
                                                                                          AAMP_TUNE_FAILED_PTS_ERROR<\/td>80<\/td>AAMP: Playback failed due to PTS error<\/td><\/tr>
                                                                                          AAMP_TUNE_PLAYBACK_STALLED<\/td>7600<\/td>AAMP: Playback was stalled due to lack of new 
                                                                                          fragments <\/td><\/tr>
                                                                                          AAMP_TUNE_FAILURE_UNKNOWN <\/td>100 <\/td>AAMP: Unknown Failure<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n

                                                                                          <\/p>

                                                                                          <\/p>
                                                                                          Inband Closed Caption Management<\/h3><\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          To use inband closed captions, first register an event listener to discover decoder handle: <\/p>
                                                                                          \n
                                                                                          player.addEventListener(\"decoderAvailable\", decoderHandleAvailable);<\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Along with corresponding event handler to publish the decoder handle to CC subsystem as follows:<\/p>
                                                                                          \n
                                                                                          function decoderHandleAvailable(event) { \nconsole.log(\"decoderHandleAvailable \" + event.decoderHandle); \nXREReceiver.onEvent(\"onDecoderAvailable\", { decoderHandle: event.decoderHandle }); \n}<\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Toggle CC display on or off at runtime:<\/span><\/p>
                                                                                          \n
                                                                                          XREReceiver.onEvent(\"onClosedCaptions\", { enable: true }); \nXREReceiver.onEvent(\"onClosedCaptions\", { enable: false }); <\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Set CC track at runtime:<\/p>
                                                                                          \n
                                                                                          XREReceiver.onEvent(\"onClosedCaptions\", { setTrack: trackID });<\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Set CC style options at runtime: <\/p>
                                                                                          \n
                                                                                          XREReceiver.onEvent(\"onClosedCaptions\", { setOptions: defaultCCOptions}); <\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          defaultCCOptions is a JSON object of various style options and its values.<\/p>
                                                                                          When closing stream, detach decoder handle: <\/p>
                                                                                          \n
                                                                                          XREReceiver.onEvent(\"onDecoderAvailable\", { decoderHandle: null }); <\/pre>\n<\/div><\/div>
                                                                                          Environments without the XREReceiver JS object may exist in future. Applications may use alternate CC rendering methods to 
                                                                                          avoid dependency on XREReceiver object. <\/p>
                                                                                          To use, turn on nativeCCRendering init configuration value to true as follows:<\/p>
                                                                                          \n
                                                                                          player.initConfig( { nativeCCRendering: true } ); <\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Toggle CC display on or off at runtime:<\/p>
                                                                                          \n
                                                                                          player.setClosedCaptionStatus(true); \nplayer.setClosedCaptionStatus(false); <\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Get\/Set CC track at runtime:  <\/p>
                                                                                          \n
                                                                                          player.getTextTrack();\nplayer.setTextTrack(trackIndex);  <\/pre>\n<\/div><\/div>

                                                                                          <\/p>
                                                                                          Get\/Set CC style options at runtime:<\/p>
                                                                                          \n
                                                                                          player.getTextStyleOptions(); \nplayer.setTextStyleOptions(options); <\/pre>\n<\/div><\/div>
                                                                                          options in a JSON formatted string of style options and its values.<\/span><\/p>

                                                                                          <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n

                                                                                          <\/p>
                                                                                          ATSC – Unified Video Engine Features<\/h2>

                                                                                          <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          Support for ATSC-UVE is included from 3.0 version. 
                                                                                          A subset of UVE APIs and Events are available when using UVE JS APIs for ATSC playback.  <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          API Methods<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                           <\/colgroup>
                                                                                          APIs Supported<\/th>Description<\/th><\/tr>
                                                                                          load <\/td>
                                                                                          URI of the Media to be played by the Video Engine. Optional 2nd
                                                                                          parameter. <\/p>
                                                                                          Examples for new URLs Supported:<\/p>live:\/\/\/75 – ATSC Channel 
                                                                                          hdmiin:\/\/localhost\/deviceid\/0 – HDMI Input 
                                                                                          cvbsin:\/\/localhost\/deviceid\/0 – Composite Input 
                                                                                          tune:\/\/atsc?frequency=5700000&serviceid=3 – Direct tune to ATSC Channel<\/td><\/tr>
                                                                                          play <\/td>Start Playback \/ Resume playback.<\/td><\/tr>
                                                                                          stop <\/td>Stop playback and free resources.  <\/td><\/tr>
                                                                                          getAudioTrack <\/td>Get the index of the currently selected Audio track.<\/td><\/tr>
                                                                                          setAudioTrack<\/td>Set the index of the Audio track to be selected.  <\/td><\/tr>
                                                                                          setAudioTrack<\/td>
                                                                                          Set the Audio track to be selected by Language and Rendition.
                                                                                          JSON formatted argument. 
                                                                                          • language <\/li>
                                                                                          • rendition  <\/li><\/ul>
                                                                                            Example: <\/p>
                                                                                            \n
                                                                                            {\"language\":\"ger\",\"rendition\":\"commentary\"}<\/pre>\n<\/div><\/div><\/div><\/td><\/tr>
                                                                                          setAudioLanguage<\/td>Set the language of the Audio track to be selected.<\/td><\/tr>
                                                                                          setVideoRect <\/td>Set display video rectangle coordinates. Default configuration 
                                                                                          (0,0,1280,720)  <\/td><\/tr>
                                                                                          getAvailableAudioTracks<\/td>
                                                                                          Returns the available audio tracks information in 
                                                                                          JSON formatted list. Subset of parameters returned 
                                                                                          • name <\/li>
                                                                                          • language <\/li>
                                                                                          • codec  <\/li><\/ul>
                                                                                            Example: <\/p>
                                                                                            \n
                                                                                            {\"name\": \"English (AC3)\",\"language\":\"eng\",\"codec\":\"AC3\"}  <\/pre>\n<\/div><\/div><\/div><\/td><\/tr>
                                                                                          setClosedCaptionStatus<\/td>Set the Closed Caption rendering to on\/off.  <\/td><\/tr>
                                                                                          getAvailableTextTracks <\/td>
                                                                                          Returns the available text track (CC) information in 
                                                                                          JSON formatted list. 
                                                                                          Subset of parameters returned 
                                                                                          • name <\/li>
                                                                                          • type <\/li>
                                                                                          • language <\/li>
                                                                                          • instreamId  <\/li><\/ul>
                                                                                            Example: <\/p>
                                                                                            \n
                                                                                            [{\"name\":\"English (Closed Caption)\",\"type\":\"CLOSED-CAPTIONS\",\"language\": \n\"eng\",”instreamId\":\"CC1\"}, \n {\"name\":\"Spanish (Closed Caption)\",\"type\":\"CLOSED-CAPTIONS\",\"language\": \n\"spa\",\"instreamId\":\"CC2\"}, \n {\"name\":\"English (Closed Caption)\",\"type\":\"CLOSED-CAPTIONS\",\"language\": \n\"eng\",\"instreamId\":\"SERVICE1\"}, \n {\"name\":\"Spanish (Closed Caption)\",\"type\":\"CLOSED-CAPTIONS\",\"language\": \n\"spa\",\"instreamId\":\"SERVICE2\"}] <\/pre>\n<\/div><\/div><\/div><\/td><\/tr>
                                                                                          getTextTrack<\/td>Get the Index of the currently selected Text track.<\/td><\/tr>
                                                                                          setTextTrack <\/td>Set the Index of the Text track to be selected.<\/td><\/tr>
                                                                                          getTextStyleOptions<\/td>Returns the JSON formatted string of current ClosedCaption style 
                                                                                          options and values.<\/td><\/tr>
                                                                                          setTextStyleOptions<\/td>Set the ClosedCaption style options to be used for rendering.  <\/td><\/tr><\/tbody><\/table> <\/div>

                                                                                          <\/p>

                                                                                          <\/p><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          New Set of APIs added for ATSC Parental Control Settings  <\/h3>
                                                                                          disableContentRestrictions (until)  <\/span><\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                          \n
                                                                                          \n
                                                                                          \n
                                                                                          • Temporarily disable content restriction based on the control input provided by the ‘until’ parameter.<\/li>
                                                                                          • Can be used for unlocking a locked channel (Channel locked due to Restrictions set)<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                            \n
                                                                                            \n
                                                                                            \n
                                                                                             <\/colgroup>
                                                                                            Name <\/th>Type<\/th>Description <\/th><\/tr>
                                                                                            until<\/p>
                                                                                            \n
                                                                                            {\"time\": < seconds>} <\/pre>\n<\/div><\/div>
                                                                                            Or <\/p>
                                                                                            \n
                                                                                            {\"programChange\":true};<\/pre>\n<\/div><\/div><\/div><\/td>
                                                                                            		Json Object<\/td>Provides control for automatic re-locking conditions.
                                                                                            • If ‘time’ is set, the seconds will be considered as relative to current time until which the program will be unlocked. <\/li>
                                                                                            • If ‘programChange’ is set, the program will be unlocked, but re-enable restriction handling on next program boundary. <\/li>
                                                                                            • If neither specified, parental control locking will be disabled until set-top reboot, or explicit call to enableContentRestrictions(). <\/li>
                                                                                            • If both specified, parental control locking will be re-enabled depending on which condition occurs first.<\/li><\/ul><\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                              \n
                                                                                              \n
                                                                                              \n
                                                                                              enableContentRestrictions ()  <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                              \n
                                                                                              \n
                                                                                              \n
                                                                                              •  To re-enable parental control locks based on restrictions.<\/li><\/ul><\/div>\n<\/div>\n<\/div>\n
                                                                                                \n
                                                                                                \n
                                                                                                \n
                                                                                                Events Supported <\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                                \n
                                                                                                \n
                                                                                                \n
                                                                                                 <\/colgroup>
                                                                                                Events Supported<\/th>Value<\/th>Description<\/th><\/tr>
                                                                                                playbackStarted <\/td>1 <\/td>Tune Success [OTA , HDMIIN,COMPOSITE IN] <\/td><\/tr>
                                                                                                playbackStateChanged<\/td>14 <\/td>
                                                                                                Event when player state changes. 
                                                                                                Valid AAMP States for ATSC OTA Playback: 
                                                                                                : “idle”:0, “initializing”:1, “initialized”:2, “preparing”:3, “prepared”:4, 
                                                                                                “playing”:8, “blocked”:14
                                                                                                Valid AAMP States for HDMIIN : <\/p>

                                                                                                <\/p>
                                                                                                \n
                                                                                                \"playing\":8,“stopped”:10<\/pre>\n<\/div><\/div><\/div><\/td><\/tr>
                                                                                                blocked <\/td>38<\/td>
                                                                                                Blocked event is generated when player status switches to 
                                                                                                eSTATE_BLOCKED. 
                                                                                                The Event payload is a string to describe the reason for the 
                                                                                                blocked state. 
                                                                                                Event Payload: 
                                                                                                Type : reason – string 
                                                                                                 Reason for restriction <\/p>
                                                                                                Example: 
                                                                                                “reason”: (ATSC Playback) 
                                                                                                “STATUS|Low or No Signal” 
                                                                                                “Service Pin Locked” 
                                                                                                “STATUS|Unable to decode” 
                                                                                                If a program is Blocked due to Restrictions set by the Application, the 
                                                                                                ‘blocked’ event’s reason will be “Service Pin Locked” 
                                                                                                “reason”: (HDMIIN) 
                                                                                                “NO_SIGNAL” 
                                                                                                “UNSTABLE_SIGNAL” 
                                                                                                “NOT_SUPPORTED_SIGNAL”<\/p><\/td><\/tr>
                                                                                                bitrateChanged <\/td>11 <\/td>
                                                                                                Event notified when bitrate change happens. The event 
                                                                                                payload provides video stream info Will be notified after 
                                                                                                first tuned event for OTA and and after display settings 
                                                                                                change. <\/p>
                                                                                                Event Payload: 
                                                                                                time: number, 
                                                                                                bitRate: number, 
                                                                                                description: string, 
                                                                                                width: number, 
                                                                                                height: number, 
                                                                                                framerate: number, 
                                                                                                position: number(not used), 
                                                                                                cappedProfile:number (not used), 
                                                                                                displayWidth:number (not used), 
                                                                                                displayHeight:number (not used), 
                                                                                                progressive:bool, 
                                                                                                aspectRatioWidth:number, 
                                                                                                aspectRatioHeight:number  <\/p><\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n
                                                                                                \n
                                                                                                \n
                                                                                                \n
                                                                                                InitConfig<\/h3><\/div>\n<\/div>\n<\/div>\n
                                                                                                \n
                                                                                                \n
                                                                                                \n
                                                                                                 <\/colgroup>
                                                                                                Property <\/th>Type<\/th>Default 
                                                                                                Value<\/th>                                                                                                		Description<\/th><\/tr>
                                                                                                preferredAudioLanguage <\/td>String <\/td>en<\/td>
                                                                                                ISO-639 audio language preference; for more than one language, provide comma delimited list from highest to lowest priority:<\/p>
                                                                                                ‘<HIGHEST>,<…>,<LOWEST>’<\/p><\/td><\/tr>
                                                                                                nativeCCRendering <\/td>Boolean <\/td>False <\/td>Use native Closed Caption support in AAMP<\/td><\/tr><\/tbody><\/table> <\/div><\/div>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
                                                                                                Unified Video Engine (UVE) APIs Overview AAMP is an open source native video engine that […]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10015,"menu_order":27,"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-10122","page","type-page","status-publish","hentry"],"yoast_head":"\nAAMP UVE - API - 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_uve_-_api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"AAMP UVE - API - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Unified Video Engine (UVE) APIs Overview AAMP is an open source native video engine that […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:35+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=\"24 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_uve_-_api\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/\",\"name\":\"AAMP UVE - API - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:10:49+00:00\",\"dateModified\":\"2025-03-25T05:18:35+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/#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 Entertainment\",\"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 UVE – API\"}]},{\"@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 UVE - API - 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_uve_-_api\/","og_locale":"en_US","og_type":"article","og_title":"AAMP UVE - API - RDK Documentation Portal | Documentation","og_description":"Unified Video Engine (UVE) APIs Overview AAMP is an open source native video engine that […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:35+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"24 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_uve_-_api\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/","name":"AAMP UVE - API - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:10:49+00:00","dateModified":"2025-03-25T05:18:35+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/advanced_adaptive_media_player_aamp\/aamp_uve_-_api\/#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 Entertainment","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 UVE – API"}]},{"@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\/10122","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=10122"}],"version-history":[{"count":4,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10122\/revisions"}],"predecessor-version":[{"id":11992,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10122\/revisions\/11992"}],"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=10122"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}