Settings

Learn about the various BeyondWords Player configuration settings and how to adjust them to your preferences.

You can configure the BeyondWords Player settings through the dashboard, API, embed script, or SDK.

Updates to the player settings through the dashboard and API may take a few minutes to be reflected due to caching.

Use the dashboard

You can customize the BeyondWords Player settings through the dashboard by going to the Player section in your project, clicking on the Settings tab, adjusting the various settings to your preferences, and then pressing Save changes.

Use the API

You can customize the BeyondWords Player settings through the API by using the player settings endpoint in the API.

Use the embed script

You can customize the BeyondWords Player settings through the embed script by setting them similarly to how you set the projectId and contentId in the onload attribute. For instance, to replace the default "Listen to this article" call to action, specify callToAction: "Listen to this blog" in the embed script.

Use the SDK

You can customize the BeyondWords Player settings through the SDK, after the player has loaded, it can be controlled programmatically and its state can be queried.

The return value of the new BeyondWords.Player(...) call is a player instance:

const player = new BeyondWords.Player(...);

This instance can be used to set the call-to-action. For example:

player.callToAction = "Listen to this blog"

The player is reactive and will immediately update with these changes.