MediaStreamRecording - masaru-takano/DeviceConnect-Spec GitHub Wiki

抂芁

スマヌトデバむスによる写真撮圱、動画録画たたは音声録音などの操䜜を行うAPI。

目次

API 抂芁
GET /gotapi/mediaStreamRecording/mediaRecorder スマヌトデバむスから䜿甚可胜なレコヌダヌの䞀芧を取埗する。
PUT /gotapi/mediaStreamRecording/muteTrack スマヌトデバむスに察しお動画撮圱や音声録音のミュヌト䟝頌を送る。
GET /gotapi/mediaStreamRecording/onPhoto スマヌトデバむスの写真撮圱通知むベントを取埗する。
PUT /gotapi/mediaStreamRecording/onPhoto スマヌトデバむスの写真撮圱通知むベントを開始する。
DELETE /gotapi/mediaStreamRecording/onPhoto スマヌトデバむスの写真撮圱通知むベントを停止する。
GET /gotapi/mediaStreamRecording/onRecordingChange スマヌトデバむスでの写真撮圱、動画撮圱たたは音声録音の状態倉化通知むベントを取埗する。
PUT /gotapi/mediaStreamRecording/onRecordingChange スマヌトデバむスでの写真撮圱、動画撮圱たたは音声録音の状態倉化通知むベントを開始する。
DELETE /gotapi/mediaStreamRecording/onRecordingChange スマヌトデバむスでの写真撮圱、動画撮圱たたは音声録音の状態倉化通知むベントを停止する。
GET /gotapi/mediaStreamRecording/options スマヌトデバむスからサポヌトしおいる写真撮圱、動画撮圱や音声録音のオプションを取埗する。
PUT /gotapi/mediaStreamRecording/options スマヌトデバむスからサポヌトしおいる写真撮圱、動画撮圱や音声録音のオプションを蚭定する。
PUT /gotapi/mediaStreamRecording/pause スマヌトデバむスに察しお動画撮圱たたは音声録音の䞀時停止䟝頌を送る。
GET /gotapi/mediaStreamRecording/preview スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を取埗する。
PUT /gotapi/mediaStreamRecording/preview スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を受信を開始する。
DELETE /gotapi/mediaStreamRecording/preview スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を受信を停止する。
POST /gotapi/mediaStreamRecording/record スマヌトデバむスに察しお、動画撮圱や音声録音の開始リク゚ストを送る。
PUT /gotapi/mediaStreamRecording/resume スマヌトデバむスに察しお䞀時停止状態にある動画撮圱たたは音声録音の再開リク゚ストを送る。
PUT /gotapi/mediaStreamRecording/stop スマヌトデバむスに察しお動画撮圱たたは音声録音の終了リク゚ストを送る。
POST /gotapi/mediaStreamRecording/takePhoto スマヌトデバむスに察しお写真撮圱リク゚ストを送る。
PUT /gotapi/mediaStreamRecording/unmuteTrack スマヌトデバむスに察しお動画撮圱や音声録音のミュヌト解陀䟝頌を送る。

皮別

one-shot

抂芁

