Skip to content

Storyteller Brightcove Module#

Introduction#

The Storyteller SDK supports Brightcove analytics as a separate module. This module is designed to work with the Brightcove to provide analytics for videos.

Legacy integration: Do not add this module to a new application. The Brightcove analytics artifact is not published on Maven Central and depends on legacy Storyteller distribution through CloudRepo or MyGet. Both repositories will be sunset with the SDK 12.0.0 release. Existing users can keep the dependency temporarily while migrating; contact Storyteller Support before adopting or changing this integration.

Setup#

Existing applications that already resolve the module from CloudRepo or MyGet can keep the dependency temporarily. Do not add either legacy repository to a new integration. The module must be initialized and included in Storyteller.modules.

Then add the following reference to your version catalog file:

storyteller-brightcove = { module = "com.storyteller.brightcove:analytics", version.ref = "1.2.0" }

And finally reference this in your build.gradle:

implementation(libs.storyteller.brigthcove) {
  exclude group: "Storyteller", module: "sdk"
}

The exclude removes the Brightcove module's legacy transitive SDK dependency. Keep your app's main Storyteller SDK dependency on the current com.getstoryteller:sdk coordinate.

To use the module Storyteller SDK version should be set to 10.6.3 or higher. Now initialize the module as follows:

val configuration = StorytellerBrightcoveModuleConfiguration(
  accountId = "your-account-id",
  playerName = "your-player-name",
  source = "your-source",
  destination = "your-destination-url",
)

val storytellerBrigthcoveModule = StorytellerBrightCoveModule(configuration)

fun initializeStoryteller() {
  Storyteller.modules = listOf(storytellerBrigthcoveModule)
  //initialize code
}

Showcase examples#