@amazon-devices/kepler-media-content-launcher

​

注釈

​

はじめに

​

セットアップ

1. package.jsonファイルのdependenciesセクションに、以下のライブラリ依存関係を追加します。

    "@amazon-devices/kepler-media-content-launcher": "~2.0.22",

2. コンテンツランチャーAPIにアクセスするには、manifest.tomlに以下の権限を追加します。
    schema-version = 1
   
    [package]
    title = "<アプリタイトル>"
    id = "com.amazondeveloper.media.sample"
   
    [components]
    [[components.interactive]]
    id = "com.amazondeveloper.media.sample.main"
    runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
    launch-type = "singleton"
    # カテゴリ "com.amazon.category.kepler.media" は主要コンポーネントのみに必要で、マニフェストの [[extras]]
    # セクションの "component-id" 値を使用して識別されます。
    categories = ["com.amazon.category.main", "com.amazon.category.kepler.media"]
   
    [processes]
    [[processes.group]]
    component-ids = ["com.amazondeveloper.media.sample.main"]
   
    [offers]
    [[offers.interaction]]
    id = "com.amazondeveloper.media.sample.main"
   
    [[message]]
    uri = "pkg://com.amazondeveloper.media.sample.main"
    # [[offers.interaction]] で使用した権限と一致させます。権限が追加されていない場合は "*" を使用します。
    sender-privileges = ["*"]
    receiver-privileges = ["self"]
   
    [[offers.module]]
    id = "/com.amazondeveloper.media.sample.module@ISomeUri1" 
    includes-messages = ["pkg://com.amazondeveloper.media.sample.main"]
   
    [[extras]]
    key = "interface.provider"
   
    component-id = "com.amazondeveloper.media.sample.main"
   
    [extras.value.application]
    [[extras.value.application.interface]]
    interface_name = "com.amazon.kepler.media.IContentLauncherServer"
   
    # override_attribute_componentフィールドは、[[extras]]セクションで指定されているcomponent-idが
    # ここで指定するcomponent-idと異なる場合のみ必要です。これにより、コマンドの実行時に
    # extrasで最初に定義されていたコンポーネントとは別のコンポーネントを使用できるため、
    # 柔軟な設定が可能になります。
   
    # たとえば、コンテンツランチャーインターフェイスに加えてアカウントログインインターフェイスを
    # 使用している場合は、アカウントログインのStatus属性をオーバーライドして、サービスにリダイレクトする
    # 必要があります。これには次の行を使用します。
    # override_attribute_component = { Status = "com.amazondeveloper.media.sample.interface.provider" }
    attribute_options = ["partner-id"]
    static-values = { partner-id = "<パートナーID>" }
   
    [needs]
   
    [[needs.module]]
    id = "/com.amazon.kepler.media@IContentLauncher1"
   

​

関連トピック

​

APIリファレンス

​

クラス

• ContentLauncherServerComponent - ContentLauncherの工場出荷時の設定です。
• InternalError - ContentLauncherServerのセットアップなど、セットアップが失敗した場合にスローされるエラー。
• InvalidArgumentError - 無効な引数が渡されたときにスローされるエラー。

​

インターフェイス

• IAdditionalInfo - 追加の名前と値のペアを定義するAdditionalInfoのインターフェイス。
• IContentLauncherHandler - ContentLauncherHandlerのインターフェイス。
• IContentLauncherServer - ContentLauncherServerのインターフェイス。コンテンツのハンドラーを設定できます。
• IContentSearch - 表示するコンテンツを検索するための入力を定義するContentSearchのインターフェイス。
• IContentSearchParameter - 表示するコンテンツを検索するための入力を定義するContentSearchParameterのインターフェイス。
• ILaunchContentOptionalFields - LaunchContentのペイロードを定義するコンテンツ起動リクエストのインターフェイス。
• ILauncherResponse - コンテンツランチャーコールバックへの応答に使用されるLauncherResponseのインターフェイス。
• ILauncherResponseBuilder - ビルドに使用されるLauncherResponseBuilderのインターフェイス。
• IPlaybackPreferences - 再生位置などの再生設定用のインターフェイス。
• ITrackPreference - トラック設定のインターフェイス。
• KeplerScriptContentLauncher - アプリのログインステータスを簡単に更新できます。

​

列挙型

• ContentLauncherStatusType - コンテンツランチャーのステータス。
• ContentSearchParamType - エンティティタイプを示すContentSearchParamTypeの列挙型。