Last updated on September 1, 2017.
rmp-vast is a lightweight open-source client-side JavaScript solution to load, parse and display VAST resources. It is maintained by Radiant Media Player team and is offered as an alternative to the Google IMA SDK. The main purpose of rmp-vast is to offer a VAST 3 compliant solution to display video ads in web-based mobile applications for iOS and Android (WebView, Ionic, PhoneGap, Cordova ...) as the Google IMA SDK is not compatible with those environments. rmp-vast can also be used in environments like desktop or mobile browsers.
When delivering Google video ads (DoubleClick for Publishers, AdSense for Video or DoubleClick Ad Exchange) we recommend using the Google IMA SDK with Radiant Media Player whenever possible.
rmp-vast supports the following VAST 3 features:
VAST 2 resources should also be compatible with rmp-vast.
Additional supported features include a mobile friendly UI and autoplay support (muted autoplay on mobiles).
The following VAST/player features are not supported with rmp-vast: Ad Pods, Companion Ads, VPAID, VMAP, Audio ads, ad waterfalling through the
adTagWaterfall setting, ad scheduling, outstream ads. Radiant Media Player supports those features
through the Google IMA SDK.
Browsers:
Specifically we support the latest stable release for each browser.
WebViews:
Player settings for using rmp-vast are very similar to using Google IMA SDK. The only difference resides in specifying the VAST parser which you want to use through the adParser setting.
<!-- Include Radiant Media Player JavaScript file in your <body> or <head> --> <script src="https://cdn.radiantmediatechs.com/rmp/4.4.19/js/rmp.min.js" integrity="sha384-MHxuw6s8n+Uh8xT1LYC0zcidvLkX9DN0otZPYoamhjIU8svCQARWXpRYEXV6o6LI" crossorigin="anonymous"></script> <!-- Set up your wrapper div with its unique id --> <div id="rmpPlayer"></div> <script> // First we specify bitrates to feed to the player // You can use HLS, DASH or progressive download or a combination of those protocols // You can use ads with on-demand, live or DVR content var bitrates = { hls: 'https://dqwp3xzzbfhtw.cloudfront.net/vod/smil:bbb.smil/playlist.m3u8' }; // Then we set our player settings var settings = { licenseKey: 'your-license-key', bitrates: bitrates, delayToFade: 3000, width: 640, height: 360, ads: true, // We tell the player to use rmp-vast to load and parse VAST resources adParser: 'rmp-vast', // We pass our adTag here - the player knows what to do with it adTagUrl: 'https://www.radiantmediaplayer.com/vast/tags/inline-linear-5.xml', poster: 'https://www.radiantmediaplayer.com/images/poster-rmp-showcase.jpg' }; var elementID = 'rmpPlayer'; var rmp = new RadiantMP(elementID); rmp.init(settings); </script>
ads: Boolean
Activate or not ads within the player. Default: false.
adTagUrl: String
Specifies the ad tag url that is requested by the player from the ad server. Default: ''.
You need to use fully qualified URL for your adTagUrl
adParser: String
Specifies which VAST parser the player should use. Possible values are 'rmp-vast' and 'ima'. Default: 'ima'.
adAjaxTimeout: Number
Represents the Ajax timeout in milliseconds for each VAST request (or VAST wrapper). When timeout is reached without a valid server response the VAST loading process is aborted. Default: 8000.
adAjaxWithCredentials: Boolean
AJAX request to load VAST tag from ad server should or should not be made with credentials. Default: true.
adMaxNumRedirects: Number
Specifies the maximum number of redirects before the subsequent redirects will be denied, and the ad load aborted. The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads. Default: 4.
adPauseOnClick: Boolean
When set to true this setting will cause to pause the playing linear ad (or content for a non-linear ad) when the ad is interacted with. Default: true. On some devices the browser may still decide to pause a video asset when a new window opens.
adCountDown: Boolean
A countdwon to be displayed within the player control bar. It shows the remaining time for the video ads. Default: false.
See our documentation about player labels here.
var labels = {
ads: {
controlBarCustomMessage: 'Ad',
skipMessage: 'Skip ad',
skipWaitingMessage: 'Skip ad in',
textForClickUIOnMobile: 'Learn more'
}
};
labels.ads.skipMessage: the skip message to show on player when a skippable ad is detected and the ad is in a state where it can be skipped. Default: 'Skip ad'
labels.ads.skipWaitingMessage: the skip message to show on player when a skippable ad is detected and the ad is in a state where it cannot be skipped. Default: 'Skip ad in'. This will be completed by the number of seconds remaining
before the ad state changes to a state where it can be skipped.
labels.ads.textForClickUIOnMobile: on mobile devices the click-through URL for a linear ad is provided in a box located at the top right corner of the player. This setting set the text for this box. Default: 'Learn more'.
Events are registered as explained in our Ads API documentation. Available events when using rmp-vast are:
Ads API methods are described and queried as explained in Ads API documentation. Available methods when using rmp-vast are:
Other general player API methods and events may also be available.
As with using the Google IMA SDK, autoplay of pre-roll linear video ad assests on desktop and muted autoplay on mobile are supported. Refer to our documentation about autoplay support for more information.
rmp-vast support macros desribed in the VAST 3 specification: