API 一覧

翻訳について

本ドキュメントはChatGPT-4によって翻訳されており、内容に不正確な部分が含まれる可能性があります。

[10000] モデルイベントリスナーを登録¶

説明¶

モデルイベントリスナーを登録する

例¶

{
  "msg": 10000,
  "msgId": 1
}

応答¶

{
  "msg": 10000,
  "msgId": 1
}

[10001] モデルイベントリスナーの登録を解除¶

説明¶

モデルイベントリスナーの登録を解除する

例¶

{
  "msg": 10001,
  "msgId": 1
}

[10002] モデルイベント通知を受信¶

説明¶

モデルがイベントをトリガーした場合、登録済みのクライアントに通知を送信する

応答¶

{
  "msg": 10002,
  "msgId": 1,
  "data": {
    "type": 0,
    "id": 0,
    "modelId": "myModelId",
    "hitArea": "myHitArea"
  }
}

パラメータ	型	説明
type	int	イベントタイプ
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
modelId	string	モデルID（モデル制作者による設定可能）、空でも可
hitArea	string	トリガーされたエリア名、空でも可

イベントリスト¶

タイプ	説明
0	タップイベント（Tap）

[11000] 吹き出しテキストを表示¶

説明¶

指定されたモデルにテキスト吹き出しを表示する

例¶

