@amazon-devices/kepler-channel

The @amazon-devices/kepler-channel package provides functionality that allows React Native for Vega apps to handle channel tuning operations. This package supports channel changing and channel skipping functionality for TV applications built on Vega.

Get started

Setup

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

  "dependencies": {
    "@amazon-devices/kepler-channel": "~1.1.110",
  }

1. In your manifest.toml, add the following privileges required to access the Vega Channel fucntionality.

   Copy code Copied to clipboard.

    [components]
    ## Define your app's interactive component (if it doesn't already exist)
    [[components.interactive]]
    id = "<packageId>.main"
    runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
    launch-type = "singleton"
    categories = ["com.amazon.category.main", "com.amazon.category.kepler.media"]
   
    [[extras]]
    ## `interface.provider` designates a component 
    ## that provides implementation of certain interfaces
    key = "interface.provider"
    ## Declares the component that provides the implementation of the interfaces.
    ## This component must be defined under [[components.interactive]] and includes
    ## "com.amazon.category.kepler.media" in its categories.
    component-id="<packageId>.main"
   
    [extras.value.application]
    ## Declare support for Vega Channel
    [[extras.value.application.interface]]
    interface_name = "com.amazon.kepler.media.IChannelServer"
    features = ["ChannelList"]
   
    ## Hardcode ChannelList attribute to [] since we use Vega EPG Provider to provide channel data
    [extras.value.application.interface.static-values]
    ChannelList = []
   

   Details about the two categories added for the main interactive component:

   • com.amazon.category.main declares the component as the default interactive component for the app package.
   • com.amazon.category.kepler.media declares the component to be targeted for Vega Media operations.

Related topics

• Vega Channel Integration

API Reference

Classes

• ChangeChannelResponse
• InternalError — Error thrown when there is an internal error while attempting to perform an
• InvalidArgumentError — Error thrown when invalid arguments are passed.
• OperationError — Error thrown when the 'IChannelHandler' fails to handle Channel cluster

Interfaces

• IChangeChannelResponse — Interface for IChangeChannelResponse that is used for change channel commands.
• IChangeChannelResponseBuilder — Interface for ChannelResponseBuilder that is used to build a .
• IChannelHandler — Interface for the handler provided by channel cluster providers. It should handle channel
• IChannelServer — Interface for ChannelServer that provides the ability to set a handler for channel
• IChannelServer2 — Revision 2 of ChannelServer interface that provides the ability to set a
• IChannelServerComponent — Component that provides a channel cluster server instance.
• IChannelServerComponent2 — Revision 2 of the 'ChannelServerComponent' interface which provides a

Enumerations

• ChangeChannelStatus — An enum for the status of the response of the change channel command.

Last updated: Jul 22, 2026