@amazon-devices/kepler-epg-provider

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 Electronic Program Guide (EPG) API provides EPG functionality in React Native for Vega apps.

For detailed integration steps, see the Overview of EPG Integration.

API Reference

Classes

AddLiveEventFailure — Class object representing a AddLiveEventFailure.
BaseError — Parent class for errors.
ChannelDescriptor — Class object representing a ChannelDescriptor.
ChannelDescriptorBuilder — Builder that creates an instance of the ChannelDescriptor object.
ChannelInfoBuilder — Builder that creates an instance of the ChannelInfo object.
ChannelMetadataBuilder — Builder that creates an instance of the ChannelMetadata object.
EpgLineupInformation
ExternalIdBuilder — Builder that creates an instance of the ExternalId object.
IllegalStateError — Exception thrown when functions of a builder are called after it has already been used to build an object.
InternalError — Exception thrown when there is an internal error while attempting to perform an operation.
InvalidArgumentError — Exception thrown when there is a failure in creating a new object.
LiveEvent — Class object representation of LiveEvent object
LiveEventBuilder — Builder that creates an instance of the LiveEvent object.
PlaybackReferenceBuilder — Builder that creates an instance of the PlaybackReferenceBuilder object.
Program — Class object representation of Program object
ProgramBuilder — Builder that creates an instance of the Program object.
SeriesInfo — Class object representing a SeriesInfo, which provides
SeriesInfoBuilder — Builder that creates an instance of the SeriesInfo object.
StorageLimitError — Exception thrown when there is an error due to ingested data exceeding the storage limit.
UpsertProgramFailure — Class object representing a UpsertProgramFailure.

Interfaces

IAddLiveEventFailure — Interface for the AddLiveEventFailure class.
IChannelDescriptor — Interface for the ChannelDescriptor class.
IChannelInfo — Interface for the ChannelInfo class.
IChannelLineupProvider — The data provider object used for replacing the list of channels in the EPG.
IChannelMetadata — Interface for the ChannelMetadata class.
IExternalId — Interface for the ExternalId class.
ILiveEvent — Interface for the LiveEvent class.
ILiveEventProvider — The data provider object used for replacing the list of live events.
IPlaybackReference — Interface for the PlaybackReference class.
IProgram — Interface for the Program class.
IProgramLineupProvider — The data provider object used for adding programs to or clearing programs from the EPG.
IProgramLineupProvider2 — An updated interface for IProgramLineupProvider which supports partially successful commits and
ISeriesInfo — Interface for the SeriesInfo class, which provides
IUpsertProgramFailure — Interface for the UpsertProgramFailure class.

Enumerations

ChannelTypeEnum — An enum used to indicate the source of a channel.
EventType — An enum used to indicate the type of a live event.
PlaybackType — An enum used to indicate the type of a playback reference.

Last updated: Jul 22, 2026