Looking for integration code? See the Quick Start Guide for the basic integration pattern.
Visual & Controls
Autoplay Settings
Controls how videos start playing automatically. Available Options:- Autoplay enabled/disabled
- Custom autoplay video (different preview video)
- Autoplay time range (specific start/end times)
- Pulsating effects during autoplay
- Custom autoplay templates with HTML/CSS
- When enabled, videos may start playing immediately
playevent may fire automatically on page load- Continue watching takes precedence over autoplay for returning users
Thumbnail Images
Custom thumbnail images displayed when autoplay is disabled or video is paused. Available Options:- Landscape thumbnail (for desktop/wide screens)
- Portrait thumbnail (for mobile/narrow screens)
- Orientation-aware display (shows appropriate thumbnail based on video orientation)
- Draggable positioning with visual canvas editor
- Custom image uploads to BunnyCDN storage
- Navigate to the Thumbnail tab in video customization
- Upload separate images for landscape and portrait orientations
- Use the visual canvas editor to position thumbnails precisely
- Deploy changes to make thumbnails live
- Thumbnails display when
autoplayis disabled and video has not started - Automatically adapts to video orientation (landscape/portrait)
thumbnailoverlay can be triggered programmatically- Works seamlessly with continue watching and pause menu features
- Supports JPEG, PNG, GIF, and WebP formats (up to 10MB)
- Images are uploaded to workspace-specific CDN folders
- URLs are stored in
thumbnail_options.landscape_imageandthumbnail_options.portrait_image - Positioning data stored in overlay configuration for canvas editor
Style & Appearance
Customizes the visual appearance of the player. Available Options:- Main color (primary brand color)
- Background color (player background)
- Controls bar style (default vs. solid)
- Control visibility (show/hide individual controls)
- Center play button
- Corner play button
- Classic progress bar
- Video time display
- Rewind/forward buttons
- Fullscreen button
- Settings button (speed controls)
- Play in fullscreen (auto-fullscreen mode)
- Available controls affect which user interactions are possible
- Auto-fullscreen mode triggers
fullscreenevent immediately - Control visibility affects user experience and event frequency
Progress Bar
Customizes how video progress is displayed. Available Options:- Smart progress (non-linear progress display)
- Progress bar colors and styling
- Height and background customization
- Classic vs. modern progress bar styles
- Progress visualization affects user engagement
- Smart progress may show different completion percentages
- Custom styling does not affect
timeevent data
Functional Features
Continue Watching
Allows users to resume videos from where they left off. Configuration Options:- Enable/disable continue watching
- Minimum watch time threshold (how long before it is considered “watched”)
- Custom templates for continue watching overlay
- Continue/restart button styling and behavior
continue-watchingevent fires when overlay is shown- Minimum watch time determines when feature activates
- Only works for returning users who meet watch time threshold
Smart Orientation
Automatically detects and responds to video orientation. Configuration Options:- Enable/disable smart orientation
- Orientation-specific styling and behavior
- Automatic layout adjustments
portraitandlandscapeevents fire based on video dimensions- Affects responsive design requirements
- May trigger layout changes automatically
Captions & Overlays
Manages text overlays and paused state content. Configuration Options:- Caption display and styling
- Custom paused overlays with HTML/CSS
- Overlay positioning and timing
- Text styling and colors
- Custom overlays may affect user interactions
- Paused overlays can include interactive elements
- Overlay events may be available depending on configuration
Advanced Features
Turbo Mode
Optimizes video loading and playback performance. Configuration Options:- Enable/disable turbo mode
- Preloading strategies
- Bandwidth optimization
- May affect
metadataevent timing - Can influence video loading speed
- Affects user experience but not event data
Playback Controls
Fine-tunes video playback behavior. Configuration Options:- Default playback speed
- Available speed options
- Skip intervals (rewind/forward amounts)
- Playback shortcuts and hotkeys
- Speed changes affect playback timing
- Skip intervals affect user interaction patterns
- Shortcuts may trigger playback events
Event-Related Configuration
Timed Events
Custom events that fire at specific times. Configuration Impact:- Event names are completely custom
- Trigger timing can be time-based or percentage-based
- Call frequency affects how often events fire
- Subsequent visits may have different event names
- Event names must match your JavaScript listeners
- Timing precision depends on video playback
- Session-based events require proper handling
Conversion Pixels
Third-party tracking integration. Configuration Impact:- Pixel types determine event naming convention
- Trigger conditions affect when pixel events fire
- Session limits control firing frequency
- Custom pixels can execute arbitrary JavaScript
- Pixel events complement your existing tracking
- Event naming follows predictable patterns
- Session limits prevent pixel spam
User Event Tracking
Tracks user interactions with the page. Configuration Options:- Content engagement tracking (scroll, hover, click)
- Targeted elements only (data-trackplay attributes)
- Interaction sensitivity settings
- These interactions are tracked automatically
- Not available as player events (they are tracked separately)
- Use
data-trackplayattributes for targeted tracking
Configuration Dependencies
Some features interact with each other:Autoplay + Continue Watching
- Continue watching overrides autoplay for returning users
- Autoplay settings apply to first-time visitors
- Both features can be enabled simultaneously
Fullscreen + Style
- Fullscreen behavior depends on control visibility
- Auto-fullscreen mode requires fullscreen button to be enabled
- Style settings affect fullscreen appearance
Timed Events + Pixels
- Both can trigger at the same time points
- Pixels fire independently of timed events
- Session limits apply to both separately
User Tracking + Targeted Elements
- When targeted elements is enabled, only
data-trackplayelements are tracked - General content engagement tracking is disabled
- Affects what interactions are monitored
Best Practices for Integration
Handle Configuration Variations
Your integration should work regardless of configuration:Test Different Scenarios
- Test with different control configurations
- Verify behavior with autoplay enabled/disabled
- Check continue watching with various minimum watch times
- Test fullscreen behavior with different style settings
Responsive Design
- Handle both portrait and landscape orientations
- Prepare for auto-fullscreen mode
- Design for different control bar styles
- Consider various progress bar configurations
Related Documentation
Timed CTAs and pixels
Reveal the buy button at the exact second. Fire your pixel at 75% watched.
Player themes
Five conversion themes, each a different layout.
Video events
Core playback events.
User events
Interface interaction events.
