Mediaplayer API

レコーダーの情報を取得

デバイスが持っているレコーダーに関する情報を取得します。複数返ってきます。

基本情報

APIパス : /gotapi/mediaPlayer/media_list

HTTPメソッド : GET

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
count 数値
media 配列
version 文字列

デバイスのミュートを設定

デバイスをミュートにします。変更後はWebSocket経由でイベントが通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/mute

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

デバイスのミュートを解除

デバイスのミュート設定を解除します。変更後はWebSocket経由でイベントが通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/mute

HTTPメソッド : DELETE

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

音楽ファイルを再生

デバイスの中にある音楽ファイルを再生します。デバイス側で再生します。その際、再生開始や完了がWebSocketを経由して通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/play

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

音楽の再生を一時停止

デバイスの音楽を一時停止します。その際、イベントの通知がWebSocket経由で行われます。WebSocketについてはメディアプレイヤーAPI(WebSocket)を参照してください。

基本情報

APIパス : /gotapi/mediaPlayer/pause

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

音楽を停止

メディアプレイヤーの再生を停止します。停止した際のイベントはWebSocketで通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/stop

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

音楽を再開

メディアプレイヤーの再生を再開します。停止した際のイベントはWebSocketで通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/resume

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

音楽の再生位置を変更

メディアプレイヤーの再生位置を変更します。

基本情報

APIパス : /gotapi/mediaPlayer/seek

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
pos 文字列 クエリー 再生開始位置。整数で指定

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

ボリュームを変更

メディアプレイヤーのボリュームを変更します。変更した際のイベントはWebSocketで通知されます。

基本情報

APIパス : /gotapi/mediaPlayer/volume

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
volume 文字列 クエリー ボリューム。0〜1の間で指定。0.5など。

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

メディアレコーダーの通知イベントを設定

メディアレコーダーの各種通知イベントを設定します。イベントの通知はWebSocketで行われるので、メディアレコーダーAPI(WebSocket)を参照してください。

基本情報

APIパス : /gotapi/mediaPlayer/onstatuschange

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
sessionKey 文字列 クエリー WebSocketで受け取るための一意のキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
value 文字列
version 文字列

メディアプレイヤーの通知設定を削除

メディアプレイヤーで設定していたイベント通知設定を削除します。

基本情報

APIパス : /gotapi/mediaPlayer/onstatuschange

HTTPメソッド : DELETE

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
sessionKey 文字列 クエリー WebSocketで受け取るための一意のキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
value 文字列
version 文字列