Skip to content

Canvas Profile

Ryo Mizuno edited this page Nov 2, 2016 · 4 revisions

目次

API 機能概要
Canvas Draw Image API デバイスに画像を描画する。
Canvas Delete Image API デバイスに描画した画像を削除する。

機能概要

デバイスに画像を描画・削除する機能を提供するAPI。

参考API

W3C HTML Canvas 2D Context (11 Drawing images to the canvas)
http://www.w3.org/TR/2dcontext/#drawing-images-to-the-canvas

インターフェース名称 Version 種別
Canvas Draw Image API 2.0.0 同期I/F

概要

デバイスに画像を描画する。

リクエスト

HTTPメソッド URI
POST /gotapi/canvas/drawImage
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
MIMEタイプ mimeType string 表示する画像のMimeType。
ファイルのbinary data byte[] 表示する画像ファイルのbinary。uriと同時に省略することはできない。両方指定した場合の挙動は未定義。
ファイルのURI uri string 表示する画像ファイルのURI。dataと同時に省略することはできない。両方指定した場合の挙動は未定義。
デバイスが持つ空間の左上を原点としたx座標 x int 0~デバイスの空間領域。等倍描画モードの場合のみ有効。
デバイスが持つ空間の左上を原点としたy座標 y int 0~デバイスの空間領域。等倍描画モードの場合のみ有効。
画像描画モード mode string (省略時):等倍描画モード。座標(x, y)に画像の左上隅がくるように描画する。
scales:スケールモード。アスペクト比を保持して最大限に拡大して画面中央に描画する。x, y座標は無効。
fills:フィルモード。等倍の画像を並べて画面全体に敷き詰めるように描画する。x, y座標は無効。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result int - 0:正常応答
0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/canvas/drawImage
Mutipartボディ
Content-Type: multipart/form-data;
boundary=----WebKitFormBoundaryp7MA4YWxkTrZu0gW
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="accessToken"
xxxxx
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="serviceId"
localhost.dconnect.com
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="mimeType"
image/png
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="data"; filename="ic_launcher.png"
Content-Type: image/png
<binary省略>
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="x"
100
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="y"
50----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="mode"
scales
----WebKitFormBoundaryE19zNvXGzXaLvS5C

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}
インターフェース名称 Version 種別
Canvas Delete Image API 2.0.0 同期I/F

概要

デバイスに描画した画像を削除する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/canvas/drawImage
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result int - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/canvas/drawImage?serviceId=xxxx&accessToken=yyyyy

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}
Clone this wiki locally