Configuring the Settings for an In-Page Experience

Product(s)
Gallery
Role(s)
Studio User
Task(s)
Create an In-Page Experience

In this topic you will learn how to customize the settings for an in-page experience.

The settings control various aspects of an in-page experience. The following settings are available:

Note: After making any changes to an experience, make sure you republish the experience so the changes appear on sites that display the experience.

Configuring player settings

The player settings control the player that is used and the player behavior for the experience. To configure the player settings, edit the experience and then click SETTINGS > Player in the left navigation.

Selecting a player

To select a player to use for the in-page experience, select a player from the Available Players dropdown list. The list will display all the players in your Video Cloud account.

After you select a player, the player preview will display a preview of the selected player.

Note: When using an in-page experience, player styling is only reflected while a video is playing. Player styling will not be seen in the BEFORE PLAY or AFTER PLAY states.

Setting player behavior

Player settings can be configured to customize the player behavior. The following settings are available:

  • When video playback is complete determines what happens when a video finishes playing:
    • Display "After Playing" state for the experience - When selected, the experience will enter the AFTER PLAY state when a video completes.
    • Remain on current video - When selected, the experience will stay in the PLAYING state when a video completes. Select this option to display the custom endscreen (configured in the Players module) that is configured for the player. Components displayed during the PLAYING state will also remain visible. This option has the side effect of effectively removing the AFTER PLAY state from the experience.
  • Enable inline playback on iOS devices - If checked, enables inline playback on iOS devices when using Brightcove Player version 5.10.5 or newer.
  • Advance to next video automatically - If checked, the next video in the experience will be played when the current video finishes playing. This setting also determines whether to display a countdown timer in the AFTER PLAY state. If it is enabled, there will be a timer. When the timer reaches zero, the experience will transition to the PLAYING state of the next video.

Working with IP restricted accounts

IP restricted accounts outside of North America require modification of the Playback API base_url in the player. In-Page experiences will copy this base_url from the player when the experience is created and when a player is selected for the experience. If the base_url on a player for an existing experience is changed, Gallery will not automatically update this value since we don't know that it changed. As a workaround, publishers should follow these steps as a workaround:

  1. Go to the Player Settings page for the experience.
  2. Select a different player than the one that's currently selected.
  3. Re-select the initial player.
  4. Save and then publish the experience.

This will update the base_url for the experience to match that of the initial player.

When done, click Save to save the changes.

Configuring video settings

The video settings control some of the video display options and control whether the video can be downloaded. These settings only apply when the video is in the PLAYING state. To configure the video settings, edit the experience and then click SETTINGS > Video in the left navigation.

Related Link

If checked, the related link for the video will appear with the video info. The related link is configured as part of the video properties in the Media module.

Description

If checked, the long description for the video will appear instead of the short description with the video info. The short and long descriptions are configured as part of the video properties in the Media module.

Watched Indicator

If checked, a watched indicator () will appear on videos which have been watched during a user's session.

Note: The watched indicator will be styled using the OVERLAY BANNER properties in the STYLE menu.

Downloads

In-page experiences can be configured so viewers can download videos. The download link allows the viewer to download the highest quality rendition. Select a download option:

  • Do not allow video downloads
  • Provide a download link for each video
  • Provide a download link for each video based upon a custom field value - Define a custom field and then set that field to true for any video that can be downloaded. For complete steps on configuring a download link for each video, see Configuring Video Downloads for an In-Page Experience.

When done, click Save to save the changes.

Configuring social settings

The social settings control the social sharing options that are available when videos are playing. Social sharing icons appear above the player when the experience is in the PLAYING state. When a video is shared to a social media site, a link or image will appear directing the viewer back to the experience.

Gallery uses a social media metadata proxy service. This service is used whenever a video or event is shared out from an In-Page experience, and is part of the URL which is shared. It will redirect viewers to the page on which the In-Page experience is embedded, however, crawlers will see metadata about the video/event instead. In this way, social media crawlers will get information about the video/event which is being shared and can present more relevant information to the end-user on the social media site, while end-users are still able to access the original page.

To configure the social settings, edit the experience and then click SETTINGS > Social in the left navigation.

Note: The social settings can also be configured when editing the experience in the LAYOUT state by clicking on the Configure sharing link.

Display

The Display setting determines how the social icons are displayed. When the Share option () is selected, the sharing icons will slide in from the right side of the player.

When the social icons option () is selected, the social icons will appear above the player.

 

Sharing Options

Select the social sharing options to display. Some platforms offer the ability to enter a custom message. Click on the social platform name to enter a custom message. Click on a link to use the video URL, name or short description values in the message.

Click on the social platform name again to hide the custom message settings.

Social Metadata for Shared Links

