Skip to content

MediaPlayer Profile

TakayukiHoshi1984 edited this page Mar 27, 2017 · 4 revisions

目次

API 機能概要
Media Player Media API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)を変更する。メディア再生中にmediaIdを再指定した場合は、新たに指定されたメディアの再生が始まる事とする。
Media Player Media API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の情報を取得する。
Media Player MediaList API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の一覧を取得する。
Media Player Status API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態(音声・映像の再生・一時停止・ミュート)を取得する。再生中のメディアが無い場合はエラーを返却する。
Media Player Play API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。再生中のメディアが無い場合はエラーを返却する。停止状態以外の状態で呼び出された場合はエラーを返却する。
Media Player Stop API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を停止に変更する。再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
Meida Player Pause API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を一時停止に変更する。再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
Media Player Resume API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。再生中のメディアが無い場合はエラーを返却する。一時停止以外の状態で呼び出された場合はエラーを返却する。
Media Player Seek API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を変更する。再生中のメディアが無い場合はエラーを返却する。
Media Player Seek API スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を取得する。再生中のメディアが無い場合はエラーを返却する。
Media Player Volume API スマートデバイスのメディアプレイヤーの再生音量を変更する。システム全体の音量を変更したい場合はSettingsプロファイルのVolume Settings APIを用いる事。
Media Player Volume API スマートデバイスのメディアプレイヤーの再生音量を取得する。システム全体の音量を取得したい場合はSettingsプロファイルのVolume Settings APIを用いる事。
Media Player Mute API スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。
Media Player Mute API スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。
Media Player Mute API スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。
Media Player Status Change Event API スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知を受領する。再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

機能概要

スマートデバイス上のメディアの再生状態の変更要求を通知するAPI。

参考API

なし

インターフェース名称 Version 種別
Media Player Media API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)を変更する。 メディア再生中にmediaIdを再指定した場合は、新たに指定されたメディアの再生が始まる事とする。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/media
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
メディアID mediaId string - メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/media
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&mediaId=12345&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Media API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の情報を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/media
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
メディアID mediaId string - メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
マイムタイプ mimeType string メディアのMIMEタイプ。
タイトル名 title string 楽曲名や動画名等。
タイプ名 type string タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。
言語 language string 言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」
説明文 description string 内容についての説明。
画像URI imageUri string アルバムカバーや動画サムネイルなどの画像へのURI。
曲の長さ duration number - 秒単位。
制作者情報 creators object 製作者情報。
制作者名 creator string 制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。
役割 role string 制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
キーワード keywords string[] 内容についての各種キーワードをstring配列で返す。
ジャンル genres string[] ジャンルをstring配列で返す。

※W3C参考資料には他にも多数のプロパティが定義されているが、ここでは一部を抜粋した。 (参考)メディアリソースのプロパティ一覧 http://www.w3.org/TR/2014/REC-mediaont-api-1.0-20140313/#Properties ※トラックについて (参考1)トラックのイメージ図。 Media Capture and Streams - 4. Stream API - 4.1 Introduction (参考2)W3Cのトラック(MediaStreamTrack)の説明。 Media Capture and Streams - 4. Stream API - 4.3 MediaStreamTrack

リクエストサンプル

GET  http://localhost:4035/gotapi/mediaPlayer/media?serviceId=xxxxx.localhost.deviceconnect.org&mediaId=12345&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "mimeType":"audio/mpeg",
    "title" : "Artificial Horizon",
    "type" : "Album title",
    "language" : "en-us",
    "description" : "This is description.",
    "imageUri" : "file:///path/to/albumArt.png",
    "duration":192,
    "creators":
    [
      {
        "creator" : "William Shakespeare",
        "role" : "artist"
      }
    ],
    "keywords": [ "keyword1", "keyword2", "keyword3" ],
    "genres": [ "sports", "j-pops", "rock" ]
}
インターフェース名称 Version 種別
Media Player MediaList API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の一覧を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/mediaList
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
メディアID mediaId string - メディアを識別するID。メディアIDはFile Profileで取得する。
検索条件 query string 例) sound
検索するMIMEタイプ mimeType string 例) video%2F
検索結果の並び順 order string 例)duration,asc
一覧の開始エントリ位置オフセット offset number 全検索結果エントリの内、取得する一覧の開始エントリの位置を指定する。省略時は全検索結果の先頭エントリからの取得となり、offset=0と同義。レスポンスパラメータの count と併用して、検索結果のページングを実現する。
一覧エントリ数の上限 limit number 取得する一覧のエントリ数の上限。省略もしくは0が指定された場合、全検索結果エントリを返却する。レスポンスパラメータの count と併用して、検索結果のページングを実現する。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
全検索結果の件数 count number - 全検索結果の件数。リクエストパラメータの offset および limit と併用して、検索結果のページングを実現する。
検索にヒットしたメディアの情報 media object -
メディアID mediaId string - メディアを識別するID。
マイムタイプ mimeType string メディアのMIMEタイプ。
タイトル名 title string 楽曲名や動画名等。
タイプ名 type string タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。
言語 language string 言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」
説明文 description string 内容についての説明。
画像URI imageUri string アルバムカバーや動画サムネイルなどの画像へのURI。
曲の長さ duration number - 秒単位。
制作者情報 creators object 製作者情報。
制作者名 creator string 制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。
役割 role string 制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
キーワード keywords string[] 内容についての各種キーワードをstring配列で返す。
ジャンル genres string[] ジャンルをstring配列で返す。

リクエストサンプル

