Documentation
This is a recommended update if you are using HLS with our player and already a 5.12.* player version.
backupSrc setting now works in-stream for DASH and HLSforceHlsJSOnMacOSIpadOSSafari setting for specific use-case with backupSrc.rmp-dvr-vod (replaces .rmp-dvr-rec) and
.rmp-dvr-live CSS classes to target specific states of DVR UI
rmp-three-xr.min.js, rmp-three-hlsjs-xr.min.js,
rmp-three-shaka-xr.min.js player builds
adForceNativeFullscreenOnIosForAds setting set as truehlsJSStartLevel index
hlsJSAbrBandWidthUpFactor to 0.7hlsJSMaxBufferSize to 60000000shaka-player.compiled.js file to
shaka-player.ui.js and shaka-player.compiled.debug.js file to shaka-player.ui.debug.js
dashFirst setting does not apply to iPadOS and macOS Safari to leave AirPlay feature available when HLS is available along with DASHplayer_name and
player_version settings
hlsJSMaxBufferLength, hlsJSAbrBandWidthFactor,
hlsJSAbrBandWidthUpFactor, hlsJSBackBufferLength
shakaStreamingBufferBehind,
shakaStreamingBufferingGoal,
shakaStreamingRebufferingGoal,
shakaBandwidthDowngradeTarget,
shakaBandwidthUpgradeTarget, shakaSafeSeekOffset
hlsJSLiveBackBufferLength with
hlsJSBackBufferLength and make it work for VOD
hlsJSLowLatencyMode and hlsJSProgressive settings
forceNativeHlsOverHlsJS setting)adImaEnableOmidBeta setting
adForceNativeFullscreenOnIosForAds setting__device-ua__, __gdpr__ and
__gdpr-consent__ ad tag variables
rmp-hlsjslight.min.js player buildadSkipButton and adSkipOffset settingshlsaudiotrackswitched, shakaaudiotrackswitching and
hlsaudiotrackswitching API events
isWebView API methodgetLivePresentationStartTimeAsDate returns -1 properly when no value is availablegetAdSystem API method that would return
Object instead of String value with rmp-vast
automaticFullscreenOnLandscape would not work with pre-roll video adsmeta event for native HLS
shakaCustomResponseFilter setting for advanced DRM use-cases
playlistEndedLoop|relatedEndedLoop is set to true and a new item is requested after current item has reached content end
adSkipButton and adSkipOffset settings
getLivePresentationStartTimeAsDate that would return
null with hls.js when a value is available
getAdSkipTimeOffset, getAdvertiserName and
getAdSurveyUrl API methods for rmp-vast (already available for Google IMA)
dvrisvod and dvrislivegetLivePresentationStartTimeAsDate API methodgaTrackingIdAlt setting for measurements to be sent to an additional Google Analytics propertyexitfullscreen analytics eventadShowMarkers setting would cause markers to not be properly removed in player timeline after ad viewing for mid-roll and post-roll adsgaNamedTracker and
gaNonInteractionEvents settings
adPauseOnClick and getAdUIElements settingslabels.ads.skipWaitingMessage settinggetAdUniversalAdIdRegistry,
getAdUniversalAdIdValue,
getAdMinSuggestedDuration
getAdVastMediaWidth, getAdVastMediaHeight and
getAdVastMediaBitrate
src.mp4Hevc settingpauseContentOnLogoClick settinglogoclick API eventhlsJSCapLevelToPlayerSize and
shakaCapLevelToPlayerSize settings could not work properly with
pip setting (since 5.10.2)
src.mp4Hevc settingMEDIA_ERR_NETWORK trigger error API event when streaming native MP4 or HLS on HTML5 video tagaudioOnlyUseVideoLayout setting
labels.hint.back label for automated player localization
labels.hint.settings label for automated player localization
.rmp-no-play-text and .rmp-error-text CSS for better UIadAjaxWithCredentials setting default to truegetCurrentTime returns proper value when ad is on stagegetBufferLength returns proper value for live/DVRretryParameters.manifest.maxAttempts to 3liveRetries setting in favor of
retryParameters setting
airplaymediaunloaded and airplaymedialoaded API events
data-cue-settings
audioOnlyIcecast setting
hideModule.volume setting that would not work properly for audio only playerpip setting (Picture-in-Picture) to true
hlsJSXhrWithCredentials and
hlsJSXhrSetup settings
audiotrackswitching and
audiotrackswitched API events
hlsaudiotrackswitched,
hlsaudiotrackswitching, shakaaudiotrackswitching,
shakaaudiotrackswitched API events in favor of
audiotrackswitching and audiotrackswitched API events
dashFirstIpadOS setting, now in auto-guess modeforceHlsJSOnMacOSIpadOSSafari setting, now in auto-guess mode
webkit-playsinline legacy attribute supporthideModule.qualityInfoNativeHls informational setting
This release brings in-player out-of-the-box support for styling of closed captions (FCC compliant)
ccFontColor, ccFontOpacity,
ccFontSize, ccFontFamily,
ccFontEdge,
ccBackgroundColor,
ccBackgroundOpacity,
ccWindowColor, ccWindowOpacity settings
fccCaptions attribute to automated player localization
getHlsManifestData now returns hlsManifestData.levels, hlsManifestData.audioTracks, hlsManifestData.subtitles and hlsManifestData.captions attributesgetHlsSessionData API (#EXT-X-SESSION-DATA).rmp-button-inline with .rmp-inline class
.rmp-in-band-cc class.rmp-handle and
.rmp-desktop-volume-handle classes for all skins
adSchedule markers that would not show in some instances
adTagReloadOnEnded is set to true, make sure
adSchedule reloads when video has ended in case content is requested for playback again
error event that would not trigger in some DASH DRM scenario
shakaStreamingIgnoreTextStreamFailures default to true
forceHlsJSOnMacOSIpadOSSafari default to trueabortDownload APIabortdownloadcompleted eventccFSFontSize,
ccTextColor, ccBackgroundAlpha settings - replaced with above FCC compliant settings for styling closed captions
shakaManifestDashDefaultPresentationDelay with
shakaManifestDefaultPresentationDelay setting
hideBlackFrameWhenNoPosterForLiveStream setting with
hideInitialBlackFrameWhenNoPoster to allow for poster frame taken from video stream to be displayed for on-demand and live content in case one is not set with contentMetadata setting
ccParser settinghlsJSFetchXhrWithCredentials settingccFSFontSize, ccFontSize,
ccTextColor, ccBackgroundColor,
ccBackgroundAlpha settings
hlsJSXhrWithCredentials settinghlsJSXhrSetup settinglabels.hint.cast that was displaying an inaccurate transaltion for some languagestext-align property for .rmp-transcripts-body CSS class
labels.hint.transcriptconsole.error for error and console.warn for warning in debug logscontentMetadata.thumbnail and
contentMetadata.duration for playlist and related
contentMetadata settingrelatedCallback settinggetRelatedItem, setRelatedItemCallback and
resetRelatedItemCallback API methods
relatedcomplete, relateditem and
related API events
ccFiles setting with playlist / relatedfullWindowSkin settinglabels.hint.audioItem,
labels.hint.volumeMid, labels.hint.volumeFull,
labels.hint.skipToLive,
labels.hint.threeSixtyVideo
labels.ads.controlBarCustomMessage UIadEnablePreloading setting when used with VMAP
delayToFade setting default to 2800ms (from 2400ms)delayToFadeoutVolumeUI setting that would get stuck at 1600ms valuedelayToFadeoutVolumeUI settingtransition-delay CSS property to .transition LESS mixin
castmediaerror API event: use warning 7001 insteadcontentMetadata.title is on, only show up to 5 modules
max-width CSS to 50% for TV skin
hideModule.qualityInfoNativeHls setting (hide quality info on macOS and iOS Safari) and sets default to truegetPlaylistItem, setPlaylistItemCallback,
resetPlaylistItemCallback API methods
playlist, playlistitem,
playlistcomplete API events
playlistCallback settingshakawarning, shakaerror,
fullscreenerror, hlserror, hlswarning events
dashFirstIpadOS setting (defaults to true)hideModule settinghlsJSCapLevelToPlayerSize and
shakaCapLevelToPlayerSize to false
hideVolume settingsupportsSession with
isSessionSupported API)
hlsJSCapLevelToPlayerSize and
shakaCapLevelToPlayerSize to false for VR video
videoVRFRameRate setting, now auto-guess by player
getFramerate API method to get media
content
frame rate and related
frameratechange event
adAutoplayOnlyPreroll,
endOfVideoPoster,
contentTitle, contentDescription,
contentID, poster, videoTitle,
googleCastPoster, googleCastMetadataType,
googleCastContentTitle,
googleCastReleaseDate
dvrIsLive, getHlsBwEstimate,
getContentTitle, setContentTitle,
getContentDescription, setContentDescription,
getContentID, setContentID,
getPoster, setPoster, getVideoTitle,
setVideoTitle
setContentMetadata API method that would not update description UI (affected playlist/related as well)rememberQuality setting that would not work properly for live streamsbitrateDataDisplayed setting behaviour to provide information to the quality menu when no dimension data is available (but other data may be available)bitrateDataDisplayed setting
ready event on mobile instead of
playing event, which allows for early casting
bitrateDataDisplayed settingdoubleClickForFullscreen settingdelayToFade default to 2400adAutoplayOnlyPreroll settinghlsJSCapLevelOnFPSDrop,
hlsJSLiveMaxLatencyDurationCount,
hlsJSLiveSyncDuration,
hlsJSLiveMaxLatencyDuration settings
destroy API method on iOS Safari while automaticFullscreenOnLandscape setting is usedbufferstalled and buffernotstalledanymore API events that would not fire consistenly with HLS or DASHhideBlackFrameWhenNoPosterForLiveStream settingpreload setting to metadataforceNativeHlsOverHlsJS settingforceHlsJSOnMacOSSafari settinghlslevelswitching, shakalevelswitching API events
shakaSwitchInterval setting that would have no effect with 5.7 releasegetStreamMode API methodgetLiveCurrentTime and getLiveDuration API methodsgetAdVastMediaBitrate,
getAdMinSuggestedDuration, getAdSkipTimeOffset,
getAdUIElements, getAdUniversalAdIds,
getAdVastMediaHeight, getAdVastMediaWidth API methods
advideoclicked, adskipped,
adskippablestatechanged, adperiodstarted,
adperiodended API events
shakaDurationBackoff,
shakaStartAtSegmentBoundary,
shakaSafeSeekOffset,
shakaPreferredTextLanguage,
shakaSwitchInterval settings
shakaStreamingRebufferingGoal default to 2dvrIsLive API methodseekBarThumbnailsLoc setting which could cause thumbnails to not display (since 5.6.1)fadeInPlayer setting
adTagReloadOnEnded is used with outstream ads, make sure player UI cannot be interacted with when an ad has endedhlsJSCaptionsTextTrack1Label and
hlsJSCaptionsTextTrack2Label
shakaIgnoreMinBufferTime settingendOfVideoPoster as part of contentMetadata
getBandwidthEstimate API methodgetRatio API (returns player and media ratio)forceHlsJSOnMacOSIpadOSSafari is used on DVR stream in macOS and iOS SafariendOfVideoPoster settinggetHlsBwEstimate API methodisLive settingcontentMetadata setting: player, accessibility, Android Media Notifications, Google Cast
getContentMetadata and setContentMetadata
adContinuousPlayback setting supportsetSrc API: getShakaCustomRequestFilter,
setShakaCustomRequestFilter,
getShakaRequestConfiguration,
setShakaRequestConfiguration, getShakaDrm,
setShakaDrm
preload setting support for iPadOSautomaticFullscreenOnLandscape setting.
fullWindowMode setting and force it to true for Google IMA ads on iPhone iOS 10+viewableAutoplay and viewablePlayPause setting that would cause autoplay on page load rather than on viewable for outstream ads (since 5.5.6)googleCastPoster setting in favor of DPR
poster
adDisableCustomPlaybackForIOS10Plus setting and built automated logic in playerquickRewind and/or quickForward settings
quickRewind and quickForward with audio-only playerdetectAutoplayCapabilities setting with
requestAutoplayCapabilitiesData
destroy API is called and PiP mode is engaged
quickRewind and quickForward works with DVR streams (for the recorded part of a DVR stream)setSrc is used after an error has occurred (regression from 5.5.0)shakaAutoDetectPersistentLicenseSupport settingadAjaxWithCredentials default to falsehideVolume settingadTagReloadOnEnded support for our ad-schedulergetAutoplayMode API methodautoplaymodedetected API eventretryParameters setting (for HLS and DASH) in replacement of shakaRetryParametersloop eventdestroy API method to be called while
setSrc API method is still running
forceHlsJSOnMacOSIpadOSSafari setting which brings support for quality, multi-audio modules and DVR controls for iPadOS (through hls.js and Media Source Extensions)manualSwitchingMode setting to select what mode for manual bitrate switching should be used by the player (works for HLS and DASH)hlslevelswitching and
shakalevelswitching API events in favor of levelswitching event
forceHlsJSOnMacOSSafari setting in favor of
forceHlsJSOnMacOSIpadOSSafari setting
getPlayerVisible API method,
playerinview and playeroutofview API events
autoplayMutedDisplayQuickUnmuteButton setting - displaying of volume UI is now automatically set based on device type (Desktop/Android/iOS)
labels.error.customErrorMessage is shown
ariaLabels into labels setting - allowing Aria label to support automatic translationlabels positioning and colorization for all skinslabels.error.customErrorMessage is displayed in some instances
labels and not all first tier labels are defined
adTagReloadOnEnded setting default to true to maximize ad revenuelabels.ads.googleCastSkipWaitingMessage label by
labels.ads.skipMessage label for simplicity purposes
autoplayMutedDisplayQuickUnmuteButton button not rendering correctly at lower sizes in some context
This release brings automatic localization of player labels based on viewer preferences to Radiant Media Player. We support 7 languages as of 5.4.0: English, French, German, Spanish, Italian, Portuguese and Russian.
detectViewerLanguage settingadLocale setting default to 'auto' for automatic detection of viewer languageadBlockerDetectedMessage setting in
labels.ads.adBlockerDetectedMessage
labels.captions.off setting to
labels.hint.off setting
autoplayMutedDisplayQuickUnmuteButton setting. With the release of Radiant Media Player 5.3.0, we introduced a new mobile-first volume management interface. For use-cases where muted-autoplay was used, rapidly unmuting
playing content would require an additional step which may not have always been user-friendly. When
autoplayMutedDisplayQuickUnmuteButton is set to true a quick shortcut button to unmute content will now display on player when player is started in muted autoplay mode. Once content has been unmuted this button will disappear.
.rmp-outline CSS class to
.rmp-control-bar CSS class
.rmp-quick-unmute-ui to container level classes
getAdsManager API method on
adadsmanagerloaded API event for Google IMA
getCompanionAds API
method for rmp-vast which now returns an Array of Object, where each Object represents a companion adgetCompanionAd API method for rmp-vast to get an HTMLElement image associated with a companion ad
adBlockerDetectedMessage setting in
labels.ads.adBlockerDetectedMessage setting
shakamanifestparsed API eventbackupSrc setting default to [] (from {})
quickForward menu when ad is on stageadclientsidewaterfallrequested,
adloaderror,
adplayerror API events from Google Analytics integration
adplayerror and
adloaderror redundant API events > use getAdErrorType API method upon
aderror API event instead
bitrates,
backupBitrates and
video360FallbackBitrates settings
sharing setting (since 5.3.1)adplayerror and adloaderror redundant API events > use getAdErrorType API method upon
aderror API event instead
audioOnlyUseVideoLayout setting -
this
allows to use our video player for audio-only
content, therefore allowing features like player modules or video ads for audio-only content
.rmp-audio-only-use-video-layout CSS class as container level classlevelswitching API eventrememberCurrentTime setting
through
localStorage
rememberQuality setting
through
localStorage
playlistAudioOnly setting
offsetStartPosition setting that would not work for iOS when video ads were enabledThis release focuses on improving Radiant Media Player accessibility features on mobile devices following 5.3.1 release.
.rmp-hide-central-play and
.rmp-hide-central-buffering CSS classes
This release focuses on bringing Radiant Media Player accessibility features to better standards.
event.key instead of
event.which for keyboard navigation
c keyboard key
ArrowLeft and ArrowRight now seek by 5 seconds (instead of 10 seconds before)0, 1,
2, 3, 4,
5,
6, 7, 8,
9 can now be used to seek to respectively 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90% of on-demand content
Escape keyboard key can now be used to close a module menuEnter keyboard key is now used to enable a menu or buttonariaLabels.volumeOff with
ariaLabels.volumeMute
ariaLabels.volumeUnmute,
ariaLabels.share,
ariaLabels.caption,
ariaLabels.upNext,
ariaLabels.chapter,
ariaLabels.quickForward,
ariaLabels.quickRewind,
ariaLabels.qualityAuto,
ariaLabels.qualityLevel,
ariaLabels.audioLanguage,
ariaLabels.nextPlaylistItem,
ariaLabels.previousPlaylistItem
quickRewind and
quickForward buttons
adLiveStreamPrefetchSeconds settinggetAdUniversalAdIdRegistry and
getAdUniversalAdIdValue with Google IMA DAI
getCurrentTimeBeforeSeek API method.rmp-module-overlay-open class to player container level classes.rmp-container-focus with
.rmp-alt-focus
When volume management matters on mobile devices as well! Radiant Media Player 5.3 brings to the player table an innovative and mobile-first approach to volume management. With the recent availability of volume management for Android devices we have created a dedicated touch-oriented volume module which vastly improves the user experience on both mobile and desktop. Other new features for 5.3 release, including audio-only playlist, are listed below:
labels.hint.volume player labelariaLabels setting to
allow for player aria labels customisationsetVolume and getVolume API methods when displaying Google IMA DAI ads that would not get/set accurate volume valuesloadAds API method with outstream adslabels.hint.threeSixtyVideo player label
skinAccentColor setting)quickRewind and
quickForward settings are used together - adds dedicated quick-rewind-and-forward.less and quick-rewind-or-forward.less files
uiSeparator appearing unexpectedly in quality module when no height is available with Shaka player (but bandwidth is available)getDefaultPlayerSettings API method to return all default player settingsgetPlayerSettings API method to return only input player settingsgetCurrentTimeInPercent API methodnav and navRates settings in favour of speed and
speedRates settings
getAutoplayRequested,
getHlsRawProgramDateTime,
getHlsEpochProgramDateTime,
getHlsId3TagSamples API methods and
hlsid3tagparsingcompleted,
hlsprogramdatetimeavailable API events
forceInitialVolume settingmeta API event and getMetadata API methodgetMetadata API method for HLS with ID3 tagsgoogleCastVmapAdsRequest from working on CAF receiver when adTagUrl was set as well
hlsprogramdatetimeavailable API event and getHlsEpochProgramDateTime and
getHlsRawProgramDateTime API method
This 5.2 release brings support for video ads and live UI on our Google Cast receiver app. It also adds support for UI timeline markers for our ad-scheduler/VMAP to indicate to viewers when ad-breaks are scheduled.
googleCastAdTagUrl and
googleCastVmapAdsRequest settings
labels.ads.googleCastSkipWaitingMessage setting
adShowMarkers settingmeta and API method
getMetadata
hlsid3tagparsingcompleted API event and getHlsId3TagSamples API methodskipAd and getAdSkippableState API methodsadsResponse setting for Google IMAconsole.dir where available for better debugging
quickForward setting and quick forward player option (compatible with quick rewind at the same time)alltexttracksloaded event now fires for hls.js, Shaka player and native VTT captionsgetCaptionsData method now works for hls.js, Shaka player and native VTT captionssetBitrate API method
autoplayCount setting and related
resetAutoplayCount API method
hlsJSLiveSyncDuration with
hlsJSLiveSyncDurationCount setting
setSrc API method can now be used in conjunction to the
fallback
streaming URL feature
setSrc API method to work for 360 video over 360 video contentsetSrc API methodhlsJSInitialLiveManifestSize and
hlsJSLiveBackBufferLength player settings
detectAutoplayTimeout setting and improved autoplay support detectionadCookiesEnabled settingadVpaidControls set to true now insures player controls are visible for the whole period of the VPAID creative
quickRewind setting (regression from 5.0.4 release)
adskipped event now fires with rmp-past
adSkipButton setting
setLogo API method can now be used to unset logo
getCurrentTime API method now reports relative time to window start for DVR streamsgetDuration API method would return -1000 instead of -1 when value was not available for DVR streamssrcchanging API event for notifying of source change startgetPreload API methodgetAdWrapperCreativeIds API methodgetBitrates and
getCurrentBitrateIndex API methods that would throw an error with progressive download since 5.0.0
adEnablePreloading setting
adSkipButton setting more accessible
gaNonInteractionEvents setting which enables sending Google Analytics video-related events as
non-interaction
events
getPlayerVersion API method that would not return correct player version since 5.0.0 releaseThis is the first production-ready release for Radiant Media Player 5 - we hope you find it enjoyable and even better than version 4!
video360FocalLength default to 65,
video360MaxFocalLength default to 115,
video360MinFocalLength default to 25,
video360InitialLon default to 0
Radiant Media Player 5 offers a new way to optimise player loading and start-up by providing optimised builds that pre-pack common features. It is recommended to start using those pre-pack builds when possible. No matter what build you
use, if you request a specific feature that is not available in the selected build by default, the player will attempt to load the required dependency when needed - so if you are not sure what to use, simply include the generic rmp.min.js build.
See our docs for a
list of available builds.
detectAutoplayCapabilities setting
autoplayfailure event fires when autoplay is detected as not available before trying to play content
destroy API method from concurrent running
getModuleOverlayVisible|setModuleOverlayVisible
API
methods
setPlayerSize now resolves to a
resize event
setPlayerSize has now no effect if player is in fullscreen modesetPoster method upon ready event would cause poster to not update
setSrc for easier maintenance.rmp-content element
error event fires make sure the
setSrc API method can still be called to update player with a new source
error event for Shaka playerliveRetries settingshakaCapLevelToPlayerSize to true
shakaCapLevelToPlayerSize now takes into account player heightshakaCapLevelToPlayerSize settin where first fragment could have a width/height mismatch when
shakaStartLevel was set to -1
preload setting set to 'auto' with DASH in macOS SafaribackupSrc now accepts an Array of Object of backup streaming sources (previously only one Object could be passed)getThumbnails and
setThumbnails API methods
warning event: failed to load VTT thumbnail file at URI.rmp-fullscreen-on CSS to avoid edge-case issues on Androidline-clamp-ellipsis LESS mixin and apply it to playlist description.rmp-error classbitrates setting - use src from now on -
bitrates setting is still available for backward compatibility
backupBitrates setting - use
backupSrc from now on -
backupBitrates setting is still available for backward compatibility
backupSrc as an Object - use Array of Object now - still available for backward compatibilityvideo360FallbackBitrates setting - use
video360FallbackSrc from now on -
video360FallbackBitrates setting is still available for backward compatibility
getAutoplayRequested in favour of autoplay API events - still available for backward compatibilityvideo360ArrowMoveFactor and
video360MoveSpeedFactor settings - now auto detected based on player size
mutedAutoplayOnMobile and
mutedAutoplayOnMacosSafari11Plus settings in favour of detectAutoplayCapabilities setting
https://cdn.radiantmediatechs.com/rmp/v4/latest/js/rmp.min.js and has been frozen to version 4.10.5.
error code 103 in favour of
warning code 1007: URI of backupSrc is unavailable - trying next
destroyerror with
warning code 1004
useRmpVastOnImaLoadError setting
hlsJSLight setting in favour of
rmp-hlsjslight.min.js build
shakaMuxJSHls setting in favour of
rmp-shaka-mux.min.js build
©2015-2021 Radiant Media Player. All rights reserved.