Mediaplayer

概要

スマートデバイス上のメディアの再生状態の変更要求を通知する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	スマートデバイスのメディアプレイヤーの再生音量を変更する。

GET /gotapi/mediaPlayer/media

種別

one-shot

概要

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

情報が取得できない項目については、空文字を返す。

リクエスト

物理名	データ型	必須	説明
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キーを共有されていた場合は必須。
MimeType		mimeType	string	No	録画・録音する際のエンコードするMimeType。
タイトル名		title	string	No	楽曲名や動画名等。
タイプ名		type	string	No	タイトルの種別。「Music」（楽曲名）、「Movie」（動画名）など。
言語		language	string	No	言語。BCP47で定義されている文字列を設定する。 (例)「ja」「en-us」。
説明文		description	string	No	内容についての説明。
画像URI		imageUri	string	No	アルバムカバーや動画サムネイルなどの画像へのURI。
曲の長さ		duration	float	Yes	秒単位。
制作者情報		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配列で返す。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mediaId" : "1234",
  "mimeType" : "audio/mpeg",
  "title" : "Test Music 1",
  "type" : "Music",
  "language" : "ja",
  "description" : "Sample Music",
  "imageUri" : "http://xxx.com/xxx.jpg",
  "duration" : 100,
  "creators" : [ {
    "creator" : "Tester 1",
    "role" : "Artist"
  }, {
    "creator" : "Tester 1",
    "role" : "Composer"
  } ],
  "keywords" : [ "Test1", "Sample" ],
  "genres" : [ "J-POP", "Sample" ]
}

PUT /gotapi/mediaPlayer/media

種別

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"
}

GET /gotapi/mediaPlayer/mediaList

種別

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	一覧の開始エントリ位置オフセット。全検索結果エントリの内、取得する一覧の開始エントリの位置を指定する。省略時は全検索結果の先頭エントリからの取得となり、offse=0と同義。レスポンスパラメータのcountと併用して、検索結果のページングを実現する。
limit	integer	No	一覧エントリ数の上限。取得する一覧のエントリ数の上限。省略もしくは0が指定された場合、全検索結果エントリを返却する。レスポンスパラメータのcount と併用して、検索結果のページングを実現する。

レスポンス

論理名			物理名	データ型	必須	説明
処理結果			result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
全検索結果の件数			count	integer	Yes	全検索結果の件数。リクエストパラメータのoffsetおよびlimitと併用して、検索結果のページングを実現する。
検索にヒットしたメディアの情報			media	array(object)	Yes	メディアの情報を配列で持つ。
	メディアID		mediaId	string	Yes	メディアを識別するID。
	MimeType		mimeType	string	No	録画・録音する際のエンコードするMimeType。
	タイトル名		title	string	No	楽曲名や動画名等。
	タイプ名		type	string	No	タイトルの種別。「Music」（楽曲名）、「Movie」（動画名）など。
	言語		language	string	No	言語。BCP47で定義されている文字列を設定する。 (例)「ja」「en-us」。
	説明文		description	string	No	内容についての説明。
	画像URI		imageUri	string	No	アルバムカバーや動画サムネイルなどの画像への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配列で返す。

レスポンスサンプル

{
  "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" : "Test Music 1",
    "imageUri" : "http://test.com/music1.mp3",
    "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" : "Test Music 2",
    "imageUri" : "http://test.com/music2.mp3",
    "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" : "Test Music 3",
    "imageUri" : "http://test.com/music3.mp3",
    "duration" : 300,
    "creators" : [ {
      "creator" : "Tester 3",
      "role" : "Artist"
    }, {
      "creator" : "Tester 3",
      "role" : "Composer"
    } ],
    "keywords" : [ "Test 3", "Sample" ],
    "genres" : [ "J-POP", "Sample" ]
  } ]
}

GET /gotapi/mediaPlayer/mute

種別

one-shot

概要

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

ミュートをサポートしていない場合はエラーを返す。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ミュート状態	mute	boolean	Yes	再生音量のミュート状態を表す。ミュート有り : true ミュート無し : false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mute" : false
}