GET  http://localhost:4035/gotapi/mediaPlayer/media_llist?serviceId=xxxxx.localhost.deviceconnect.org&mimeType=audio%2Fmp3&limit=10&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "count”:2,
    "media":
    [
      {
        "mimeType":"audio/mpeg",
        "title" : "Artificial Horizon",
        "type" : "Album title",
        "language" : "en-us",
        "description" : "This is description.",
        "imageUri" : "file:///path/to/albumArt_1.png",
        "duration":192,
        "creators":
        [
          {
            "creator" : "William Shakespeare",
            "role" : "artist"
          }
        ],
        "keywords": [ "keyword1", "keyword2", "keyword3" ],
        "genres": [ "sports", "j-pops", "rock" ]
      },
      {
        "mimeType":"audio/mp3",
        "title" : "Natural Vertical",
        "type" : "Album title",
        "language" : "en-us",
        "description" : "This is description.",
        "imageUri" : "file:///path/to/albumArt_2.png”,
        "duration":192,
        "creators":
        [
          {
            "creator" : "Vilhelmina Gunslinger",
            "role" : "artist"
          }
        ],
        "keywords": [ "keyword1", "keyword2", "keyword3" ],
        "genres": [ "sports", "world", "classical" ]
      }
    ]
}
インターフェース名称 Version 種別
Media Player Status API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態(音声・映像の再生・一時停止・ミュート)を取得する。 再生中のメディアが無い場合はエラーを返却する。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/playStatus
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
再生状態 status string - ・"play" 再生
・"stop" 停止
・"pause" 一時停止

リクエストサンプル

GET  http://localhost:4035/gotapi/media_play/playStatus?serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "status": "play"
}
インターフェース名称 Version 種別
Media Player Play API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。 再生中のメディアが無い場合はエラーを返却する。 停止状態以外の状態で呼び出された場合はエラーを返却する。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/play
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/play
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Stop API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を停止に変更する。 再生中のメディアが無い場合はエラーを返却する。 再生中以外の状態で呼び出された場合はエラーを返却する。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/stop
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/stop
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Pause API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を一時停止に変更する。 再生中のメディアが無い場合はエラーを返却する。 再生中以外の状態で呼び出された場合はエラーを返却する。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/pause
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/pause
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Resume API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。 再生中のメディアが無い場合はエラーを返却する。 一時停止以外の状態で呼び出された場合はエラーを返却する。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/resume
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/resume
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Seek API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を変更する。 再生中のメディアが無い場合はエラーを返却する。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/seek
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
再生位置 pos number - 秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。
範囲(0 ≤ pos ≤ duration)

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/seek
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Seek API 2.0.0 同期I/F

概要

スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を取得する。 再生中のメディアが無い場合はエラーを返却する。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/seek
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
再生位置 pos number - 秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。
範囲(0 ≤ pos ≤ duration)

リクエストサンプル

GET  http://localhost:4035/gotapi/mediaPlayer/seek?serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "pos": 180
}
インターフェース名称 Version 種別
Media Player Volume API 2.0.0 同期I/F

概要

スマートデバイスのメディアプレイヤーの再生音量を変更する。 システム全体の音量を変更したい場合はSettingsプロファイルのVolume Settings APIを用いる事。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/volume
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
設定したいメディア再生音量 volume number - メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= voleme <= 1.0)

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/volume
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Volume API 2.0.0 同期I/F

概要

スマートデバイスのメディアプレイヤーの再生音量を取得する。 システム全体の音量を取得したい場合はSettingsプロファイルのVolume Settings APIを用いる事。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/volume
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
設定したいメディア再生音量 volume number - メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= voleme <= 1.0)

リクエストサンプル

GET  http://localhost:4035/gotapi/mediaPlayer/volume?serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "volume" : 0.7
}
インターフェース名称 Version 種別
Media Player Mute API 2.0.0 同期I/F

概要

スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。

リクエスト

HTTPメソッド URI
PUT /gotapi/mediaPlayer/mute
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/mediaPlayer/mute
PUTデータ
serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Mute API 2.0.0 同期I/F

概要

スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/mediaPlayer/mute
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE  http://localhost:4035/gotapi/mediaPlayer/mute?serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
インターフェース名称 Version 種別
Media Player Mute API 2.0.0 同期I/F

概要

スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/mediaPlayer/mute
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
ミュート状態 mute boolean - 再生音量のミュート状態を表す。
true: ミュート有り
false: ミュート無し

リクエストサンプル

GET  http://localhost:4035/gotapi/mediaPlayer/mute?serviceId=xxxxx.localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "mute" : false
}
インターフェース名称 Version 種別
Media Player Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知を受領する。 再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

イベント情報

イベント名 Content-Type
/gotapi/mediaPlayer/onStatusChange application/json

メッセージ

論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
プロファイル名 profile string - mediaPlayer
コールバック名 attribute string - onstatuschange
セッションID sessionKey string - イベントセッションID
オブジェクト mediaPlayer object - イベントの内容を保持するオブジェクト
状態 status string - メディアプレイヤーの状態。
"play" 再生
"stop" 再生停止
"mute" ミュート
"unmute" ミュート解除
"pause" 一時停止
"resume" 一時停止解除
"media" 再生コンテンツ変更
"volume" 音量変更
"complete" 再生完了
メディアID mediaId string - メディアを識別するID。
MIMEタイプ mimeType string メディアのマイムタイプ。
再生位置 pos number トラックの再生位置を秒単位で返す。
メディア再生音量 volume number メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= volume <= 1.0)

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "serviceId":  "device1.localhost.deviceconnect.org",
	"api" : "gotapi"
    "profile" : "mediaPlayer",
    "attribute" : "onstatuschange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "mediaPlayer" : {
        "status": "play",
        "mediaId": "mediafile1",
        "mimeType":"audio/mpeg",
        "pos": 0,
        "volume":0.7
    }
}

Clone this wiki locally