Enter the Page URL of the page where the experience is embedded and then click Generate. This will allow social sites to display the thumbnail image, title, and description of the first video when viewers share your experience.

Accessing SEO settings

The SEO settings allow you to generate a site map and search feed for the in-page experience. To access the SEO settings, edit the experience and then click SETTINGS > SEO in the left navigation.

To generate a site map and/or search feed, follow these steps:

  1. Enter the Page URL. This is the URL of the site where the in-page experience will be published.
  2. Check whether video tags should be included.
  3. Click Generate.

The site map code should be copied into your existing site map to index the in-page experience information.

To configure the Search Engine Optimization settings for a portal experience, edit the experience and click SITE CONFIGURATION > Search Engine Optimization in the left navigation. The following settings are available:

  • Site Details - Configure the site image, keywords and meta tags
  • Site Map - Access the site map and search feed URLs

Configuring the site details

The Site Details settings can be configured to control how the portal is indexed by search engines. To access the Search Engine Optimization settings, edit the experience and click SITE CONFIGURATION > Search Engine Optimization in the left navigation.

The following settings can be configured:

  • Use site description in search engine results and when site is shared - When checked, will use the site description in the <meta> description tags, including the Facebook and Twitter meta tags. If not checked, the description for the featured video is used.
  • Site Image - This is the image that will be shown when the home page of a portal site is shared on Facebook or Twitter.
  • Keywords - Meta keywords that will be added to all site pages. Adding "birds,animals,fish, animal world" will result in the following being added to the page HTML:
    <meta name="keywords" content="birds,animals,fish,animal world">
  • Meta Tags - Used to add additional meta tags for the site. These tags will be added to all site pages. Example:
    <meta name="myCustomTag" content="myCustomValue">
  • Include custom video fields in page metadata - When checked, will add custom fields as meta tags. For example, a custom field of year with a value of 2018 will add:
    <meta name="year" content="2018">
  • Include canonical URL in page metadata - When checked, will add a rel=canonical meta tag in the source which helps improve SEO. This is a feature that tells Google to treat all the pages with the same rel=canonical link as a single entry. For example, mysite.com/video/mypage.html is the same as mysite.com/video/mypage.html?username=foobar.
  • Remove video titles from their URLs - When checked, the video name will not be included as part of the URL to the video detail page, just the video ID will be in the URL.

Viewing the site map & search feed

The Site Map settings display the URLs for the site map and search feed. The site map can be downloaded and submitted to search engines. The search feed can be used by most search engine software as a way to add Gallery content to search results. To access the Search Engine Optimization settings, edit the experience and click SITE CONFIGURATION > Search Engine Optimization in the left navigation.

To include the video tags in the site map, check the Include video tags in site map option. Note that only the first 32 tags are included. Adding tags to the site map exposes them to search engine web crawlers allowing visitors to find videos based on the video tags.

Note: These URLs will not be available until the site is published.

Site maps are cached for 24 hours. After 24 hours, they are removed from the cache and will be re-generated when they are accessed again. If videos are added to a portal experience, they will not be included in the site map until the site map is re-generated (after 24 hours) or until the site is republished.

For more information on building submitting a sitemap, see the Google documentation.

 

Configuring tracking

The tracking setting can be used to send tracking data to Google Analytics. To configure the tracking setting, edit the experience and then click SETTINGS > Tracking in the left navigation.

By providing a Google Analytics Tracking ID in the Tracking page, events occurring on the experience will be submitted to a Google Analytics account. Each event has a category in the form of Brightcove Experience {name} - {state} where {name} is the name of the experience, and {state} is the current playback state of the component (before, during, after). Each event may also have a relevant label, which is usually the ID of the video on which the event occurs. The following events are currently tracked (more will be added in the future as needed):

Action Description
Featured Video Clicked The featured video was clicked
Video Clicked A video was clicked
Watched Video Clicked The watched video was clicked
Next Video Clicked The next video was clicked
Replay Clicked The “Replay” button was clicked
Auto-Advance Stop The next video countdown was stopped / canceled
Auto-Advance Countdown Elapsed, Playing Next Video The next video countdown timer elapsed, so the next video is being played
Back Button Clicked The “Back” button was clicked
Share Panel Opened The Share panel was opened
Share Panel Closed The Share panel was closed
Share to {platform} Clicked The share link to the specified platform (Facebook, Twitter, etc.) was clicked
 

Note: To learn more about Google Analytics and to create a Tracking ID for your site, visit the Google Analytics website.

When done, click Save to save the changes.

Configuring advanced settings

The advanced settings can be used to enter custom JavaScript or to configure a video link query parameter. To configure the custom settings, edit the experience and then click SETTINGS > Advanced in the left navigation.

JavaScript

Enter the URL of a custom JavaScript file or paste in your custom JavaScript.