larksr_websdk
v3.3.102
Published
Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://paraversetechnology.github.io/en/webclient_sdk/
Downloads
290
Readme
LarkSR-WebClient-SDK-En
Develop webclient for LarkSR cloudrending or LarkSR VR monitor client. Free design UI and define operate.
Links:
SDK include:
- LarkSR restful request.
- CloudRending Video.
- Handle input, keyboard, gamepad, touchscreen.
- Scale mode.
- Fullscreen mode.
- Landscap mode.
Notice
SDK V3.2.30 only support server version above V3.2.3.1 Old verion SDK Demo V3.2.314 server and datachannel above 3.2.5.1
Quick Start
install
- npm
npm i larksr_websdk
- plain html
<script src="larksr-web-sdk.min.js"></script>
Use
Import websdk with plain html SDK under global object larksr_websdk.
Connect cloud resource and all event access with new LarkSR object.
SDK default config html 100% height 100% width viewport. Auto handle input.
SDK mainly contain loading page and cloud video page no other ui.efore start:
- Lark SR server address, exp:http://222.128.6.137:8181/
- SDK auth code,connect [email protected]
- App id from Lark SR admin server applist.
var client = new LarkSR({
// root html element
// WARNING not document.documentElement
rootElement: document.getElementById('container'),
// Sever address
serverAddress: "Lark Sever address",
// SDK ID or set by call initSDKAuthCode
// authCode: 'your SDK ID',
// test backgroud url
// loadingBgUrl: 'https://home-obs.pingxingyun.com/homePage_4_0/bg.jpg',
});
Set sdk auth code.
client.initSDKAuthCode('Your SDK ID')
.then(() => {
// start connect;
client.connect({
// LarkSR cloud appid from LarkSR admin server.
// doc
// https://www.pingxingyun.com/online/api3_2.html?id=476
appliId: "appid from LarkSR admin"
})
.then(() => {
console.log('enter success');
})
.catch((e) => {
console.error(e);
});
})
.catch((e) => {
console.error(e);
});
// ...
// close connection.
// client.close();
// release DOM element.
// client.destroy();
Doc
LarkSR-WebClient-SDK-Zh
SDK 适用于自定义 LarkSR 云渲 Web 客户端或者自定义 VR 监控画面客户端的二次开发,自定义 UI 和操作逻辑等。有较高的灵活性。
对于不需要二次开发,或者简单修改,可以参照使用 iframe 的接入方式,将标准 Web 客户端网页嵌入到系统中去。
参考连接:
SDK 功能包括:
- 处理后台请求和接口
- 云渲染视频拉取显示
- 输入方式包括鼠标,键盘,手柄,触摸, 并提供输入接口和控制内部输入方式开启接口
- 显示和缩放模式,默认以浏览器视口为容器大小, 视频窗口保留宽高比并且不会拉伸完全显示。并可配置
- 处理全屏模式,并可配置
- 自动处理横屏模式,手机端强制横屏模式,并可配置
注意
V3.2.30 开始仅支持服务端 V3.2.3.1 以上版本。 老版本 SDK Demo 下载 V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
快速接入
安装
- npm 方式
npm i larksr_websdk
- 直接引入
<script src="larksr-web-sdk.min.js"></script>
使用
使用前应准备好
- Lark 服务器前台可访问的地址, 如:http://222.128.6.137:8181/
- SDK 授权码,联系 [email protected] 获取, 注意是 SDK 本身的授权码,不是服务器上的授权
- 系统中获取的应用 ID,如 http://222.128.6.137:8181/ 系统下的 879408743551336448
var client = new LarkSR({
// 设置挂载显示的元素
// 注意*不要*设置为 document.documentElement
rootElement: document.getElementById('container'),
// 服务器地址,实际使用中填写您的服务器地址
// 如:http://222.128.6.137:8181/
// 当使用平行云托管服务时服务器地址自动分配,可留空。
// larksr.connectWithPxyHost 进入应用
serverAddress: "Lark 服务器前台地址",
// SDK ID 也可在 initSDKAuthCode 设置
authCode: '您的 SDK ID',
// 测试载入背景图
// loadingBgUrl: 'https://home-obs.pingxingyun.com/homePage_4_0/bg.jpg',
});
// start connect;
// 使用平行云托管服务时,用 connectWithPxyHost 进入应用并自动分配服务器.
client.connect({
// 要使用的云端资源的应用 ID,从后云雀后台接口获取
// 参考查询应用一栏文档
// https://www.pingxingyun.com/online/api3_2.html?id=476
// 如 222.128.6.137:8181 系统下的 879408743551336448 应用
appliId: "应用ID"
})
.then(() => {
console.log('enter success');
})
.catch((e) => {
console.error(e);
});
// ...
// 主动关闭并清理资源
// client.close();
SDK 加载成功之后,非模块模式下,SDK 挂载为全局对象 larksr_websdk。
连接云端资源,管理生命周期和事件等主要在 LarkSR 对象下。
默认情况下自动连接云端资源,将容器设置为浏览器视口高度,并配置网页 100% 宽高显示。SDK 内部自动处理按键输入输出。
SDK 只包含 loading,内部不包含其他 UI。主要目的时二次开发云渲染客户端自定义 UI 使用。
参考 DEMO 和文档
更多使用方式和 API 文档可以参考下面项目和 doc 文件夹下的详细文档