Shaka Player

note

You can find a fully functional sample app on our GitHub page: https://github.com/Broadpeak-tv/smartlib-web-sample-app

1. Attach the player

When creating the player instance, attach it to the current session.

// Create your player
const video = document.getElementById('video');
const player = new shaka.Player(video);

// Attach your player to the current session
session.attachPlayer(player);

If you are using React/Angular, please attach once the Shaka.js library to SmartLib before attaching the player:

ShakaPlayerAdapter.attachLibrary(shaka);

2. Start a streaming session

All integrations

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.

info

This method has to be called even for non-Broadpeak content URLs. In this case, the method will return the same URL.

// Get the stream URL from SmartLib
session.getURL(contentURL)
    .then(result => {
        if (!result.isError()) {
            player.load(result.getURL())
                .then(() => {
                    // Stream is playing
                })
                .catch(error => {
                    // Stop the streaming session if there is a loading error.
                    // Get the BPK error code with session.playerAdapter.getErrorCode(error)
                    const bpkErrorCode = session.playerAdapter.getErrorCode(error);
                    session.playerAdapter.setPlayerErrorCode(error.code);
                    session.stopStreamingSession(bpkErrorCode);
                });
        } else {
            // Stop the session
            session.stopStreamingSession();

            // Process the loading error
        }
    });
});

Analytics only integration

In order to start the analytics session, start the playback on the player:

// Load a stream URL into Shaka Player
player.load(...)
    .then(() => {
        // Stream is playing
    })
    .catch(e => {
        // Error during loading, pass the error code to the session
        session.playerAdapter.setLoadingError(e);
    });

If you need to reuse the same player instance to start a new session, it is required to stop the playback before.

// Stop the current session
player.unload()
    .then(() => {
        // Start the new session
        session = SmartLib.getInstance().createAnalyticsSession();
        session.attachPlayer(player);
        return player.load(...);
    });

3. Stop a streaming session

All integrations

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.unload();

If the player generates a non-recoverable error during the playback (as a decoding error), call stopStreamingSession to stop the session.

player.addEventListener('error', onErrorEvent);

function onErrorEvent(error) {
    if (isNotRecoverableError(error)) {
        session.stopStreamingSession();
    }
}

Analytics only integration

The session report is sent when the player is stopped:

// Stop the session
player.unload();