Application Configuration Properties

Application Configuration Properties control certain visual aspects of the player and playlist applications (e.g. width, height, displaying an overlay, how many rows/columns of thumbnails to show, etc.) as well as functionalities (e.g. social sharing, autoplay, cycling playlists, etc.). Our framework provides core configuration properties that are standard across all applications regardless of the skin or layout applied. Any properties outside of the core are dependent on the respective skin or layout to respect that configuration property.

Core properties are represented in blue.

Non-core properties are represented in red.

All Applications

Property Description
width Define the width of app in pixels.
height Define the height of app in pixels.
dependencies Include a comma separated list of dependent scripts or css files to load with the app.

Player

Property Description
Playback Properties
volume Set the playback volume for initial video play.
  • values: any decimal between 0-1
  • default: 0.5
mute If true, playback audio will be muted upon initial video play.
  • default: false
bitRate Specify the desired bitrate for video playback. The player will choose from the available encodings and stream the encoded video that most closely matches the specified bitrate.
  • default: 0
playerQuality
Only available on Player 2.0
If true, the player will display the player quailty icon on the control bar and users can select which bitrate to stream
  • default: false
Note: This property replaced enableHD, which has been deprecated. In addition, when users toggles to another bitrate, the player will refresh itself and load the new stream.
autoPlay If true, videos will play automatically upon player load.
  • default: false
autoNext If true, consecutive videos in the playlist will play automatically.
  • default: false
refreshOnIndexChange If true, page will be refreshed when the current playlist item (index) changes.
  • default: false
Note: If autoPlay is set to false, autoNext will default to false.
playbackPriority Defines the priority between Flash and HTML5 with fallback support.
  • default: flash,html5
  • value: a comma delimited list, e.g.: "html5,flash"
forceHTML5 If true, the video player will load in HTML5 regardless of the user agent.
  • default: false
adAttempts Set the number of attempts to call for an ad before the player loads video content.
  • default: 1
  • value: any whole number between 1-10
adsOnly If true, the player will not require a playlist and will be set to play pre-roll ads only.
  • default: false
Display Properties
dock
Only available on Player 1.9
If true, the dock (player control bar) will always be visible. If false, the dock will automatically fade out after a period of inactivity.
  • default: false
playerColorSub
Only available on Player 2.0
Specify the color of the volume progress and the playback progress bar.
  • default: #E51937
  • value: 'hexadecimal value'
Note: The color must be a hexadecimal value.
playerColorBG
Only available on Player 2.0
Specify the background color and opacity of the player control bar.
  • default: rgba(0,0,0,0.75)
  • value: 'rgba value'
Note: If hexadecimal value is provided, the opacity of the control bar will be lost.
hideControls
Only available on Player 1.9
If true, the player will be chromeless, hiding the entire control bar.
  • default: false
showOverlay If true, the player will overlay the video title and a play button.
  • default: true
Note: An overlay is required for most mobile playback.
playerGridIcons If true, the grid icon (three vertical dots) will appear on the control dock and all other icons except for the play/pause, and the volume icon will be hidden. Hidden icons will show in an overlay when grid icon is clicked.
  • default: false
socialNetworking If true, Facebook and Twitter sharing options will be enabled in the control bar
  • default: false
Note: The shared link will be the URL of where the video player is published.
infoButtonURL
Only available on Player 2.0
Specify a URL that users can click to view more information about your company
  • value: 'URL' (must include 'http://')
embedEnabled
Only available on Player 2.0
If true, the player will display an embed icon that will provide users an embed code that they can use to embed the video player on their website.
  • default: false
embedSecurity
Only available on Player 2.0
If embedEnabled is set to true, define restrictions on which sites can embed your video player.
  • default: 'allow'
  • values:
    • allow: Allows any website to embed your video player
    • allow_list: Allows only a list of approved websites to embed your video player
embedSecurityVal
Only available on Player 2.0
If embedEnabled is set to 'allow_list', define a list of sites that can embed your video player.
  • default: false
  • values: 'comma delimited list of URIs' (must include 'http://')
videoTitleTarget Specify the DOM ID where the current video's title will be displayed.
  • value: 'DOM ID'
videoDescriptionTarget Specify the DOM ID where the current video's description will be displayed.
  • value: 'DOM ID'
videoInfoTarget Specify the DOM ID where videoInfoDisplay will be displayed.
  • value: 'DOM ID'
Note: videoInfoDisplay and showThumbs must be set to true in order to use this property.
playerFill If set, the player will become responsive to the dimensions of the target div (conforming to a 16:9 aspect ratio) and ignore the width and height properties set
  • default: false (The width and height will be determined by the player properties)
  • values:
    • both: player will automatically resize to fill the height and width of the target div
    • height: player will automatically resize to fill the height of target div
    • width: player will automatically resize to fill the width of target div
