Vimeo

The Vimeo integration provides access to the videos you manage through Vimeo. When you identify a video to use, you import it into Brightspot and then add it to assets such as articles and galleries.

For a wireframe example of what this content type can look like on your site, see Vimeo design.

This section describes how to configure the integration in Brightspot and in your Vimeo console.

The integration requires a Vimeo account. See vimeo.com.

Including Vimeo in a build

The following table lists the dependencies to include in your build configuration.

Artifact	Description
com.psddev:vimeo	Exposes the external type VimeoVideo and fields in Edit Site to configure and run integrated search with Vimeo.

Runtime prerequisites

• Developer configuration—

  • Extend ExternalItemConverter to import a VimeoVideo as a Brightspot Video.
  • Extend VideoProvider for Vimeo videos.
  • Deploy a view model to deliver the Vimeo player on the front end.

• Ops configuration—Generate an API key in the Vimeo console. For details, see Register your app.

• CMS configuration—Configure the site interfacing with Vimeo. For details, see Configuration.

Configuration

You can configure integrated search with Vimeo only at the Global level, and individual sites inherit that configuration.

To configure integrated searches with Vimeo:

1. In your Vimeo console, obtain your client ID and client secret. For details, see Make your first Vimeo API call.
2. Go to the global settings.
3. From the Integrations tab, expand the Vimeo cluster.
4. In the Client ID and Client Secret fields, paste the values from step 1.
5. In the Number of Videos to Load Each Request field, enter the number of videos Brightspot retrieves for each search.
6. Click Save.

Importing a Vimeo video

Use the following procedure to search for and use a video from Vimeo.

To search for and use a Vimeo video:

1. Open the search panel.

2. Set the content types filter to Vimeo Video.

   Note

   The external type Video (Vimeo) is not the same as Vimeo Video. If Vimeo Video is not available as an external type, the integration with Vimeo is not configured. See Configuration

   

3. Add other filters or search text. For additional information, see Search filters. Brightspot lists any matching videos.

4. Click on the video.

5. In the content edit form, click Import.

   

Brightspot imports the video's metadata and displays it in a content edit form. You can modify the title, description, or other metadata, and then use the video in an asset.

For additional information about importing external assets, see Importing external videos.

See also:

• Performing integrated searches in Brightspot

Uploading Vimeo videos individually

This topic discusses how to upload Vimeo videos to Brightspot.

Note

You must have the Vimeo integration configured to enable this type of video upload. See Configuration for more information.

tip

Before beginning these steps, in your Vimeo console, obtain the URL or ID of the video you want to upload to Brightspot.

To upload a video from Vimeo:

1. In the header, click .
2. From the Create list, select Video (Vimeo URL).
3. Using the following table as a reference, complete the fields as needed.
4. Complete your site's workflow and publish the video.

After you save your video, you can use it in assets such as articles and playlists. You can also add videos to text you compose in the rich-text editor.

Main

Field	Description
Vimeo URL or ID	Enter the URL or ID of the Vimeo video you want to upload.
Title	Enter a title. When you add the video to another asset, the title is visible to visitors to your site.
Internal Name	Enter an internal name for this asset. Brightspot uses this name internally, such as in the search panel and recent activity widget. This name is not visible to visitors to your site.
Description	Enter a description. This description is not visible to visitors to your site.
Preview	A preview of the Vimeo video you are uploading.
Thumbnail Image	Click and select an image. This image is not visible to visitors to your site; it appears in Brightspot widgets, such as the search panel. (If you don't select a thumbnail image, Brightspot uses the video's first frame as the thumbnail.)
Default Mute	Select Enabled to have the video muted by default.
Default Autoplay	Select Enabled to have the video play automatically when the page is visited.
Tags	Select the tags associated with this asset. This selection is not visible to visitors to your site. For information about creating a tag, see Tag.

Metadata

Field	Description
Duration	Updates with the duration of the uploaded video file.
Aspect Ratio	Updates with the aspect ratio of the uploaded video file.
Dimensions	Updates with the dimensions of the uploaded video file.

Companion Content

Companion content is an asset associated with a video or audio. Brightspot cues the visitor to view the companion content at a specific time during the media's playback.

Cues for companion content appear differently depending on your version of Brightspot. For example, they can appear in a right or left rail, “fly in” during the media’s playback, or as markers in the progress bar.

To create companion content:

1. Click Add Timed Companion.
2. In the Companion field, click .
3. Search for and select the companion content.
4. In the Timestamp field for each entry, enter the time stamp in hh:mm:ss format at which the cue appears.