Overview
The Players service allows you to create customized HTML5 video player configurations with your own branding, colors, logos, and behavior settings. These players can be used with both live streams and video-on-demand content.Player Object
The Player object defines the appearance and behavior of the video player.Player ID
Player name for identification
Player framework type (e.g., video.js, clappr)
Video playback behavior:
true: Video starts playing automatically on loadfalse: User must click play (default)
Sound volume on load:
true: Video starts mutedfalse: Video starts with volume on (default)
Skin background color in format
#AAAAAASkin foreground color (UI elements) in format
#AAAAAAColor of elements when mouse hovers, in format
#AAAAAAText elements color in format
#AAAAAAURL to logo image displayed on player
Logo position on player:
tl: Top lefttr: Top rightbl: Bottom leftbr: Bottom right
Player skin visibility:
true: Skin is disabled (no controls visible)false: Skin is enabled (default)
Sharing button visibility:
true: Sharing button is displayed (default)false: No sharing button
Playback speed control button:
true: Speed control button is displayedfalse: No speed control (default)
Persist user settings:
true: Volume and options saved in cookies (default)false: Settings not saved
Custom CSS injected into player iframe
Additional JavaScript parameters rendered to player
Custom player JavaScript file URL. Leave empty to use default.
URL to custom skin JavaScript file
Create Player
Create a custom player configuration.player.go
Player name
Enable automatic playback. Default: false
Start with volume muted. Default: false
Background color (e.g.,
#1a1a1a)Foreground/UI elements color (e.g.,
#ff3366)Hover state color (e.g.,
#ff6699)Text color (e.g.,
#ffffff)Logo image URL
Logo position:
tl, tr, bl, brDisable player controls. Default: false
Show sharing button. Default: true
Show speed control button. Default: false
Save user preferences. Default: true
Custom CSS styles
Player framework type
Update Player
Update an existing player configuration.player.go
Get Player
Retrieve player configuration details.player.go
List Players
Retrieve a paginated list of all players.player.go
Delete Player
Delete a player configuration.player.go
Preview Player
Get an HTML preview of the player configuration.player.go
Player Templates
Dark Theme Player
player.go
Branded Corporate Player
player.go
Minimal Player (No Controls)
player.go
Auto-Play Muted Player (Mobile-Friendly)
player.go
Educational Player with Speed Control
player.go
Custom CSS Examples
Hide Specific Controls
player.go
Custom Branding Overlay
player.go
Using Players with Content
Assign Player to Broadcast
player.go
Assign Player to Video
Players can also be associated with individual videos (consult the Videos API for details).Best Practices
Color Selection
- Use high contrast between
bg_colorandtext_colorfor readability - Test
hover_colorto ensure visibility on both light and dark backgrounds - Follow your brand guidelines for consistency
Autoplay Considerations
- Mobile browsers often block autoplay with sound
- Use
autoplay: truewithmute: truefor reliable mobile autoplay - Consider user experience - not all users appreciate autoplay
Logo Placement
tr(top right) is most common for branding- Keep logos small to avoid obstructing content
- Use transparent PNG format for best results
Performance
- Minimize custom CSS complexity
- Test player on multiple devices and browsers
- Use
save_options_to_cookiesto remember user preferences
Accessibility
- Ensure sufficient color contrast (WCAG AA: 4.5:1 minimum)
- Don’t disable controls unless necessary
- Provide alternative access methods for key functions
