@amazon-devices/kepler-player-client

​

Get started

​

Setup

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

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

2. Add following components and privileges in your manifest.toml.
   [[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"
   

​

Related topics

• Kepler Player Server API
• Kepler Headless Tasks and Services
• Implement Headless JavaScript Playback

​

API Reference

​

Classes

• PlayerClientFactory
• PlayerClientMediaControlHandler

​

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.