@amazon-devices/kepler-media-controls

​

Get started

​

Setup

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

    "@amazon-devices/kepler-media-controls": "~1.0.25",
    "@amazon-devices/kepler-media-types": "~1.0.0"

2. Add following components and privileges in your manifest.toml.
   [package]
   title = "<Your app title>"
   id = "com.amazondeveloper.media.sample"
   
   [components]
   [[components.interactive]]
   id = "com.amazondeveloper.media.sample.main"
   launch-type = "singleton"
   # The category "com.amazon.category.kepler.media" is only necessary for the primary component, which is identified in the extras 
   # section of the manifest using the "interface.provider" key.
   categories = ["com.amazon.category.kepler.media"]
   runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
   
   [[extras]]
   key = "interface.provider"
   component-id = "com.amazondeveloper.media.sample.main"
   
   [extras.value.application]
   [[extras.value.application.interface]]
   interface_name = "com.amazon.kepler.media.IMediaPlaybackServer"
   command_options = [
       "StartOver",
       "Previous",
       "Next",
       "SkipForward",
       "SkipBackward",
       <insert other commands supported>
   ]
   attribute_options = ["AudioAdvanceMuted", <insert any other attribute options supported>]
   features = ["AdvancedSeek", "VariableSpeed", "AudioTracks", "TextTracks", <insert other features supported>]
   

​

Related topics

• Kepler Media Controls Overview
• Get started with Kepler Media Controls

​

API Reference

​

Classes

• Action — Represents the actions that you can invoke using the media control client.
• InvalidArgumentError — Error thrown when invalid arguments are passed.
• InvalidStateError — Error occurs when a request cannot be processed due to being in the
• NotAllowedError — Error occurs when a request cannot be handled.
• NotAvailableError — Error occurs when requested data is not available.
• SeekOutOfRangeError — Error occurs when the requested seek position is out of the advertised range.
• SpeedOutOfRangeError — Error occurs when the requested playback speed is not supported.

​

Interfaces

• IArtist — Represents information about an artist.
• IArtwork — Represents the artwork expected by objects.
• IAudioBookInfo — Represents infomation about an audio book.
• ICapabilities — Represents the capabilities of a media endpoint.
• ICommandContext — Optional context passed to a media command.
• IControl — Represents a control.
• ILocale — interface representing the locale of the track.
• IMediaControlClientAsync — interface for media control clients
• IMediaControlEndpointLocatorAsync — Interface for asynchronously locating and interacting with media control endpoints.
• IMediaControlEndpointLocatorListener — Represents a listener to add to monitor changes to the available media control endpoints.
• IMediaControlHandlerAsync — When implemented, handles media control callbacks.
• IMediaControlListener — When implemented, handles media control state changes.
• IMediaControlServerAsync — Represent media control server operations.
• IMediaInfo — Represents information about the media.
• IMediaMetadata — interface expected by object returning metadata.
• IMediaProviderInfo — Represents information about the media provider.
• IMediaSessionId — Represents a media session ID.
• IPackageId — Represeents the package ID of an app.
• IPlaybackPosition — Represents the playback position of the track.
• IPlaybackSource — Represent the playback source.
• IPlaybackState — Represents the playback state of the track.
• IPlaylistState — Represents the state of a playlist.
• IRadioStationInfo — Represents information about a radio station.
• ISubscription — Represents a subscription that can be used to subsribe to various things.
• ITimeValue — interface for TimeValue, used to represent a time value structure.
• ITrack — Represents a track information.
• KeplerMediaControlsError — Repesents a generic error that might be thrown.
• MediaSessionState — Represents the media session state.

​

Enumerations

• CommandSource — Specifies the source of the media command.
• PlaybackStatus — Specifies the playback status.
• RadioBand — Specifies the radio band for the media player.
• RepeatMode — Specifies the repeat mode for the media player.

​

Variables

• MediaControlComponentAsync — This class is used to obtain an instance of the MediaControlEndpointLocatorAsync class.
• MediaControlServerComponentAsync