API列表

[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	要顯示的文本支持的標籤: Rich Text
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時請直接寫group名即可，例如 "tap" type值為1時，此處填寫動作文件相對路徑，例如「motion1.mtn」

[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	屏幕像素點橫坐標（屏幕左下角為原點）
posY	int	屏幕像素點縱坐標（屏幕左下角為原點）

[14000] 設置特效¶

描述¶

設置特效並移除其他特效

示例¶

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

參數	類型	描述
data	int	特效ID，詳見ID列表

ID List¶

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列表