@amazon-devices/kepler-player-client

Open Beta Documentation Amazon offers this technical documentation as part of a pre-release, open beta. The features described might change as Amazon receives feedback and iterates on the features. For the most current feature information, see the Release Notes.

The Vega Player Client API provides client-side headless JavaScript media playback functionality for media app developers on Vega. This runs media playback on a separate JavaScript thread from the UI, providing up to 30% improvement in Time to First Video Frame (TTFVF) for apps with complex UIs.

Get started

Setup

Add the following library dependency to the dependencies section of your package.json file.

Copied to clipboard.

 "@amazon-devices/headless-task-manager": "~1.2.4",
 "@amazon-devices/kepler-player-server": "~2.2.14",
 "@amazon-devices/kepler-player-client": "~2.2.14",

Add following components and privileges in your manifest.toml.

Copied to clipboard.

 [[components.interactive]]
 id = "<your-app-package-name>.main"
 runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0" 
 launch-type = "singleton"
 categories = ["com.amazon.category.main"]

 [[components.service]]
 id = "<your-app-package-name>.service"
 runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
 launch-type = "singleton"
 .
 .
 .

 [processes]
 # Ensure that the player UI and headless JS player components are in the same process group
 [[processes.group]]
 component-ids = ["<your-app-package-name>.main", "<your-app-package-name>.service"]

 .
 .
 .

 [wants]

 [[wants.service]]
 id = "<your-app-package-name>.service"

 .
 .
 .

 [offers]

 [[offers.service]]
 id = "<your-app-package-name>.service"

API Reference

Classes

Interfaces

IPlayerClient — An interface that represents a PlayerClient.
IPlayerClientFactory — Component that provides a Kepler player client instance.
IPlayerSessionBufferedRangesListener — All these listeners must be implemented in class or component extending
IPlayerSessionErrorListener — Listener to receive player session track updates.
IPlayerSessionMessageListener — Listener to receive player session track updates.
IPlayerSessionPositionListener — Listener to receive player session position updates.
IPlayerSessionStatusListener — Listener for receiving player session status updates.
IPlayerSessionTrackListener — Listener to receive player session track updates.