​
Overview

BeyondWords Player is the easiest way to add BeyondWords audios into your website or app.

It is a fully-featured audio player for content generated and hosted on BeyondWords. It is fully integrated with analytics and monetization features on BeyondWords without the need for any extra configuration.

Please note that the BeyondWords player is automatically installed if you are using any of the following integrations:

  • Magic Embed
  • WordPress
  • Ghost

​
Installation

Choose one of the following methods to install the BeyondWords player:

​
Install via embed script

Add the script in your web app:

<script async defer src="https://proxy.beyondwords.io/npm/@beyondwords/player@latest/dist/umd.js"
    onload="new BeyondWords.Player({
        target: this,
        projectId: <ID>,
        contentId: '<ID>'
    })">
</script>

You’ll need to replace <ID> with your actual project ID and content ID. See the Identifiers section below for details on all available identifier options.

For production environments, consider specifying a fixed version instead of using @latest to ensure stability.

​
Install via NPM

1

Add the player NPM package

npm add @beyondwords/player
2

Add a target div in your web app

<div id='beyondwords-player'></div>
3

Initialize the player

import BeyondWords from '@beyondwords/player';

new BeyondWords.Player({ target: '#beyondwords-player', projectID: <ID>, contentId: '<ID>' });

You’ll need to replace <ID> with your actual project ID and content ID. See the Identifiers section below for details on all available identifier options.

​
Identifiers

You will need to replace project ID and content ID with your projectId and contentId. You can use any of the following properties in conjunction with the projectId to initialize the player:

PropertyDescription
contentIdUnique UUID string for the audio content.
You can also pass the previous integer audio ID as a string for users migrating from the legacy API.
sourceIdThe externally provided source identifier for a content item.
This could be the ID from your CMS, the <guid> from an RSS <item>, or the post ID if generated using the WordPress Plugin.
sourceUrlThe URL containing the source content.
This could be the public URL submitted via the API, the <link> from an RSS <item>, or the post URL from the WordPress Plugin.
playlistIdThe unique ID for a playlist created in the dashboard or through the API.

​
Advanced customization

For developers looking to build custom interfaces or use the player in headless mode, additional documentation is available on GitHub. This includes guides on:

  • Building your own UI on top of the BeyondWords player
  • Using the player SDK programmatically
  • Implementing custom analytics

For complete documentation on advanced customization options, visit the BeyondWords Player GitHub repository.

​
Next steps

After installing the player, you’ll likely want to customize its appearance and behavior to match your brand and user experience requirements.

Player settings

Configure your player’s appearance, branding, and interactive features

JavaScript SDK

Integrate the player in web applications

iOS SDK

Integrate the player in iOS applications

Android SDK

Add the player to Android applications

Previous
Settings
Next