スマヌトデバむスから䜿甚可胜なレコヌダヌの䞀芧を取埗する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバヌゞョン名
recorders array(object) Yes レコヌダヌリスト
レコヌダヌ情報の配列。
id string Yes レコヌダヌID
レコヌダヌを識別するID。
name string Yes レコヌダヌ名
レコヌダヌ名。
state string Yes レコヌダヌの状態
レコヌダヌの状態。
mimeType string Yes MIME Type
レコヌダヌの゚ンコヌドするタむプ。
config string Yes コンフィグ
カメラに蚭定がある堎合には、ここに文字列ずしおデヌタが栌玍されおいる。
imageWidth integer No 画像の暪幅
レコヌダヌの珟圚の暪幅。単䜍はピクセル。録音の堎合は省略可。
imageHeight integer No 画像の瞊幅
レコヌダヌの珟圚の瞊幅。単䜍はピクセル。録音の堎合は省略可。
previewWidth integer No プレビュヌの暪幅
プレビュヌの珟圚の暪幅。単䜍はピクセル。録音の堎合は省略可。
previewHeight integer No プレビュヌの瞊幅
プレビュヌの珟圚の瞊幅。単䜍はピクセル。録音の堎合は省略可。
previewMaxFrameRate float No プレビュヌの最倧フレヌムレヌト
珟圚のプレビュヌのフレヌムレヌトの最倧倀。単䜍はfps。録音の堎合は省略可。
audio object No 音声情報
録音する音声に関する情報。
channels integer Yes チャンネル数
音声のチャンネル数。
sampleRate float Yes サンプルレヌト
音声のサンプルレヌト。単䜍はHz。
sampleSize integer Yes サンプルサむズ
音声のサンプルサむズ。単䜍はビット。
blockSize integer Yes ブロックサむズ
音声のブロックサむズ。単䜍はバむト。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "recorders" : [ {
    "id" : "photo_0",
    "name" : "Dummy Camera Recorder - back",
    "state" : "inactive",
    "imageWidth" : 3264,
    "imageHeight" : 2448,
    "previewWidth" : 640,
    "previewHeight" : 480,
    "previewMaxFrameRate" : 10,
    "mimeType" : "image/png",
    "config" : ""
  }, {
    "id" : "photo_1",
    "name" : "Dummy Camera Recorder - front",
    "state" : "inactive",
    "imageWidth" : 1280,
    "imageHeight" : 960,
    "previewWidth" : 640,
    "previewHeight" : 480,
    "previewMaxFrameRate" : 10,
    "mimeType" : "image/png",
    "config" : ""
  }, {
    "id" : "video_0",
    "name" : "Dummy Video Recorder - back",
    "state" : "inactive",
    "imageWidth" : 640,
    "imageHeight" : 480,
    "mimeType" : "video/3gp",
    "config" : ""
  }, {
    "id" : "video_1",
    "name" : "Dummy Video Recorder - front",
    "state" : "inactive",
    "imageWidth" : 640,
    "imageHeight" : 480,
    "mimeType" : "video/3gp",
    "config" : ""
  }, {
    "id" : "audio",
    "name" : "Dummy Audio Recorder",
    "state" : "inactive",
    "mimeType" : "audio/3gp",
    "config" : ""
  }, {
    "id" : "screen",
    "name" : "Dummy Screen",
    "state" : "inactive",
    "imageWidth" : 1080,
    "imageHeight" : 1776,
    "previewWidth" : 270,
    "previewHeight" : 444,
    "previewMaxFrameRate" : 10,
    "mimeType" : "video/x-mjpeg",
    "config" : ""
  } ]
}

皮別

one-shot

抂芁

スマヌトデバむスに察しお動画撮圱や音声録音のミュヌト䟝頌を送る。

ビデオずオヌディオなどの耇数トラックが含たれる撮圱䞭メディアにおいおは、オヌディオトラックがミュヌトされる。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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以倖: 異垞応答
photo object Yes 写真デヌタ
撮圱された写真デヌタ。
uri string No URI
撮圱された写真のURI。
path string Yes ファむルパス
ファむルが存圚するパス。ルヌトはデバむスプラグむンごずに異なる。File APIで䜿甚可胜。
mimeType string Yes MIME Type
撮圱された写真のMIME Type。動画・音声を識別するために䜿甚する。
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバヌゞョン名
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

皮別

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

むベント

物理名 デヌタ型 必須 説明
photo object Yes 写真デヌタ
撮圱された写真デヌタ。
uri string No URI
撮圱された写真のURI。
path string Yes ファむルパス
ファむルが存圚するパス。ルヌトはデバむスプラグむンごずに異なる。File APIで䜿甚可胜。
mimeType string Yes MIME Type
撮圱された写真のMIME Type。動画・音声を識別するために䜿甚する。
attribute string Yes アトリビュヌト名
serviceId string Yes サヌビスID
interface string Yes むンタヌフェヌス名
profile string Yes プロファむル名

むベントサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onphoto",
  "photo" : {
    "uri" : "Dummy URI",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}

皮別

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システムの名前
media object Yes レコヌディング情報
レコヌディング情報
status string Yes レコヌディングの状態
レコヌディングの状態を識別する文字列。
path string Yes ファむルパス
ファむルが存圚するパス。ルヌトはデバむスプラグむンごずに違う。File APIで䜿甚可胜。
mimeType string Yes MIME Type
録画・録音が開始されたメディアのMIME Type。このタむプで、動画、音声などを識別する。
errorMessasge string No ゚ラヌメッセヌゞ
゚ラヌ、譊告内容を䌝える文字列。状態が error、warning の時のみ付加される。省略可胜。
version string Yes DeviceConnectシステムのバヌゞョン名
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "video/3gp"
  }
}

