MediaStreamRecording - TakayukiHoshi1984/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	スマートデバイスでの動画撮影中に、動画のプレビュー画像を受信を停止する。
PUT /gotapi/mediaStreamRecording/preview/mute	音声が付加されているPreview映像に対し、 その映像の音声をミュート状態にするリクエストを送る。
DELETE /gotapi/mediaStreamRecording/preview/mute	音声が付加されている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システムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
レコーダーリスト			recorders	array(object)	Yes	レコーダー情報の配列。
	レコーダーID		id	string	Yes	レコーダーを識別するID。
	レコーダー名		name	string	Yes	レコーダー名。
	レコーダーの状態		state	string	Yes	レコーダーの状態。
	MIME Type		mimeType	string	Yes	レコーダーのエンコードするタイプ。
	コンフィグ		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	音声のブロックサイズ。単位はバイト。

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

スマートデバイスの写真撮影通知イベントを取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

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

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
写真データ		photo	object	Yes	撮影された写真データ。
	URI	uri	string	No	撮影された写真のURI。
	ファイルパス	path	string	Yes	ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。 File APIで使用可能。
	MIME Type	mimeType	string	Yes	撮影された写真のMIME Type。動画・音声を識別するために使用する。

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

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
写真データ		photo	object	Yes	撮影された写真データ。
	URI	uri	string	No	撮影された写真のURI。
	ファイルパス	path	string	Yes	ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。 File APIで使用可能。
	MIME Type	mimeType	string	Yes	撮影された写真のMIME Type。動画・音声を識別するために使用する。

{
  "serviceId" : "Host.exampleId.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

スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを 取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

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

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
レコーディング情報		media	object	Yes	レコーディング情報
	レコーディングの状態	status	string	Yes	レコーディングの状態を識別する文字列。
	URI	uri	string	No	動画または音声のURI。
	ファイルパス	path	string	No	ファイルが存在するパス。ルートはデバイスプラグインごとに違う。
	MIME Type	mimeType	string	Yes	録画・録音が開始されたメディアのMIME Type。 このタイプで、動画、音声などを識別する。
	エラーメッセージ	errorMessasge	string	No	エラー、警告内容を伝える文字列。 状態が error、warning の時のみ付加される。省略可能。

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

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
レコーディング情報		media	object	Yes	レコーディング情報
	レコーディングの状態	status	string	Yes	レコーディングの状態を識別する文字列。
	URI	uri	string	No	動画または音声のURI。
	ファイルパス	path	string	No	ファイルが存在するパス。ルートはデバイスプラグインごとに違う。
	MIME Type	mimeType	string	Yes	録画・録音が開始されたメディアのMIME Type。 このタイプで、動画、音声などを識別する。
	エラーメッセージ	errorMessasge	string	No	エラー、警告内容を伝える文字列。 状態が error、warning の時のみ付加される。省略可能。

{
  "serviceId" : "Host.exampleId.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システムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
MIME Type		mimeType	array(string)	Yes	録画・録音する際のエンコードするタイプの一覧
撮影時の解像度の一覧		imageSizes	array(object)	No	レコーダーのサポートする画像の解像度の一覧。録音の場合は省略可。 プラグイン側でリサイズすることでサポートするサイズも含めてよい。
	横幅	width	integer	Yes	画像の横幅。単位はピクセル。
	縦幅	height	integer	Yes	画像の縦幅。単位はピクセル。
プレビュー時の解像度の一覧		previewSizes	array(object)	No	プレビューで利用可能な解像度の一覧。 録音の場合、またはプレビューを提供しない場合は省略可。 プラグイン側でリサイズすることでサポートするサイズも含めてよい。
	横幅	width	integer	Yes	画像の横幅。単位はピクセル。
	縦幅	height	integer	Yes	画像の縦幅。単位はピクセル。

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

スマートデバイスからサポートしている写真撮影、 動画撮影や音声録音のオプションを設定する。

スマートデバイスのPreviewSize,PictureSizeや最大フレームレートなどを設定する。

物理名	データ型	必須	説明
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システムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プレビュー画像URI	uri	string	Yes	プレビュー画像URI。形式はJPEGとする。

{
  "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キーを共有されていた場合は必須。
プレビュー配信URI		uri	string	Yes	開始したプレビューの配信用URI。形式はMotionJPEGとする。
ストリームのリスト		streams	array(object)	No	ストリーム情報の配列。
	ストリームのMIMEType	mimeType	string	Yes	ストリームのMIMEType。
	ストリームのURI	uri	string	Yes	ストリームのURI。
音声配信情報		audio	object	No	音声配信に関する情報。音声のみの配信をサポートしない場合は省略可。
	音声配信URI	uri	string	Yes	音声配信URI。

{
  "streams" : [ {
    "mimeType" : "video/x-mjpeg",
    "uri" : "http://localhost:9000/xxxxxx"
  }, {
    "mimeType" : "video/x-rtp",
    "uri" : "rtsp://localhost:8086"
  } ],
  "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

音声が付加されているPreview映像に対し、 その映像の音声をミュート状態にするリクエストを送る。

例えば、Preview映像がRTSPの場合に、このAPIにより音声をミュート状態にする。

物理名	データ型	必須	説明
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

音声が付加されているPreview映像に対し、 その映像の音声のミュート状態を解除するリクエストを送る。

例えば、Preview映像がRTSPの場合に、このAPIにより音声のミュート状態を解除する。

物理名	データ型	必須	説明
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以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
URI	uri	string	No	動画または音声のURI。
ファイルパス	path	string	No	動画または音声へのファイルパス。ルートはデバイスプラグインごとに異なる。 File APIのパラメータとして使用可能。

{
  "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キーを共有されていた場合は必須。
URI	uri	string	No	動画または音声のURI。
ファイルパス	path	string	No	動画または音声へのファイルパス。 ルートはデバイスプラグインごとに異なる。 File APIのパラメータとして使用可能。

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

one-shot

スマートデバイスに対して写真撮影リクエストを送る。

targetが指定されていない場合は、GET/mediaStreamRecording/mediaRecorderで 一番最初に見つかるレコーダーが指定される。

物理名	データ型	必須	説明
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キーを共有されていた場合は必須。
URI	uri	string	Yes	撮影された写真のURI。
ファイルパス	path	string	Yes	撮影された写真へのファイルパス。ルートはデバイスプラグインごとに異なる。 File APIのパラメータとして使用可能。

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