W3C Media integration with Vega Media Controls

Vega Media Controls (KMC) provides functionality that allows media app developers on Vega to streamline the integration of various input modalities for media control. While media apps typically feature in-app user interface controls, such as play, pause, and stop, customers often want additional interaction methods such as remote control or voice commands through services such as Alexa. Vega Media Controls functionality handles the integration of these diverse input methods, allowing developers to focus on the core business logic of smooth media playback. Apps that use the W3C Media API to play their content can now get the KMC integration for free for basic playback controls such as pause, play, and seek. The W3C Media API internally creates the KMC server, publishes the server states, and handles basic commands of play, pause, and seek. To opt-in to this integration:

Enable KMC. Add the necessary manifest entries to your manifest.toml file as described in Get started with Vega Media Controls Overview.
Update your package.json file to take a dependency on @amazon-devices/kepler-media-controls.

Get the component instance of the interactive component:

import { useComponentInstance , IComponentInstance } from '@amazon-devices/react-native-kepler';

const componentInstance: IComponentInstance = useComponentInstance();

Before initializing the video player set the media control focus on the player instance. player.setMediaControlFocus(componentInstance);

Now, this player instance will be enabled with KMC and will support basic functionality of pause/play and seek remote control and Alexa voice controls. Override certain control commands In some cases, the app might want to override the handling of certain control commands that is handled by W3C Media by default. For example, disable seek during live content playback. W3C media also provides a way to achieve this.

Extend KeplerMediaControlHandler provided by W3C media and override the function that the application wants to override.

import {KeplerMediaControlHandler} from "@amazon-devices/react-native-w3cmedia";
import {IMediaSessionId } from '@amazon-devices/kepler-media-controls';

class AppOverrideMediaControlHandler extends KeplerMediaControlHandler {
    async handlePlay(mediaSessionId?: IMediaSessionId) {
        if(shouldOverride) {
            // do custom handling as per app's requirement
        } else {
            // call default handler
            super.handlePlay(mediaSessionId);
        }
    }
};

Pass the app’s media control handler as the second parameter to the setMediaControlFocus method.
player.setMediaControlFocus(componentInstance, new AppOverrideMediaControlHandler());

Vega Media Controls API reference

​Related topics

Related topics