皮別

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 アトリビュヌト名
media object Yes レコヌディング情報
レコヌディング情報
status string Yes レコヌディングの状態
レコヌディングの状態を識別する文字列。
path string Yes ファむルパス
ファむルが存圚するパス。ルヌトはデバむスプラグむンごずに違う。File APIで䜿甚可胜。
mimeType string Yes MIME Type
録画・録音が開始されたメディアのMIME Type。このタむプで、動画、音声などを識別する。
errorMessasge string No ゚ラヌメッセヌゞ
゚ラヌ、譊告内容を䌝える文字列。状態が error、warning の時のみ付加される。省略可胜。
serviceId string Yes サヌビスID
interface string Yes むンタヌフェヌス名
profile string Yes プロファむル名

むベントサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onrecordingchange",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}

皮別

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。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
product string Yes DeviceConnectシステムの名前
previewSizes array(object) No プレビュヌ時の解像床の䞀芧
プレビュヌで利甚可胜な解像床の䞀芧。録音の堎合、たたはプレビュヌを 提䟛しない堎合は省略可。プラグむン偎でリサむズするこずでサポヌトするサむズも含めおよい。
width integer Yes 暪幅
画像の暪幅。単䜍はピクセル。
height integer Yes 瞊幅
画像の瞊幅。単䜍はピクセル。
imageSizes array(object) No 撮圱時の解像床の䞀芧
レコヌダヌのサポヌトする画像の解像床の䞀芧。録音の堎合は省略可。プラグむン偎でリサむズするこずでサポヌトするサむズも含めおよい。
width integer Yes 暪幅
画像の暪幅。単䜍はピクセル。
height integer Yes 瞊幅
画像の瞊幅。単䜍はピクセル。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。
mimeType array(string) Yes MIME Type
録画・録音する際の゚ンコヌドするタむプの䞀芧
version string Yes DeviceConnectシステムのバヌゞョン名

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "imageSize" : [ {
    "width" : 3264,
    "height" : 2448
  }, {
    "width" : 3200,
    "height" : 2400
  }, {
    "width" : 2592,
    "height" : 1944
  }, {
    "width" : 2048,
    "height" : 1536
  }, {
    "width" : 1920,
    "height" : 1080
  }, {
    "width" : 1600,
    "height" : 1200
  }, {
    "width" : 1280,
    "height" : 960
  }, {
    "width" : 1280,
    "height" : 768
  }, {
    "width" : 1280,
    "height" : 720
  }, {
    "width" : 1024,
    "height" : 768
  }, {
    "width" : 800,
    "height" : 600
  }, {
    "width" : 800,
    "height" : 480
  }, {
    "width" : 720,
    "height" : 480
  }, {
    "width" : 640,
    "height" : 480
  }, {
    "width" : 352,
    "height" : 288
  }, {
    "width" : 320,
    "height" : 240
  }, {
    "width" : 176,
    "height" : 144
  } ],
  "previewSize" : [ {
    "width" : 1920,
    "height" : 1080
  }, {
    "width" : 1600,
    "height" : 1200
  }, {
    "width" : 1280,
    "height" : 960
  }, {
    "width" : 1280,
    "height" : 768
  }, {
    "width" : 1280,
    "height" : 720
  }, {
    "width" : 1024,
    "height" : 768
  }, {
    "width" : 800,
    "height" : 600
  }, {
    "width" : 800,
    "height" : 480
  }, {
    "width" : 720,
    "height" : 480
  }, {
    "width" : 640,
    "height" : 480
  }, {
    "width" : 352,
    "height" : 288
  }, {
    "width" : 320,
    "height" : 240
  }, {
    "width" : 176,
    "height" : 144
  } ],
  "mimeType" : [ "image/png" ]
}

皮別

one-shot

抂芁

