nexxPLAY
Search…
SDK Override Options
The following List reflects all Key/Value Pairs, that can be used in a _play.PlayerConfiguration Object.

Player Layout and Control

Key
Values
Description
adjustContainerDimensions*
[0,1]
If set to 0, nexxPLAY will never try to change the Dimensions of the Container, even if no width/height is found. This may lead to inconsistent Layouts. If set to 1, nexxPLAY will automatically scale Player Height with aspectRatio, if necessary.
aspectRatio*
Float
Used, if adjustContainerDimensionsis set to 1 and no style.height Value is found
playstateListeners*
Array
If you want to use a dedicated Listener only for this PlayerInstance, add an Array of Listener Functions here
applyFocus*
[0,1]
automatically apply Page Focus to the Player after Init Phase
dataMode
[api, static]
overrides the Player DataMode
backgroundColor
Hex
overrides the Background Color of the Player
seekbarColor
Hex
overrides the Color of the Seekbar(s)
playerSkin
[simple, default, glass, glass66, float, centered, minimal, minimalwithtime, minimalwithright]
overrides the Player Skin - if you use a custom Skin, ask 3Q nexx for Details, as its Codename is not mentioned here.
loaderSkin
[default, doublebounce, material, metro, ios]
overrides the Loading Spinner Skin.
audioSkin
[image, wave, hero]
overrides the Audio Player Layout (only applied, if Player is not in Mini/Micro Mode)
imageScaleMode
[width, height, fixed]
controls the Image Scaling of Startimage, Background Image, ExitDisplay Image etc.
popOutClass*
CSS Class
if the Player enters PopOut Mode, the given Class will be applied
applySafeAreaPadding
[0, 1]
if the Player is positioned on the extreme Top on an Edge-to-Edge Layout not in Fullscreen, the Player will add Safety Padding on the extreme Top/Bottom Elements
applyNotchPadding
[0, 1]
if the Player is embedded in a Website, where it may conflict with Notches, apply left/right Padding on the Notch Side
titleMode
[0, 1, 2]
handles the Title Display Behaviour
0: never show Title,
1: always show Title,
2: show Title only in Fullscreen
(Setting will be ignored on Audio Players)
menuMode
[0, 1, 2]
handles the Menu Display Behaviour
0: never show Menu,
1: show Menu on MouseOver/Tap,
2: always show Menu
(Setting will be ignored on Audio Players)
scrollingMode*
[0, 1, 2]
0: don’t react to Scrolling at all,
1: pause Player, if less than 50% is visible
2: switch to PopOut Player, if less than 50% is visible
scrollingModeTrigger*
[0-100]
if Scrolling Mode is set, trigger the Behaviour on this Value (=Player is visible at VALUE%)
bumperMode
[0,1]
forces or disables Usage of Bumpers on the given Media Item

Player Functionality

