Skip to main content

Getting started

🚧Documentation Under Construction

We are actively working to improve this documentation. The content you see here may be incomplete, subject to change, or may not fully reflect the current state of the feature. We appreciate your understanding as we continue to enhance our docs.

This guide covers installing the JW Player plugin and configuring your JW Player account credentials in Brightspot.

Installation​

Requirements
Requires Brightspot 4.8 or later.
<dependency>
    <groupId>com.brightspot.jwplayer</groupId>
    <artifactId>jwplayer</artifactId>
    <version>__HIDDEN__</version>
</dependency>

Prerequisites​

You need the following from your JW Player dashboard:

  • Client Secret — Found under Settings (gear icon) > API Credentials. You must use a v2 API credential.
  • Site ID (also called Property ID) — Found under Settings (gear icon) > Properties.
  • Player ID (optional but recommended) — Found under Players in the left navigation. Required for video preview in the CMS.

Configuration​

You can configure integrated search with JW Player at the Global level or the site level. Global configurations are inherited by all sites, and site-level configurations override Global configurations. This topic explains how to configure this integrated search at the Global level.

To configure integrated search with JW Player:

  1. In your JW Player console, obtain your client secret, site ID, player ID, and preview player ID. For details, see Authentication.

  2. Click > Admin > Sites & Settings.

  3. Select the site for which you want to configure JW Player.

  4. From the Integrations tab, expand the JW Player cluster.

  5. Under Settings, click Add and select Create New.

  6. In the Internal Name field, enter an internal name. Brightspot uses this name in selection fields.

  7. In the Client Secret, Site ID, Player ID, and Preview Player ID fields, enter the credentials from step 1.

  8. Expand Import, and make the following settings:

    • Ingestion Run Record—Read-only field displaying the times when the importer last checked for new videos in JW Player, and when the importer last ingested a video into Brightspot.
    • Import Enabled—Toggle on to import videos from your JW Player account that were not previously imported. If importing JW Player videos for the first time, toggle this field on.
    • Full Import Enabled—Toggle on to import all videos from your JW Player account, including videos that were previously imported. This field is ignored if the Import Enabled field is toggled off.
    • Import User—Brightspot records the selected user as the one who initiates the import from JW Player.

  9. Expand Miscellaneous, and toggle on Debug Enabled if you want to include informational messages in the Brightspot log.

  10. Click Save.

  11. Click Back.

  12. From the Settings list, select the integration you created.

  13. In the Global Import Frequency field, enter the interval in minutes at which Brightspot imports videos added to JW Player.

    Note

    Frequent imports keep your Brightspot video inventory up to date, but they may also cause an increase in resource load. The default frequency is every minute.

  14. Click Save.

When a user searches for JW Player videos, the plugin resolves available accounts based on the site context. If multiple accounts are configured, a dropdown filter appears in the search interface to select which account to search.