Note: When playerFill is set to both, the target div must have a set width and height. If set to height, the target div must have a set height. If not, an error will occur.
playerRenderer Set the player to render your own custom player skin.
  • value: 'reference to JavaScript file'
    • 'absolute path to JS file' OR
    • 'relative path' (if path references the same domain) OR
    • 'name of renderer' (if JS file sits on Adaptive Media's CDN--the path will be constructed internally)

JS file contains logic to render the player and controls the display of the player.
Note: In player 1.9, the value should be the JS function name and the JS absolute file path is placed in the dependencies property

showContext
Only available on Player 1.9
If false, hides 'About Adaptive Media' in the context menu (appears when users right-click on the player).
  • default: true

Playlist

Property Description
Playback Properties
startIndex Set playback to start at the numeric index provided of the playlist.
  • default: 0
Note: The first video in a playlist is equivalent to index 0.
videoStartId Set playback to a specific video item.
  • default: false
  • value: 'OS video ID'
Note: If video ID is not found, the first video of the playlist will load.
random If true, sequential video playback will be randomized (playlist rendering is not affected).
  • default: false
autoNextPlaylist If true and playlistCycles is reached, the next playlist will automatically play when the current one ends.
  • default: false
playlistCycles Set how many times a playlist gets repeated when it reaches the last video in the playlist.
  • default: 1 (playlist will not start over)
Note: For endless playback set to 0 and set autoNext to true.
Display Properties
showThumbs If true, display thumbnails of videos in the playlist.
  • default: false
thumbsRows If showThumbs is set to true, specify the number of rows to display for the thumbnail grid.
  • default: 3
  • value: any numerical value
thumbsColumns If showThumbs is set to true, specify the number of columns to display for the thumbnail grid.
  • default: 3
  • value: any numerical value
thumbsDurationDisplay If true, the duration of each video will be displayed on the thumbnail image.
  • default: false
thumbsTitleDisplay If true, video titles will be displayed under the thumbnail images.
  • default: true
  • If false, video titles will be displayed when users hover over a thumbnail
thumbsTooltip If true, tooltip will appear with description of the video when user mouses over the thumbnail
  • default: false
thumbsTooltipPosition If thumbsTooltip is set to true, set the position of where the tooltip appears.
  • default: top
thumbsTarget Specify the DOM ID where the thumbnails will be rendered
  • value: 'DOM ID'
thumbsRenderer Set the thumbnails to render your own custom thumbnail skin/layout.
  • value: 'reference to JavaScript file'
    • 'absolute path to JS file' OR
    • 'relative path' (if path references the same domain) OR
    • 'name of renderer' (if JS file sits on Adaptive Media's CDN--the path will be constructed internally)

JS file contains logic to render the thumbnails and controls the display/layout of the thumbnails.
Note: In player 1.9, the value should be the JS function name and the JS absolute file path is placed in the dependencies property

videoInfoDisplay If true, the current video's title and description will be displayed.
  • default: false
Note: Configure videoInfoPosition to control where the title and description will be displayed.
Note: showThumbs must be set to true in order to use this property.
videoInfoPosition Specify the position in which the video's title and description will be displayed.
  • default: 'bottom'
  • values:
    • 'bottom': title and description will be displayed below the player and the thumbnail grid
    • 'top': title and description will be displayed above the player
useLongDescription
Only available on Player 2.0
If true, the long description of the video will be displayed instead of the short description.
  • default: the description field with the most number of characters will render
  • values:
    • true: The long description will be displayed
    • false: The short description will be displayed
Note: showThumbs must be set to true in order to use this property.
showTabs If true, will attempt to render a UI to display playlist tabs for displaying multiple playlists and for switching playlists for playback
  • default: false
tabsTarget Specify the DOM ID where the playlist tabs will be displayed.
  • value: 'DOM ID'
playlistTitleTarget Specify the DOM ID where the playlist's title will be displayed.
  • value: 'DOM ID'
playlistDescriptionTarget Specify the DOM ID where the playlist's description will be displayed.
  • value: 'DOM ID'
tabsRenderer Set the tabs to render your own custom playlist layout.
  • value: "path to JavaScript file"
    • 'absolute path to JS file' OR
    • 'relative path' (if path references the same domain) OR
    • 'name of renderer' (if JS file sits on Adaptive Media's CDN--the path will be constructed internally)

JS file contains logic to render a UI for multiple playlists and for switching between playlists
Note: In player 1.9, the value should be the JS function name and the JS absolute file path is placed in the dependencies property

media Provide your account's passthrough playlist with video ID(s)
  • value: 'http://data.onescreen.net/playlists/1234567/1234/5678/9875432.xml?plf=os&itm;=1357901'
  • this will override any playlists configured with the player
  • Commonly used to load a single video

Note: It is important that you use your own passthrough playlist in order to receive accurate reporting

Ads

Property Description
Ad Properties
ads Specify any XML URI to override any ad targeted to the player application.
  • value: 'ads XML URI'
Note: We do not recommend using ad overrides for production/live applications. For live apps, please target your application to an inventory.
clearCompanions If true, companion banners will be removed when an ad break ends.
  • default: false
companionTargets Specify the DOM ID where companion banners may be loaded.
  • value: [{id:'DOM ID', width: of DOM ID in pixels, height: of DOM ID in pixels}]
forceCompanions If true, an absolute positioned div will be created to display a companion banner.
  • default: false
prerollAdvance If true, a different ad will be called/loaded per video (treats OS Ad XML like a playlist).
  • default: false