Customize Web Player
Obscreen provides an URL for each playlist.
Player's playlist URL is configurable in two ways:
Playlist URL
To connect the player to a specific playlist using its IDhttp://<your_studio_server_instance>:5000/use/<playlist_id>
Playgroup URL
To connect the player to a specific playgroup using its IDhttp://<your_studio_server_instance>:5000/group/<playgroup_id>
Playlist always starts with an introduction slide showing date & time (customizable). Then it plays the first content item and endlessly loops through the playlist items according to the schedule.
Every 5 seconds (customizable), the Player fetches the updated JSON to display the correct content. When this feature is disabled, the JSON file is written each time your playlist is updated which can reduce the server load.
Query parameters options
You can use the following query parameters to configure the player through url parameters (e.g. http://your_player_url?intro=0&autoplay=0&animation=1):
intro
Default value: 1
Description: Show the introduction slide or not for all playlists
Available values: 0 or 1
Global settings available
animation
Default value: 0
Description: Enable/disable animation or not for all playlists
Available values: 0 or 1
Global settings available
animation_speed
Default value: normal
Description: Set the animation speed for all playlists
Available values: slower, slow, normal, fast or faster
Global settings available
animation_effect
Default value: fadeIn
Description: Set the animation effect for all playlists
Available values: backInDown, backInLeft, backInRight, backInUp, bounceIn, bounceInDown, bounceInLeft, bounceInRight, bounceInUp, fadeIn, fadeInDown, fadeInDownBig, fadeInLeft, fadeInLeftBig, fadeInRight, fadeInRightBig, fadeInUp, fadeInUpBig, fadeInTopLeft, fadeInTopRight, fadeInBottomLeft, fadeInBottomRight, flip, flipInX, flipInY, lightSpeedInRight, lightSpeedInLeft, rotateIn, rotateInDownLeft, rotateInDownRight, rotateInUpLeft, rotateInUpRight, rollIn, jackInTheBox, zoomIn, zoomInDown, zoomInLeft, zoomInRight, zoomInUp, slideInDown, slideInLeft, slideInRight or slideInUp
Global settings available
animation_exit_effect
Default value: none
Description: Set the animation effect for all playlists
Available values: none, backOutDown, backOutLeft, backOutRight, backOutUp, bounceOut, bounceOutDown, bounceOutLeft, bounceOutRight, bounceOutUp, fadeOut, fadeOutDown, fadeOutDownBig, fadeOutLeft, fadeOutLeftBig, fadeOutRight, fadeOutRightBig, fadeOutUp, fadeOutUpBig, fadeOutTopLeft, fadeOutTopRight, fadeOutBottomLeft, fadeOutBottomRight, flip, flipOutX, flipOutY, lightSpeedOutRight, lightSpeedOutLeft, rotateOut, rotateOutDownLeft, rotateOutDownRight, rotateOutUpLeft, rotateOutUpRight, rollOut, hinge, zoomOut, zoomOutDown, zoomOutLeft, zoomOutRight, zoomOutUp, slideOutDown, slideOutLeft, slideOutRight or slideOutUp
Global settings available
cover
Default value: 0
Description: Force 100% width for pictures or videos content types
Available values: 0 or 1
autoplay
Default value: 0
Description: Enable/disable video autoplay or not
Available values: 0 or 1
polling
Default value: 5
Description: Playlist synchronization update polling interval in seconds
Available values: Value between 1 and 60 seconds