The YouTube video handler extension pauses embedded YouTube videos automatically when a visitor moves between campaign pages or closes the campaign. This article covers what the extension does, how to turn it on, and what to check if a video keeps playing when it shouldn't.
What you'll learn
- What the YouTube video handler extension does, and what it doesn't do
- How to turn on the extension using Campaign Metadata and the Extensions menu
- How to embed your YouTube video correctly, and how to troubleshoot a video that won't pause
Note: If this is your first time embedding a YouTube video in a Digioh campaign, review How to Add a YouTube Video to a Digioh Campaign first.
What it does
The YouTube video handler extension pauses embedded YouTube videos inside a campaign. Use it when your campaign includes a YouTube video, and you want Digioh to stop playback automatically, without any extra clicks from your visitor.
Here's what it does:
- Detects whether your campaign includes a YouTube video.
- Pauses the video when a visitor moves between campaign pages.
- Pauses the video when the campaign closes. The video is paused, not removed, and it resumes from the same spot if the campaign reopens.
Note: This extension only controls the first YouTube video on each campaign page. If a page contains more than one YouTube video, only the first one will be paused. Use one YouTube video per page to make sure every video is covered.
How to enable this extension
To activate this extension for your campaign, follow these steps:
- Navigate to your profile dropdown > extensions.
- Go to Campaign User Interface and install the Stop or Remove YouTube Videos extension.
- Click Publish > Publish to Your Site.
- Go back to your campaign editor and go to Settings > Campaign Settings > Campaign Metadata and toggle it on.
- Add the following Campaign Metadata:
- Key: youtube_videos
- Value: true
- And that's it! Make sure to publish your campaign for these changes to go live.
Important: The value must be the exact lowercase string true. Values like True, 1, or yes will not turn on the extension.
Best practices and troubleshooting
Your YouTube video must be embedded using an iframe in the format:
https://www.youtube.com/embed/...Your iframe URL must also include the
enablejsapi=1parameter, for example:
(e.g.,https://www.youtube.com/embed/VIDEO_ID?enablejsapi=1)
Note: If enablejsapi=1 is missing from your embed URL, the extension can't pause the video. The video will keep playing when a visitor changes pages or closes the campaign, and there's no visible warning to your site visitors. If a video isn't pausing as expected, check your iframe's src for this parameter first.
Only the first YouTube video on each campaign page is paused. Use one YouTube video per page for full coverage.
That's it, your campaign is set up to pause YouTube videos automatically. Need a hand? Reach out to support@digioh.com.
Want to get more from Digioh?
Get the playbooks leading brands use to convert more visitors into revenue.
Browse the Playbooks ?Platform Tour
See what else you can do with Digioh in our self-guided platform tour.
Take the Tour ?