MediaMelon Android Media3 v1.1.1 SDK Integration Document
This guide provides detailed instructions on integrating the Android MediaMelon SDK with Media3 v1.1.1 player
Step 1: Prerequisites
Step 2: Set up the build environment
Step 3: Import Packages
Step 4: Register and Initialise SDK
Step 5: Report Ended State
Step 6: Variables and Description
Step 1: Prerequisites
Meida3 - v1.1.1 sample application.
MediaMelon SmartSight SDK Maven dependencies or the provided
smartstreaming_release.aar
AAR file is necessary.
Step 2: Set up the build environment
$MEDIA3PROJECT = {Media3 - v1.1.1}
The SDK files should be added to the build environment and the required network permissions should be enabled.
Using Maven:
Add MediaMelon Maven dependency to
$MEDIA3PROJECT/demos/main/build.gradle
Using AAR:
Copy
smartstreaming-release.aar
provided in the release package to the Media3 project. Example$MEDIA3PROJECT/demos/main/smartstreaming-release.aar
Add the following library to
$MEDIA3PROJECT/demos/main/build.gradle
:-
Add network permissions to $MEDIA3PROJECT/demos/main/src/main/AndroidManifest.xml
Step 3: Import Packages
$MEDIA3PROJECT/demos/main/src/main/java/androidx/media3/demo/main/PlayerActivity.java
Step 4: Register and Initialise SDK
The player application must register the SDK and provide player information once after player is initialised. Please note that values provided in this integration step persist across video sessions.
The SDK must be initialised at the start of each video session. Initialisation includes setting the application context, initialising the playback session, and indicating the intent for playback with the SDK.
The enableLogTrace()
feature should be enabled for testing during the integration process. Set this to False before releasing the player to production.
CUSTOMER_ID is your MediaMelon assigned Customer ID. If you do not know your Customer ID contact MediaMelon at customer-support@mediamelon.com.
Step 5: Report Ended State
In $MEDIA3PROJECT/demos/main/src/main/java/androidx/media3/demo/main/PlayerActivity.java
Step 6: Variables and Description
Variable | Description | Optional/Mandatory |
PLAYER_NAME | String containing the Player Name. | Mandatory |
CUSTOMER_ID | String containing your MediaMelon-assigned Customer ID. | Mandatory |
SUBSCRIBER_ID | String containing your Subscriber’s ID. | Mandatory |
DOMAIN_NAME | String containing your section of your subscriber or assets. | Mandatory |
SUBSCRIBER_TYPE | String containing the Subscriber Type (e.g. “Free”, “Paid”). | Optional |
SUBSCRIBER_TAG | String containing an additional subscriber-specific information. This is sent in clear (not hashed) to SmartSight and it is advised to not send sensitive information in this field. | Optional |
ASSET_ID | String containing Asset Id. | Mandatory |
ASSET_NAME | String containing Asset Name. | Mandatory |
VIDEO_ID | String containing your video’s ID. | Mandatory |
CONTENT_TYPE | String containing type of the Content. For example - "Movie", "Special", "Clip", "Scene" "Episode". | Mandatory |
GENRE | String containing Genre of the content. For example - "Comedy", "Horror". | Optional |
DRM_PROTECTION | Widevine, Fairplay, Playready etc. Unknown means content is protected, but protection type is unknown. For clear contents, do not set this field | Optional |
EPISODE_NUMBER | String containing sequence number of the Episode. | Optional |
SEASON | String containing the Season. For example - "Season1". | Optional |
SERIES_TITLE | String containing Title of the Series. | Optional |
VIDEO_TYPE | String containing Video Type. For example - "LIVE", "VOD". | Optional |
PLAYER_BRAND | String containing Player Brand (e.g. “Exo Player”). | Mandatory |
PLAYER_MODEL | String containing Player Model. For example - This could be a variant of player. Say name of third party player used by organisation. Or any human readable name of the player. | Mandatory |
PLAYER_VERSION | String containing Player Version. | Mandatory |
CUSTOM_METADATA | Extra custom metadata can be added here if required. | Optional |
| To hash the subscriber Id set this boolean variable to | Optional |
| Player Object. | Mandatory |
| Current playing content stream URL. | Mandatory |
| Set this boolean variable to | Optional |
Last updated