Mediaplayer - masaru-takano/DeviceConnect-Spec GitHub Wiki
スマートデバイス上のメディアの再生状態の変更要求を通知するAPI。
API | 概要 |
---|---|
GET /gotapi/mediaPlayer/media | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の情報を取得する。 |
PUT /gotapi/mediaPlayer/media | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)を変更する。 |
GET /gotapi/mediaPlayer/mediaList | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の一覧を取得する。 |
GET /gotapi/mediaPlayer/mute | スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。 |
PUT /gotapi/mediaPlayer/mute | スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。 |
DELETE /gotapi/mediaPlayer/mute | スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。 |
GET /gotapi/mediaPlayer/onStatusChange | スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを取得する。 |
PUT /gotapi/mediaPlayer/onStatusChange | スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを開始する。 |
DELETE /gotapi/mediaPlayer/onStatusChange | スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを停止する。 |
PUT /gotapi/mediaPlayer/pause | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を一時停止に変更する。 |
PUT /gotapi/mediaPlayer/play | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。 |
GET /gotapi/mediaPlayer/playStatus | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態(音声・映像の再生・一時停止・ミュート)を取得する。 |
PUT /gotapi/mediaPlayer/resume | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。 |
GET /gotapi/mediaPlayer/seek | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を取得する。 |
PUT /gotapi/mediaPlayer/seek | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を変更する。 |
PUT /gotapi/mediaPlayer/stop | スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を停止に変更する。 |
GET /gotapi/mediaPlayer/volume | スマートデバイスのメディアプレイヤーの再生音量を取得する。 |
PUT /gotapi/mediaPlayer/volume | スマートデバイスのメディアプレイヤーの再生音量を変更する。 |
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の情報を取得する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
mediaId | string | Yes | メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。 |
物理名 | データ型 | 必須 | 説明 | |
---|---|---|---|---|
product | string | Yes |
DeviceConnectシステムの名前 |
|
keywords | array(string) | No |
キーワード 内容についての各種キーワードをstring配列で返す。 |
|
creators | object | No |
制作者情報 |
|
creator | string | Yes |
制作者名 制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。 |
|
role | float | Yes |
役割 制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。 |
|
description | string | No |
説明文 内容についての説明。 |
|
language | string | No |
言語 言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。 |
|
mimeType | string | No |
MimeType 録画・録音する際のエンコードするMimeType。 |
|
title | string | No |
タイトル名 楽曲名や動画名等。 |
|
type | string | No |
タイプ名 タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。 |
|
version | string | Yes |
DeviceConnectシステムのバージョン名 |
|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
|
duration | float | Yes |
曲の長さ 秒単位。 |
|
imageUri | string | No |
画像URI アルバムカバーや動画サムネイルなどの画像へのURI。 |
|
genres | array(string) | No |
ジャンル ジャンルをstring配列で返す。 |
|
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "mediaId" : "1234", "mimeType" : "audio/mpeg", "title" : "Test Music 1", "type" : "Music", "language" : "ja", "description" : "", "imageUri" : "", "duration" : 100, "creators" : [ { "creator" : "Tester 1", "role" : "Artist" }, { "creator" : "Tester 1", "role" : "Composer" } ], "keywords" : [ "Test1", "Sample" ], "genres" : [ "J-POP", "Sample" ] }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)を変更する。
メディア再生中にmediaIdを再指定した場合は、新たに指定されたメディアの再生が始まる事とする。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
mediaId | string | Yes | メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。 |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の一覧を取得する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
mediaId | string | No | メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。 |
query | string | No | 検索する文字列。部分一致検索を行い、一致対象はレスポンスパラメータのタイトル名(title)、制作者名(creators/creator)。 |
mimeType | string | No | MimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する 例)video%2F |
order | array(string) | No | 検索結果の並び順。検索結果の並び順。辞書順ソートの基準にするレスポンスパラメータの物理名と昇順・降順をカンマ区切りで指定する。物理名を最初に指定し、次に昇順はascを、降順はdescを指定する。省略時は、order=title,ascをしたのと同等となる。例)duration,asc |
offset | integer | No | 一覧の開始エントリ位置オフセット。全検索結果エントリの内、取得する一覧の開始エントリの位置を指定する。省略時は全検索結果の先頭エントリからの取得となり、offset=0と同義。レスポンスパラメータの count と併用して、検索結果のページングを実現する。 |
limit | integer | No | 一覧エントリ数の上限。取得する一覧のエントリ数の上限。省略もしくは0が指定された場合、全検索結果エントリを返却する。レスポンスパラメータの count と併用して、検索結果のページングを実現する。 |
物理名 | データ型 | 必須 | 説明 | ||
---|---|---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
||
count | integer | Yes |
全検索結果の件数 全検索結果の件数。リクエストパラメータの offset および limit と併用して、検索結果のページングを実現する。 |
||
product | string | Yes |
DeviceConnectシステムの名前 |
||
media | array(object) | Yes |
検索にヒットしたメディアの情報 |
||
mediaId | string | Yes |
メディアID メディアを識別するID。 |
||
mimeType | string | No |
MimeType 録画・録音する際のエンコードするMimeType。 |
||
title | string | No |
タイトル名 楽曲名や動画名等。 |
||
type | string | No |
タイプ名 タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。 |
||
language | string | No |
言語 言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。 |
||
description | string | No |
説明文 内容についての説明。 |
||
imageUri | string | No |
画像URI アルバムカバーや動画サムネイルなどの画像へのURI。 |
||
duration | float | No |
曲の長さ 秒単位。 |
||
creators | object | No |
制作者情報 |
||
creator | string | Yes |
制作者名 制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。 |
||
role | float | Yes |
役割 制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。 |
||
keywords | array(string) | No |
キーワード 内容についての各種キーワードをstring配列で返す。 |
||
genres | array(string) | No |
ジャンル ジャンルをstring配列で返す。 |
||
version | string | Yes |
DeviceConnectシステムのバージョン名 |
||
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "count" : 3, "media" : [ { "mediaId" : "1234", "mimeType" : "audio/mpeg", "title" : "Test Music 1", "type" : "Music", "language" : "ja", "description" : "", "imageUri" : "", "duration" : 100, "creators" : [ { "creator" : "Tester 1", "role" : "Artist" }, { "creator" : "Tester 1", "role" : "Composer" } ], "keywords" : [ "Test1", "Sample" ], "genres" : [ "J-POP", "Sample" ] }, { "mediaId" : "2345", "mimeType" : "audio/mpeg", "title" : "Test Music 2", "type" : "Music", "language" : "ja", "description" : "", "imageUri" : "", "duration" : 200, "creators" : [ { "creator" : "Tester 2", "role" : "Artist" }, { "creator" : "Tester 2", "role" : "Composer" } ], "keywords" : [ "Test 2", "Sample" ], "genres" : [ "J-POP", "Sample" ] }, { "mediaId" : "3456", "mimeType" : "audio/mpeg", "title" : "Test Music 3", "type" : "Music", "language" : "ja", "description" : "", "imageUri" : "", "duration" : 300, "creators" : [ { "creator" : "Tester 3", "role" : "Artist" }, { "creator" : "Tester 3", "role" : "Composer" } ], "keywords" : [ "Test 3", "Sample" ], "genres" : [ "J-POP", "Sample" ] } ] }
one-shot
スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
mute | boolean | Yes |
ミュート状態 再生音量のミュート状態を表す。 true: ミュート有り false: ミュート無し |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "mute" : false }
one-shot
スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを取得する。
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 | |
---|---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
|
product | string | Yes |
DeviceConnectシステムの名前 |
|
version | string | Yes |
DeviceConnectシステムのバージョン名 |
|
mediaPlayer | object | Yes |
Player情報 |
|
status | string | Yes |
状態 メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了 |
|
mediaId | string | Yes |
メディアID メディアを識別するID。 |
|
mimeType | string | No |
MimeType 録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。 |
|
pos | string | No |
再生位置 トラックの再生位置を秒単位で返す。 |
|
volume | string | No |
メディア再生音量 メディアの再生音量を0から1の割合で表す。 範囲 (0.0 <= volume <= 1.0) |
|
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "serviceId" : "Host.dummyId.localhost.deviceconnect.org", "profile" : "mediaplayer", "attribute" : "onstatuschange", "mediaPlayer" : { "status" : "media", "mediaId" : "1234", "mimeType" : "application/ogg", "pos" : 0, "volume" : 1 } }
event
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを開始する。
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
interval | long | No | デバイスプラグインがイベントを送信する間隔。 |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
物理名 | データ型 | 必須 | 説明 | |
---|---|---|---|---|
attribute | string | Yes |
アトリビュート名 |
|
serviceId | string | Yes |
サービスID |
|
interface | string | Yes |
インターフェース名 |
|
mediaPlayer | object | Yes |
Player情報 |
|
status | string | Yes |
状態 メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了 |
|
mediaId | string | Yes |
メディアID メディアを識別するID。 |
|
mimeType | string | No |
MimeType 録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。 |
|
pos | string | No |
再生位置 トラックの再生位置を秒単位で返す。 |
|
volume | string | No |
メディア再生音量 メディアの再生音量を0から1の割合で表す。 範囲 (0.0 <= volume <= 1.0) |
|
profile | string | Yes |
プロファイル名 |
{ "serviceId" : "Host.dummyId.localhost.deviceconnect.org", "profile" : "mediaplayer", "attribute" : "onstatuschange", "mediaPlayer" : { "status" : "media", "mediaId" : "1234", "mimeType" : "application/ogg", "pos" : 0, "volume" : 1 } }
event
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを停止する。
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を一時停止に変更する。
再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。
再生中のメディアが無い場合はエラーを返却する。停止状態以外の状態で呼び出された場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態(音声・映像の再生・一時停止・ミュート)を取得する。
再生中のメディアが無い場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
status | string | Yes |
再生状態 ・play : 再生 ・stop : 停止 ・pause : 一時停止 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "status" : "stop" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。
再生中のメディアが無い場合はエラーを返却する。一時停止以外の状態で呼び出された場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を取得する。
再生中のメディアが無い場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
pos | integer | Yes |
再生位置 秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。 範囲(0 ≤ pos ≤ duration) |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "pos" : 60 }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を変更する。
再生中のメディアが無い場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
pos | long | Yes | 再生位置。秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。 範囲(0 ≤ pos ≤ duration) |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を停止に変更する。
再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスのメディアプレイヤーの再生音量を取得する。
システム全体の音量を取得したい場合はSettingプロファイルのVolume Setting APIを用いる事。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
volume | float | Yes |
設定したいメディア再生音量 メディアの再生音量を0から1の割合で表す。 範囲 (0.0 <= voleme <= 1.0) |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0", "volume" : 0.25 }
one-shot
スマートデバイスのメディアプレイヤーの再生音量を変更する。
システム全体の音量を変更したい場合はSettingプロファイルのVolume Setting APIを用いる事。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
volume | float | Yes | 設定したいメディア再生音量。メディアの再生音量を0から1の割合で表す。 範囲 (0.0 <= voleme <= 1.0) |
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
result | integer | Yes |
処理結果 0: 正常応答 0以外: 異常応答 |
product | string | Yes |
DeviceConnectシステムの名前 |
version | string | Yes |
DeviceConnectシステムのバージョン名 |
hmac | string | No |
レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }