Media3
Media3 is the new home for ExoPlayer since its discontinuity as a standalone project. In SmartLib, it means supporting Exoplayer above version 2.19.0. For older ExoPlayer versions, see ExoPlayer integration guide
1. Attach the player
When creating the player instance, attach it to the current session.
// Create your player
ExoPlayer player = new ExoPlayer.Builder(this).build();
// Attach your player to the current session
session.attachPlayer(player);
2. Start a streaming session
- All integrations
- Analytics only integration
The getURL
method is used to get the actual streaming URL and start the streaming session. This method is also the starting point of the analytics calculation, for instance the startup time starts from this method.
The returned URL can be different for every video session. In case of using a Broadpeak CDN or a nanoCDN, it includes a unique token. It can be used only once per session object, once called the session is actually started.
When getURL
returns an error, it means no streaming URL can be found. It has to trigger a specific behaviour on the application (error message, dialog...) and stopStreamingSession
has to be called. Find more details about getURL
errors on the session errors page.
It is recommended to perform this call on a different thread than the main thread, the method runs HTTP requests.
This method has to be called even for non-Broadpeak content URLs. In this case, the method will return the same URL.
// Start the session and get the final stream URL
StreamingSessionResult result = session.getURL(...);
if (!result.isError()) {
// Load the stream URL into Exoplayer
MediaItem item = new MediaItem.Builder()
.setUri(Uri.parse(result.getURL()))
.build();
// Create the source
DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);
MediaSource source = new HlsMediaSource.Factory(dataSourceFactory) // If using HLS for instance
.createMediaSource(item);
source.addEventListener(yourHandler, (MediaSourceEventListener) session.getListener());
// Set the source
player.setMediaSource(source);
player.prepare();
// Play when ready
player.setPlayWhenReady(true);
} else {
// Stop the session
session.stopStreamingSession();
// Process the loading error
}
In order to start the analytics session, start the playback on the player:
// Load the stream URL into Exoplayer
MediaItem item = new MediaItem.Builder()
.setUri(Uri.parse(CONTENT_URL))
.build();
// Create the source
DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);
MediaSource source = new HlsMediaSource.Factory(dataSourceFactory) // If using HLS for instance
.createMediaSource(item);
source.addEventListener(yourHandler, (MediaSourceEventListener) session.getListener());
// Set the source
player.setMediaSource(source);
player.prepare();
// Play when ready
player.setPlayWhenReady(true);
3. Stop a streaming session
- All integrations
- Analytics only integration
The stopStreamingSession
method must be called each time the session is stopped:
- end users: when the playback is stopped by a user action
- loading errors: when the streaming session cannot be started through the
getURL
method - player errors: when the player triggers a non-recoverable error during the playback (as a decoding error)
- application or any others actions: when the app is killed
// Stop the session
session.stopStreamingSession();
player.stop();
If the player generates a non-recoverable error during the playback (as a decoding error), call stopStreamingSession
to stop the session.
player.addListener(new Player.Listener() {
@Override
public void onPlayerError(@NonNull PlaybackException error) {
if (isNonRecoverableError(error)) {
// Stop the session
session.stopStreamingSession();
}
}
});
The session report is sent when the player is stopped:
// Stop the session
player.stop(true);