Skip to content

Latest commit

 

History

History
executable file
·
192 lines (135 loc) · 7.52 KB

README.md

File metadata and controls

executable file
·
192 lines (135 loc) · 7.52 KB
Raw

Playback SDK

Getting Started

Prerequisites

Before you begin, ensure you have the following prerequisites installed:

  • Android Studio
  • Kotlin

Installation

To integrate the PlaybackSDKManager into your Android application, follow these steps:

  1. Add a link to Jitpack and Bitmovin release repository to your application's settings.gradle.kts file:

    dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://artifacts.bitmovin.com/artifactory/public-releases")
        }
        maven {
            url = uri("https://jitpack.io")
        }
    }
}

  2. Add the following dependency to your app build.gradle.kts file:

    dependencies {
    ...
    implementation 'com.github.StreamAMG:playback-sdk-android:x.x.x'
    implementation 'com.bitmovin.player:player:x.x.x'
}
    • This is the latest version of the Playback SDK
    • You can check the latest Bitmovin player version HERE

  3. Add the following plugins on your project build.gradle.kts file:

    plugins {
    ...
    id("org.jetbrains.kotlin.jvm") version "1.9.0" apply false
    id("org.jetbrains.kotlin.plugin.serialization") version "1.8.10" apply true
}

  4. Sync your project to ensure the new dependency is downloaded and added to your project.

Installation from local path

If you want to debug and integrate Playback SDK from your local path, follow these steps:

  1. Add the path of the local SDK to your application's settings.gradle.kts file:

    include(":app")
include (":playback-sdk-android")
project(":playback-sdk-android").projectDir = File("../playback-sdk-android/playback-sdk-android")

    Change the File path based on your local SDK path

  2. Add the following dependency to your app build.gradle.kts file:

    dependencies {
    ...
    implementation(project(":playback-sdk-android"))
    implementation 'com.bitmovin.player:player:x.x.x'
}
    • You can check the latest Bitmovin player version HERE

  3. Add the following plugins on your project build.gradle.kts file:

    plugins {
    ...
    id("org.jetbrains.kotlin.jvm") version "1.9.0" apply false
    id("org.jetbrains.kotlin.plugin.serialization") version "1.8.10" apply true
}

  4. Sync your project to ensure the new dependency is downloaded and added to your project.

PlaybackSDKManager

The PlaybackSDKManager is a singleton object designed to manage the functionalities of the playback SDK. It provides methods for initialization, loading player UI, and loading HLS streams. This README provides documentation on how to get started with using the PlaybackSDKManager in your application.

Initialization

To initialize the playback SDK, use the initialize method of the PlaybackSDKManager singleton object. This method requires an API key for authentication. Optionally, you can specify a base URL for the playback API.

Example:

    // Initialize SDK with the settings
    PlaybackSDKManager.initialize("<API_KEY>") { license, error ->
        // Register default layer plugin 
        val customPlugin = BitmovinVideoPlayerPlugin()
        VideoPlayerPluginManager.registerPlugin(customPlugin)
    }

Loading Player UI

To load the player UI in your application, use the loadPlayer method of the PlaybackSDKManager singleton object. This method is a Composable function that you can use to load and render the player UI.

Example:

PlaybackSDKManager.loadPlayer(entryID, authorizationToken) { error -> 
    // Handle player UI error 
} 

Playing Access-Controlled Content

To play on-demand and live videos that require authorization, at some point before loading the player your app must call CloudPay to start session, passing the authorization token:

"$baseURL/sso/start?token=$authorizationToken"

Then the same token should be passed into the loadPlayer(entryID, authorizationToken, onError) method of PlaybackSDkManager. For the free videos that user should be able to watch without logging in, starting the session is not required and authorizationToken can be set to an empty string or null.

Note

If the user is authenticated, has enough access level to watch a video, the session was started and the same token was passed to the player but the videos still throw a 401 error, it might be related to these requests having different user-agent headers.

Configure user-agent

Sometimes a custom user-agent header is automatically set for the requests on Android when creating a token and starting a session. OkHttp and other 3rd party networking frameworks can modify this header to include information about themselves. In such cases they should either be configured to not modify the header, or the custom header should be passed to the player as well.

Example:

PlaybackSDKManager.initialize(
    apiKey = apiKey,
    baseUrl = baseUrl,
    userAgent = customUserAgent
) { error -> 
    // Handle player UI error 
} 

Playing Free Content

If you want to allow users to access free content or if you're implementing a guest mode, you can pass an empty string or null value as the authorizationToken parameter when calling the loadPlayer function. This will bypass the need for authentication, enabling unrestricted access to the specified content.

Error Handling

The PlaybackSDKManager provides error handling through sealed classes SDKError and PlaybackAPIError. These classes represent various errors that can occur during SDK and API operations respectively.

  • SDKError includes subclasses for initialization errors, missing license, and HLS stream loading errors.
  • PlaybackAPIError includes subclasses for initialization errors, network errors, and API errors.

Handle errors based on these classes to provide appropriate feedback to users.

Video Player Plugin Manager

Additionally, the package includes a singleton object VideoPlayerPluginManager for managing video player plugins. This object allows you to register, remove, and retrieve the currently selected video player plugin.

For further details on how to use the VideoPlayerPluginManager, refer to the inline documentation provided in the code.

Chromecasting

To use the Google Chromecast support, use the updateCastContext method of the PlaybackSDKManager singleton object, passing the context of the Activity otherwise the Casting will be disabled. Each Activity that uses Cast related API's has to call the following function before using any cast related API, e.g. in the Activity.onCreate function:

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        PlaybackSDKManager.updateCastContext(this)
        ...
    }

Resources