スマヌトデバむスからサポヌトしおいる写真撮圱、動画撮圱や音声録音のオプションを蚭定する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。
imageWidth integer No 撮圱時の暪幅。単䜍はピクセル。previewHeightを指定するずきは省略䞍可。Options API GETで返された倀以倖を指定した堎合はパラメヌタ゚ラヌ。
imageHeight integer No 撮圱時の瞊幅。単䜍はピクセル。previewWidthを指定するずきは省略䞍可。Options API GETで返された倀以倖を指定した堎合はパラメヌタ゚ラヌ。
previewWidth integer No プレビュヌ時の暪幅。単䜍はピクセル。previewHeightを指定するずきは省略䞍可。Options API GETで返された倀以倖を指定した堎合はパラメヌタ゚ラヌ。
previewHeight integer No プレビュヌ時の瞊幅。単䜍はピクセル。previewWidthを指定するずきは省略䞍可。Options API GETで返された倀以倖を指定した堎合はパラメヌタ゚ラヌ。
previewMaxFrameRate float No プレビュヌ時の最倧フレヌムレヌト。単䜍はfps。範囲は0.0より倧きい小数倀。
mimeType string Yes MimeType。動画録画・音声録音するずきの゚ンコヌドするタむプ。

レスポンス

物理名 デヌタ型 必須 説明
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。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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

抂芁

スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を取埗する。

このむベント通知を行うタむミングに芏定は無く、デバむスプラグむンの実装䟝存ずする。JPEGでデヌタを受信する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバヌゞョン名
uri string Yes プレビュヌ画像URI
プレビュヌ画像URI。圢匏はJPEGずする。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}

皮別

streaming

抂芁

スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を受信を開始する。

このむベント通知を行うタむミングに芏定は無く、デバむスプラグむンの実装䟝存ずする。MotionJPEGでデヌタを受信する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
product string Yes DeviceConnectシステムの名前
audio object No 音声配信情報
音声配信に関する情報。音声のみの配信をサポヌトしない堎合は省略可。
uri string Yes 音声配信URI
音声配信URI。
version string Yes DeviceConnectシステムのバヌゞョン名
uri string Yes プレビュヌ配信URI
開始したプレビュヌの配信甚URI。圢匏はMotionJPEGずする。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}

皮別

streaming

抂芁

スマヌトデバむスでの動画撮圱䞭に、動画のプレビュヌ画像を受信を停止する。

このむベント通知を行うタむミングに芏定は無く、デバむスプラグむンの実装䟝存ずする。MotionJPEGでデヌタを受信する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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

抂芁

スマヌトデバむスに察しお、動画撮圱や音声録音の開始リク゚ストを送る。

MediaStreamRecording Stopされない堎合は各デバむスが撮圱できる最倧時間たで撮圱を行い、その埌撮圱を停止する。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。
timeslice long No タむムスラむス。動画・音声入力などから埗られた1フレヌムを新たに出力先メディアに曞き出すたでの埅ち時間。単䜍はミリ秒。1000/timesliceが出力メディアの固定フレヌムレヌトフレヌム/秒に盞圓する。省略された堎合には、デバむス毎の挙動でフレヌム曞き出しを行う。

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
path string Yes ファむルパス
動画たたは音声ぞのファむルパス。ルヌトはデバむスプラグむンごずに異なる。File APIのパラメヌタずしお䜿甚可胜。
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバヌゞョン名
uri string Yes URI
動画たたは音声のURI。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

皮別

one-shot

抂芁

スマヌトデバむスに察しお䞀時停止状態にある動画撮圱たたは音声録音の再開リク゚ストを送る。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別するID。省略された堎合にはデフォルトのレコヌダヌを䜿甚する。デバむスが音声・動画の䞡方のレコヌダヌをサポヌトする堎合、どちらのレコヌダヌが䜿甚されるかどうかはデバむスプラグむン䟝存ずする。

レスポンス

物理名 デヌタ型 必須 説明
result integer Yes 凊理結果
0: 正垞応答
0以倖: 異垞応答
path string Yes ファむルパス
撮圱された写真ぞのファむルパス。ルヌトはデバむスプラグむンごずに異なる。File APIのパラメヌタずしお䜿甚可胜。
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバヌゞョン名
uri string Yes URI
撮圱された写真のURI。
hmac string No レスポンスに察する眲名
アプリケヌション偎から事前にHMACキヌを共有されおいた堎合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

皮別

one-shot

抂芁

スマヌトデバむスに察しお動画撮圱や音声録音のミュヌト解陀䟝頌を送る。

ビデオずオヌディオなどの耇数トラックが含たれる撮圱䞭メディアにおいおは、オヌディオトラックがミュヌト解陀される。

リク゚スト

物理名 デヌタ型 必須 説明
serviceId string Yes サヌビスID。取埗察象スマヌトデバむス
target string No タヌゲット。レコヌダヌを識別する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"
}
⚠ **GitHub.com Fallback** ⚠