OmnidirectionalImage - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

全方位パノラマ画像をROI画像へ変換する機能を提供する。
※ROI:Region of Imageのこと。

API	概要
PUT /gotapi/omnidirectionalImage/roi	ROI画像の受信を開始するAPI。
DELETE /gotapi/omnidirectionalImage/roi	ROI画像の受信を終了する。
PUT /gotapi/omnidirectionalImage/roi/settings	ROI画像の設定を変更する。

streaming

ROI画像の受信を開始するAPI。

本APIのレスポンスで返されるURIでROI画像を参照できる。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
source	string	Yes	全方位パノラマ画像URI。ROI画像に変換する全方位パノラマ画像のURI。

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ROI画像配信サーバURI		uri	string	Yes	ROI画像を配信するサーバのURIを示す。 配信される画像の形式はMotionJPEGとする。
ストリームのリスト		streams	array(object)	No	ストリーム情報の配列。
	ストリームのMIMEType	mimeType	string	Yes	ストリームのMIMEType。
	ストリームのURI	uri	string	Yes	ストリームのURI。

{
  "streams" : [ {
    "mimeType" : "video/x-mjpeg",
    "uri" : "http://localhost:9000/xxxxxx"
  }, {
    "mimeType" : "video/x-mjpeg",
    "uri" : "https://localhost:9100/xxxxxx"
  } ],
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Example Preview URI"
}

streaming

ROI画像の受信を終了する。

本APIのレスポンスで返されるURIでROI画像を参照できなくする。

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

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

ROI画像の設定を変更する。

注1: OpenGLで実装する場合、ワールド座標上の長さ1は実世界上の1メートルに換算する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
uri	string	Yes	ROI画像URI。
x	float	No	視点の絶対座標 (x)。ワールド座標上の視点の絶対座標(前後方向)。 単位はメートル。（注1）指定なしの場合は 0.0。
y	float	No	視点の絶対座標 (y)。ワールド座標上の視点の絶対座標(左右方向)。以下、同上。
z	float	No	視点の絶対座標 (z)。ワールド座標上の視点の絶対座標(上下方向)。以下、同上。
roll	float	No	視点の回転 (ロール)。ワールド座標系に対する視点の回転(前後方向の軸中心)。 単位はdegree。角度の範囲は0.0〜360.0。0.0,360.0は撮影時の角度とする。 指定なしの場合は0.0。配信開始時の視点の向きは全方位パノラマ画像の中央点。 回転の順番はroll,pitch, yawの順。
pitch	float	No	視点の回転 (ピッチ)。 ワールド座標系に対する視点の回転(左右方向の軸中心)。以下、同上。
yaw	float	No	視点の回転 (ヨー)。 ワールド座標系に対する視点の回転(上下方向の軸中心)。以下、同上。
fov	float	No	視点の画角。視点の画角。角度の範囲は0.0〜180.0。 単位はdegree。指定なしの場合は90度。
sphereSize	float	No	天球の大きさ。天球の大きさを半径で指定。単位はメートル。 （注1）指定なしの場合は 1。
width	integer	No	ROI画像のサイズ(横)。配信されるROI画像の横サイズ。単位はピクセル。 指定なしの場合は600。 ステレオ画像生成フラグがtrueの場合、 左右それぞれに対しての画像のサイズとして適用される。(よって、ステレオ画像全体としての横幅は2 * width となる)
height	integer	No	ROI画像のサイズ (縦)。 配信されるROI画像の縦サイズ。単位はピクセル。指定なしの場合は400。
stereo	boolean	No	ステレオ画像生成フラグ。 trueの場合、ROI画像がステレオ画像形式で配信されるようになる。(ステレオ画像左右の視点が) 指定なしの場合はfalse。
vr	boolean	No	仮想現実モードフラグ。 trueの場合、仮想現実モード (ホストデバイスの向きとROIの向きを連動させるモード) をONにする。指定なしの場合はfalse。

論理名	物理名	データ型	必須	説明
処理結果	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"
}