KeplerPlayerServerTurboModule

The Kepler Player Server API provides server-side headless JavaScript media playback functionality for media app developers on the Kepler platform. 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

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

   Copy code Copied to clipboard.

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

2. Add following components and privileges in your manifest.toml.

   Copy code 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"
   

Enumerations

• IPlayerSessionState
• IUnloadSyncStatus

Classes

• InvalidArgumentError
• PlayerSessionError

Interfaces

• IHttpHeader
• IMediaLocator
• IOobTextTrackInfo
• IPlayerServer
• IPlayerServerFactory
• IPlayerServerHandler
• IPlayerSessionError
• IPlayerSessionId
• IPlayerSessionLoadParams
• IPlayerSessionMediaInfo
• IPlayerSessionPosition
• IPlayerSessionStatus
• ISubscription
• ITimeRange
• ITrackInfo
• IViewHandle

Type Aliases

• ITextTrackKind
• ITextTrackMode
• ITrackType

---

Last updated: Oct 02, 2025