Android SDK Migration guide

This guide is intended to help you migrate from the legacy native SDK to our new Android SDK.

Overview

Implementation resources

• Getting started with the Android SDK
• SDK Reference
• Dependencies

Benefits

Key benefits of the new Android SDK:

• More customization: The new Android SDK offers more customization options and greater flexibility in managing Player configurations via the Studio. Embedding and controlling your Players is easier and more efficient thanks to Player IDs.
• Better monetization: The new SDK complies with Google IMA standards and TCF2 to help you handle monetization more effectively
• Improved developer experience: The new SDK provides an easier way to embed and control custom Players, and simplified access to various data

Integration principles

Find the key technical steps required to implement our new Android SDK the best way and benefit from improved functionalities and flexibility compared to the legacy one.

Player customization

While the legacy SDK could only offer limited customization options and control, the new SDK is built around Player IDs. They carry your Player configuration, providing more flexibility and control over the Player’s behavior and appearance without requiring heavy customization within your code:

• Manage from Studio: You can easily create and manage custom Player configurations from the Dailymotion Studio
• Embed Player IDs: Each Player configuration is linked to a unique Player ID which is required for Player initialization in your Android app, and accurate monetization, targeting and attribution
• Optimize with API: Additional customization can be added programmatically using the Player methods, events and state

Learn more about how to create and manage Players from the Studio.

Advertising dependencies

The IMA SDK is already integrated into the new SDK, however, it requires declaring additional dependencies to load the IMA libraries.

Those additional dependencies can be found in Android IMA SDK integration guide.

Fullscreen management

The new Android SDK provides an out-of-the-box fullscreen implementation as well as a custom fullscreen implementation supporting navigation stack using either Android standard FragmentManager or Android Jetpack Navigation library.

See how to implement fullscreen with the new SDK.

Destroy/release Player

The Player instance can be automatically destroyed by the Android system’s garbage collector or manually destroyed using the destroy() method.

See how to destroy the Player.

TCF2 consent management

The Android SDK complies with IAB TCF2 standards to manage user consent using a recognized CMP. The Player will automatically attempt to access consent strings stored in the CMP.

See how to implement TCF2.

Mapping

This section provides a mapping of the methods, events and state from the legacy SDK to the new Android SDK to help you update your integration.

Methods

Find the complete list of methods for the new Android SDK.

Events

Find the complete list of events for the new Android SDK.

Player state and properties

Legacy SDK

The legacy SDK provided limited access to Player properties: it required specific events to be triggered to be able to retrieve associated Player properties.

dailyMotionVideoPlayer.setEventListener { event ->
    when (event) {
        is ApiReadyEvent -> ...
        is StartEvent -> ...
        is ProgressEvent -> ...
        is DurationChangeEvent -> ...
        /* And many more event */
        else -> {
            /* In case a POJO is not available you can directly access the raw data */
            if (event.name == "_generic_") {
                /* Do some stuff for my event: parse the raw date to extract the event name or values */
                Log.d("Event with payload: ${event.payload}")
            }
        }
    }
}

New SDK

The new Android SDK provides more data with easier access: any value within the Player state can be retrieved at any time using the method getState(callback: PlayerStateCallback), without having to rely on specific events.

To retrieve the Player state, simply pass an object implementing PlayerView.PlayerStateCallback to PlayerView#queryPlayerState(...)method.

playerView.queryPlayerState(object: PlayerView.PlayerStateCallback {
    fun onPlayerStateReceived(playerView: PlayerView, playerState: PlayerEvent.PlayerState)
        // Use playerState
    }
)

See full list of available state properties.