Key
Values
Description
autoPlay
[0, 1]
If set to 1, the Player will start immediately (if Browser supports this)
autoPlayIfMutedPossible*
[0, 1]
If set to 1 AND autoPlay is active, the Player will also try to start automatically, if only muted Playback is possible.
autoPlayMutedAlways*
[0, 1]
in AutoPlay Mode, start muted, even if the Browser would support Playback with Sound
autoPauseAutoPlayMutedAfterSeconds*
int
if set to 0, muted AutoPlay will run forever, otherwise, if will automatically stop after the given Integer (Seconds)
autoPlayMutedAfterSeconds*
int
if set to a Value larger 0 and if the Player does not use AutoPlay, the Player will start muted AutoPlay without User Interaction after the given Integer (Seconds)
respectAutoPlayDataSaver
[0, 1]
if set to 1, the Player will not start automatically, even if other Settings are forcing it, if the current Device uses Data Saving
autoNext
[0, 1]
enables “RevolverPlay” / “Continuous Play”, if an exitModeis defined and Browser supports this.
delay
float
start the Media Item not at the Beginning, but at this Position
startPosition
int
if playing a Container Item, dont start at the Beginning, but at this Item Position
exitMode
[replay, loop, load, navigate, stop]
replay: only show Replay Button on Media End
loop: automatically restart on Media End
stop: dont do anything
load/navigate: load Suggestions and show them in the Player (and start them IN the Player (load) or NAVIGATE to the Media (navigate)
playbackMode
[default, pseudolive, story, presentation, scenesplit]
forces the Player to present the UI in the given Playback Mode
mobileAutoFullscreen*
[0, 1]
automatically enters Fullscreen on first User Interaction (on Smartphones only)
playOnExistingCastSession
[0, 1]
automatically play the new Media on a connected Chromecast, if this Chromecast was connected before and still able to receive Commands
enableLightsOut*
[0, 1]
activates the LightsOut Functionality of nexxPLAY and shows a Button in the Player for this Feature
lightsOutAutomaticAfterSeconds*
int
use LightsOut Functionality and start it after X Seconds. Dont show a Button in the Player for this.
hidePrevNext
[0, 1]
if the Player controls a Container Element, it will show prev/next Buttons. If that is not desired, set this Feature to 1
forcePrevNext
[0, 1]
if the Player controls a single Element, if will not show prev/next Buttons. If that is desired though, set this Feature to 1 (the Player will emit an "changemediaintent" Event, which must be answered via one of the swapMedia SDK Functions)
disableErrorExit
[0, 1]
if the Player encounters an Error during Media Playback or API Communication, it normally switches to an Error View. If the Environment can handle it, you can disable ErrorView for these Cases. Instead, the Player emits an "changemediaintent" Event, which must be answered via one of the swapMedia SDK Functions)
enableSystemMedia
[none, all, audio, video]
controls the OS-level Media Detail Display and Control of the Player
Attributes, marked with a "*" are only usefull in a Web Environment and therefore not available for native Players.

Ad Management

Key
Values
Description
disableAds
[0, 1]
disable all Ad Types in the Player
disablePrerolls
[0, 1]
disables only Prerolls
disableMidrolls
[0, 1]
disable only Midrolls
disablePostrolls
[0, 1]
disable only Postrolls
disableBanners
[0, 1]
disable only Banners
disableBreakAds
[0, 1]
disable only BreakAds
adProvider
3Q nexx Code
overrides the configured Ad Provider Code
adType
[vast, ima]
set the used Ad Processing Framework
adMinimalDistance
int
manually override the minimal Time,
that has to pass between two (linear) AdCalls
adVASTTimeout
int
manually override the Time (in Seconds), that the Player allows to process a single VAST Call
adMediaTimeout
int
manually override the Tme (in Seconds), that the Player allows to process an Ad Media Item
adBumperURL
url
manually override the Ad Bumper URL.
adPrerollURL
url
manually override the Ad Preroll URL.
adMidrollURL
url
manually override the Ad MidRoll URL.
adPostrollURL
url
manually override the Ad Postroll URL.
adBannerURL
url
manually override the Ad Banner URL
adBreakURL
url
manually override the Ad BreakAd URL
adMidrollInterval
int
manually override the Frequency of Midroll Calls
(if Interval is the chosen Midroll Logic, in Minutes)
adMidrollUseScenes
[0, 1]
if set to 1, Midrolls will be shown between Scens/Breakpoints. Otherwise, the Interval Logic will be used.
Attributes, marked with a "*" are only usefull in a Web Environment and therefore not available for native Players.

Addon Management

Key
Values
Description
commentBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render Comments (via Comment Addon).
containerBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render Sub-Elements (for Playlists, Audio-Albums etc) (via Container Addon).
recoBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render Recommendations (via Reco Addon).
sceneBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render Scenes (via Scene Addon).
albumBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render an Image Album (via Album Addon).
filesBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render connected Files (via Files Addon).
linksBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render connected Links (via Links Addon).
tickerBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render a LiveTicker (via LiveTicker Addon).
pollBoxContainer
HTML Element ID
The ID of a "div" (or other HTML Element), that shall be used by the Player to render a Poll (via Poll Addon).
Addons are not supported by native Players.