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