PUT /gotapi/mediaPlayer/mute

種別

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"
}

DELETE /gotapi/mediaPlayer/mute

種別

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"
}

GET /gotapi/mediaPlayer/onStatusChange

種別

one-shot

概要

スマートデバイスのコンテンツ再生状態の変化（音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更）通知イベントを取得する。

再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

レスポンス

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Player情報		mediaPlayer	object	Yes	スマートデバイスのMediaPlayerの再生状態を返す。
	状態	status	string	Yes	メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了
	メディアID	mediaId	string	Yes	メディアを識別するID。
	MimeType	mimeType	string	No	録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
	再生位置	pos	string	No	トラックの再生位置を秒単位で返す。
	メディア再生音量	volume	string	No	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= volume <= 1.0)

レスポンスサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediaplayer",
  "attribute" : "onstatuschange",
  "mediaPlayer" : {
    "status" : "media",
    "mediaId" : "1234",
    "mimeType" : "application/ogg",
    "pos" : 0,
    "volume" : 1
  }
}

PUT /gotapi/mediaPlayer/onStatusChange

種別

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"
}

イベント

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
Player情報		mediaPlayer	object	Yes	スマートデバイスのMediaPlayerの再生状態を返す。
	状態	status	string	Yes	メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了
	メディアID	mediaId	string	Yes	メディアを識別するID。
	MimeType	mimeType	string	No	録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
	再生位置	pos	string	No	トラックの再生位置を秒単位で返す。
	メディア再生音量	volume	string	No	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= volume <= 1.0)

イベントサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediaplayer",
  "attribute" : "onstatuschange",
  "mediaPlayer" : {
    "status" : "media",
    "mediaId" : "1234",
    "mimeType" : "application/ogg",
    "pos" : 0,
    "volume" : 1
  }
}

DELETE /gotapi/mediaPlayer/onStatusChange

種別

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"
}

PUT /gotapi/mediaPlayer/pause

種別

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"
}

PUT /gotapi/mediaPlayer/play

種別

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"
}

GET /gotapi/mediaPlayer/playStatus

種別

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"
}

PUT /gotapi/mediaPlayer/resume

種別

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"
}

GET /gotapi/mediaPlayer/seek

種別

one-shot

概要

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生位置を取得する。

再生中のメディアが無い場合はエラーを返却する。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
再生位置	pos	integer	Yes	秒単位。最大値はMedia API（GET）やMediaList APIで取得できるパラメータdurationに相当する。範囲(0 ≤ pos ≤ duration)

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pos" : 60
}

PUT /gotapi/mediaPlayer/seek

種別

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"
}

PUT /gotapi/mediaPlayer/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"
}

GET /gotapi/mediaPlayer/volume

種別

one-shot

概要

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

システム全体の音量を取得したい場合は SettingプロファイルのVolume Setting APIを用いる事。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
設定したいメディア再生音量	volume	float	Yes	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= voleme <= 1.0)

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "volume" : 0.25
}

PUT /gotapi/mediaPlayer/volume

種別

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"
}

Swagger 定義
Device Connect API リファレンス
- AirConditioner
- AtmosphericPressure
- Authorization
- Availability
- Battery
- Camera
- Canvas
- Connection
- Device
- DeviceOrientation
- DriveController
- Ecg
- EchonetLite
- File
- FileDescriptor
- Geolocation
- Gpio
- Health
- HumanDetection
- Humidity
- Illuminance
- KeyEvent
- Light
- MediaPlayer
- MediaStreamRecording
- MessageHook
- Notification
- OmnidirectionalImage
- Phone
- PoseEstimation
- Power
- PowerMeter
- Proximity
- RemoteController
- ServiceDiscovery
- ServiceInformation
- Setting
- Sphero
- StressEstimation
- System
- Temperature
- Touch
- Tv
- Vibration
- VideoChat
- WalkState

Mediaplayer

概要

目次

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル