@zxyf/ftfsync
v1.3.12
Published
FTF remote web page syncing is a non-video screen sharing technology
Downloads
3
Maintainers
Readme
FTF Sync
FTF 远程同屏是一种非视频类同屏技术,由中新云服(北京)科技有限公司研发,其广泛应用于网页同屏技术领域,集成了网页同步,即时音视频,涂鸦同步等核心能力,实现线上“屏对屏、面对面”的远程交流效果。
FTF远程同屏通过 FTF 云服务对外开放,支持 SaaS 与私有化使用,致力于帮助使用者快速搭建低成本、低代码、低流量、低延时、高品质的同屏互动解决方案。
相较于视频类同屏技术(会议屏幕共享、远程桌面工具),FTF远程同屏具有易接入、支持广、功能全的特色,以及数据传输小、多向交互控制、画质无损、存储小、全程可回溯等优势。
可支持接入到移动端APP、PC 、Web 、微信(企业微信、小程序、公众号)等。
FTF 远程同屏有三种模式,本文档以其中一种模式(该模式接入简单,性能中等)为例,如需其它模式请注册 FTF 远程同屏申请试用
1. 接入前准备
首先通过以下方式启动创建一个FTF
import { createFTF } from '@zxyf/ftfsync';
const ftf = await createFTF();
此时会弹出下载使用的页面,如图
提交姓名、邮箱、手机号等注册信息后,商务经理会与您联系并提供同屏库、对接文档以及授权码connectCode
。
2. 接入Demo
获得同屏库、对接文档以及授权码connectCode
后,您可以按照以下方式接入:
- 在您的主页面引入同屏库
<!-- 引入同屏库 -->
<script src="./ftf-sync.js"></script>
- 在您的业务代码集成FTF
import { createFTF } from '@zxyf/ftfsync';
const query = new URLSearchParams(location.search);
// 创建FTF实例
const ftf = await createFTF({
// connectCode 获取方式: 传空值,然后通过注册页面获取connectCode以及同屏文档
connectCode: '',
// 同屏房间ID
roomId: query.get('roomId'),
// 同屏区域
panelEl: document.getElementById('app')
});
console.log(ftf);
3. 详细文档
在您申请使用之后,商务经理将同步提供详细文档。