Customizing the Player V4 Skin with skin.json
To use skin.json to customize the player look and feel, do the following:
- Download the latest version of the skin.json config file:
- Host the skin.json config file on your server.
- Make modifications to the JSON attributes to apply look and feel changes to your player.
- Reference the absolute path to your skin.json file when you load your player.
To view the API documentation for skin.json, go to apidocs.ooyala.com. The following table shows the path to the documentation for each customizable player component. See User Interface for the Player V4 Skin for a description of the player components.
|Player Component||Path to Documentation||Notes|
|Responsive Design||For videos with an aspect ratio where the height of the video is greater than the width or the width is much greater than the height, we recommend that you use our default responsive design setting (aspectRatio:auto).|
|Player Control Bar|
|Up Next Screen|
Note: For the Google IMA ad plugin and the VAST and VPAID plugin rendering VPAID 2.0 ads, the ad control bar and ad marquee configurations in skin.json are ignored (and are forcibly set to off) because both of these render ads and the UI, which can have interactivity at various locations unknown to the plugins themselves. Rather than risk blocking any interactivity with our ad marquee or ad control bar, we made sure to hide them.You can also use the ads embedded parameters described in Configuring Ad Parameters to further customize the ad screen.
|Social Sharing Options|
|More Options Screen|
|Discovery Screen||Any Discovery settings you make in Backlot will be overwritten by the
settings specified in skin.json.
Note: You must have Discovery enabled in Backlot for Discovery recommendations to appear. For HTML5 players, for Discovery to work, you must load the Discovery module (<script src="url_where_hosted/discovery_api.min.js"></script>) in the <head> of the page where you load your player. If Discovery is not enabled, the Discovery icon will not appear in the control bar or more options menu.
|Closed Caption Options||We now offer closed caption support for VOD (all streams) and Live (HLS on Safari) content with the Player V4. By default, the player will show a closed caption button for all assets with closed captions. To enable closed captions for a video, simply upload your closed caption file for your asset in the Backlot UI or via the Backlot API. Supported closed caption formats include DFXP v2006 format and embedded CES-608.|
|Player Buttons||Clickto view the button names. Click to see an example button.|
|Player Localizable Strings||For this release, Ooyala offers localized player controls and error messages into Spanish and Simplified Chinese.|