{
  "msg": 11000,
  "msgId": 1,
  "data": {
    "id": 0,
    "text": "Hello this is control panel.",
    "choices": [
      "Open Baidu",
      "Open Google"
    ],
    "textFrameColor": 0x000000,
    "textColor": 0xFFFFFF,
    "duration": 3000
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
text	string	表示するテキストサポートされるタグ: リッチテキスト
choices	array	ボタンオプション
textFrameColor	int	テキストボックスの色（RGB値、例：0xFFFFFF）
textColor	int	テキストの色（RGB値、例：0xFFFFFF）
duration	int	表示時間（ミリ秒単位） -1に設定すると吹き出しが自動で消えなくなります。

応答¶

{
  "msg": 11000,
  "msgId": 1,
  "data": 0 //クリックされたボタンの番号
}

[12010] 背景を設定¶

説明¶

通常の背景を設定する

例¶

{
  "msg": 12010,
  "msgId": 1,
  "data": {
    "id": 1,
    "file": "D:\Wallpaper\360background.png"
  }
}

パラメータ	型	説明
id	int	ディスプレイ番号（0から始まる）、例：ディスプレイ#1の番号は0
file	string	背景ファイルパス

サポートされる形式¶

タイプ	フォーマット
Image	".png", ".jpg", ".jpeg"
Video	".mp4", ".mkv", ".mov", ".avi", ".webm", ".wmv"
Web	".html", ".htm", ".xhtml"

[12110] 360度パノラマ背景を設定¶

説明¶

360度パノラマ背景を設定する

例¶

{
  "msg": 12110,
  "msgId": 1,  
  "data": {
    "id": 1,
    "file": "D:\Wallpaper\360background.png"
  }
}

パラメータ	型	説明
id	int	ディスプレイ番号（0から始まる）、例：ディスプレイ#1の番号は0
file	string	背景ファイルパス

サポートされる形式¶

タイプ	フォーマット
Image	".png", ".jpg", ".jpeg"
Video	".mp4", ".mkv", ".mov", ".avi", ".webm", ".wmv"

[13000] モデルを設定¶

説明¶

モデルを設定する。現在はjsonモデルのみサポート

例¶

{
  "msg": 13000,
  "msgId": 1,
  "data": {
    "id": 1,
    "file": "D:\Unity Works\Sample\Kurumi\kurumi.model.json"
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
file	string	*.model.jsonファイルパス

[13100] モデルを削除¶

説明¶

モデルを削除する

例¶

{
  "msg": 13100,
  "msgId": 1,
  "data": 1
}

パラメータ	型	説明
data	int	モデル番号（0から始まる）、例：モデル#1の番号は0

[13200] 動作をトリガー¶

説明¶

動作をトリガーする

例¶

{
  "msg": 13200,
  "msgId": 1,
  "data": {
    "id": 1,
    "type": 0,
    "mtn": "group:motion"
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
type	int	タイプ
mtn	string	typeが0の場合、形式は「group:motion」、例："tap:mtn1" ※ motionを指定しない場合、グループ名のみ記述してください（例："tap"）。 typeが1の場合、この欄には動作ファイルの絶対パスを記述（例："C:\mtn.motion3.json"）。

[13300] 表情を設定¶

説明¶

表情を設定する

例¶

{
  "msg": 13300,
  "msgId": 1,
  "data": {
    "id": 1,
    "expId": 1
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
expId	int	表情ID

[13301] 次の表情¶

説明¶

次の表情を設定する

例¶

{
  "msg": 13301,
  "msgId": 1,
  "data": 0
}

パラメータ	型	説明
data	int	モデル番号（0から始まる）、例：モデル#1の番号は0

[13302] 表情をクリア¶

説明¶

表情をクリアする

例¶

{
  "msg": 13302,
  "msgId": 1,
  "data": 0
}

パラメータ	型	説明
data	int	モデル番号（0から始まる）、例：モデル#1の番号は0

[13400] 位置を設定¶

説明¶

位置を設定する

例¶

{
  "msg": 13302,
  "msgId": 1,
  "data": {
    "id": 0,
    "posX": 200,
    "posY": 300
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
posX	int	画面ピクセルのX座標（画面左下が原点）
posY	int	画面ピクセルのY座標（画面左下が原点）

[13500] 音声を再生¶

説明¶

音声を再生します。サポートされる形式はMP3、OGG、WAVです。

例¶

{
  "msg": 13500,
  "msgId": 1,
  "data": {
    "id": 0,
    "channel":0,
    "volume":1,
    "delay":0,
    "loop":false,
    "type":0，
    "sound":"C:\\test.mp3"
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
channel	int	サウンドチャンネル（0、1、2から選択可能）
volume	float	音量（範囲：0-1）
delay	int	再生の遅延時間（ミリ秒単位）
loop	bool	ループ再生するかどうか（trueまたはfalse）
type	int	データタイプ
sound	string	typeが0の場合、ファイルの絶対パスを記入 typeが1の場合、音声バイナリデータをBase64エンコードした文字列を記入

ヒント

モデルを切り替えると、すべてのチャンネルの音声が停止します。
モデルはデフォルトでチャンネル0を使用してボイスを再生します。ボイスがトリガーされるとチャンネル0で再生中の音声が中断されます。BGMをループ再生する場合は、チャンネル1または2を使用することを推奨します。
soundフィールドを使用してバイナリデータを渡す場合、データ量を減らすためにMP3またはOGG形式を使用することを推奨します。

[13501] 音声を停止¶

説明¶

音声を停止します。

例¶

{
  "msg": 13501,
  "msgId": 1,
  "data": {
    "id": 0,
    "channel":0
  }
}

パラメータ	型	説明
id	int	モデル番号（0から始まる）、例：モデル#1の番号は0
channel	int	サウンドチャンネル（0、1、2から選択可能）

[14000] エフェクトを設定¶

説明¶

エフェクトを設定し、他のエフェクトを削除する

例¶

{
  "msg": 14000,
  "msgId": 1,
  "data": 100100
}

パラメータ	型	説明
data	int	エフェクトID（IDリストを参照）

IDリスト¶

ID	説明
100100	雨
100110	雪

[14100] エフェクトを追加¶

説明¶

エフェクトを追加する

例¶

{
  "msg": 14100,
  "msgId": 1,
  "data": 100100
}

パラメータ	型	説明
data	int	エフェクトID（IDリストを参照）

[14200] エフェクトを削除¶

説明¶

指定されたIDのエフェクトを削除。すべてのエフェクトを削除するには-1を設定

例¶

{
  "msg": 14200,
  "msgId": 1,
  "data": 100100
}

パラメータ	型	説明
data	int	エフェクトID（IDリストを参照）