OmnidirectionalImage Profile

目次

API	機能概要
ROI View Start API	ROI画像の受信を開始する。
ROI View Settings API	ROI画像の設定を変更する。
ROI View Stop API	ROI画像の受信を終了する。

機能概要

全方位パノラマ画像をROI画像へ変換する機能を提供する。

参考API

なし

ROI View Start API

インターフェース名称	Version	種別
ROI View Start API	2.0.0	同期I/F

概要

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

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

リクエスト

HTTPメソッド	URI
PUT	/gotapi/omnidirectional_image/roi

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	本APIを提供するサービスのID
全方位パノラマ画像URI	source	string	-	ROI画像に変換する全方位パノラマ画像のURI

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
ROI画像配信サーバURI	uri	string	-	ROI画像を配信するサーバのURIを示す。配信される画像の形式はMotionJPEGとする。

リクエストサンプル

GET http://localhost:4035/gotapi/omnidirectional_image/roi?servieId=localhost.dconnect.com&accessToken=xxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
    "uri": "http://localhost:9000/xxxxx"
}

ROI View Settings API

インターフェース名称	Version	種別
ROI View Settings API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
PUT	/gotapi/omnidirectional_image/roi/settings

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

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

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

GET http://localhost:4035/gotapi/battery/charging?servieId=localhost.deviceconnect.org&accessToken=xxxxx&width=600&height=400

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

ROI View Stop API

インターフェース名称	Version	種別
ROI View Stop API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
DELETE	/gotapi/omnidirectional_image/roi

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	本APIを提供するサービスのID
ROI画像URI	uri	string	-	ROI画像のURI

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

GET http://localhost:4035/gotapi/battery/chargingTime?servieId=localhost.deviceconnect.org&accessToken=xxxxx&uri=http://localhost:9000/xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}