1.0.4 • Published 9 months ago

pixelstream-cn v1.0.4

Weekly downloads
-
License
ISC
Repository
-
Last release
9 months ago

平台免费使用

第一步 注册账号

前往pixelstream平台注册账号

https://www.pixelstream.cn/


第二步

创建渲染编号


第三步 下载渲染管理端和用例

启动渲染管理端 填写渲染编号 选择用例目录 设置最大启动进程数


第四步 接入jssdk

导入
import pixelStream from "pixelstream-cn";

初始化
let ps = new pixelStream({
  element:document.getElementById("render"),    //设定渲染容器
  keyboard:["a","s","d","w","q","e","F1"," "]    //开放的键盘
});
初始化参数包含
配置项类型说明
encodeKeystring密钥
elementdom渲染容器
keyboardarray开放的键盘按键 默认全部开放
toolsbool是否开启工具条 默认关闭
baseHoststring基础地址 私有云部署用

监听客户端交互事件
ps.message.responseHandel = (response)=>{
  console.log("收到UE发来的消息",response);
};

执行渲染
ps.render("你的渲染编号","画面名称").then(()=>{
  console.log("渲染画面接入完成");
});

发送消息
let data={};    //发送的data结构信息
ps.send(new pixelStream.action("action值",data,false))

发送异步消息
let data={};    //发送的data结构信息
ps.send(new pixelStream.action("action值",data,true)).then(response=>{
  console.log("收到消息回复",response);   //response为UE回复的内容 会将字符串解析为json对象
});
发送字符串消息
ps.sendUIInteraction("发送的内容")
封装自定义动作类 并发送
class MyAction extends pixelStream.action{
  callback=true;    //是否需要回调
  $action="my_action";    //action信息
  $data={message:"hello world"}   //data信息
}
ps.send(new MyAction()).then(response=>{});

结构化设计
  • 为了消除ue4开发人员和web开发人员对一些事物理解上的偏差,本JSSDK提供部分兼容性封装。后续会持续更新;
  • 例如:颜色色值设定,因为UE针对RGB色值采用0-1的范围设定,而web开发普遍以0-255为范围设定,因此pixelStream.structure.Color作为JSSDK提供的色值封装来消除2边的理解误差
let data = new pixelStream.structure.Color(255,0,0,1);
ps.send(new pixelStream.action("setColor",data,false))

关闭(如果没有其他客户端接入该画面,系统将于10秒后回收渲染程序)
ps.close()
1.0.4

9 months ago

1.0.3

9 months ago

1.0.2

9 months ago

1.0.1

9 months ago

1.0.0

9 months ago