文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>腾讯会议>开放平台文档>客户端 API>JSAPI 参考>JSAPI 概览

JSAPI 概览

最近更新时间：2024-12-03 16:11:59

我的收藏

本页目录：

基础

模块
API 名称
描述
Android
iOS
Windows
Mac
鉴权
第三方应用 JSAPI 鉴权。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
企业自建应用 JSAPI 鉴权配置。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
检查当前应用的 JSAPI 鉴权状态。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
授权登录
授权手机号获取动态令牌。
v3.11.0+
v3.11.0+
v3.11.0+
v3.11.0+
客户端信息
获取应用当前运行的场景值。
v3.11.0+
v3.11.0+
v3.11.0+
v3.11.0+
获取当前客户端信息。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
获取当前客户端版本。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
与当前版本做对比。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
判断是否在客户端的 webview环境。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
用户信息
查看用户基础信息权限。
v3.2.0+
v3.2.0+
v3.2.0+
v3.2.0+
获取用户通过专属链接入会时携带的 CustomerData。
v3.2.0+
v3.2.0+
v3.2.0+
v3.2.0+

界面

模块
API 名称
描述
Android
iOS
Windows
Mac
客户端设置
打开客户端 loading 页。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
关闭客户端 loading 页。
v3.0.0+
v3.0.0+
v3.0.0+
v3.0.0+
设置腾讯会议窗口全屏。
-
-
v3.0.0+
v3.0.0+
退出腾讯会议窗口全屏。
-
-
v3.0.0+
v3.0.0+
应用设置
切换应用布局。
-
-
v3.6.0+
v3.6.0+
查询应用布局。
v3.9.0+
v3.9.0+
-
-
设置应用在屏幕共享时是否能被屏幕共享流抓取。
-
-
v2.16.0+
v2.16.0+
WebView设置
关闭当前 webview。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
设置 webview 头部通栏背景颜色。
v3.9.0+
v3.9.0+
-
-
设置 webview“更多”菜单中选项显隐。
v2.20.0+
v2.20.0+
v2.20.0+
v2.20.0+
使用外部浏览器打开外部 URL。
v3.13.0+
v3.13.0+
v3.13.0+
v3.13.0+
虚拟背景设置
配置虚拟背景。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
设置虚拟背景为模糊背景或空背景。
v3.11.0+
v3.11.0+
v3.11.0+
v3.11.0+
唤起虚拟背景设置页。
v3.11.0+
v3.11.0+
v3.11.0+
v3.11.0+
渲染组件
创建渲染原生视频组件的上下文（LiveVideoContext ）对象。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+

会议管理

API

模块
API 名称
描述
Android
iOS
Windows
Mac
获取会议信息
获取会中成员音频设备状态。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
获取会中成员视频设备状态。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
获取当前会议信息。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
获取当前会议的参会者列表。
v3.2.0+
v3.2.0+
v3.2.0+
v3.2.0+
会中协同
应用分享配置。
v3.30.0+
v3.30.0+
v3.30.0+
v3.30.0+
唤起原生应用分享 UI。
v3.30.0+
v3.30.0+
v3.30.0+
v3.30.0+
调起共享应用窗口的确认框。
-
-
v3.10.0+
v3.10.0+
配置 webview 顶部工具栏和屏幕共享预览页内共享入口的显隐。
-
-
v3.10.0+
v3.10.0+
调起结束共享应用画面的确认框。
-
-
v3.10.5+
v3.10.5+
发起移动端的屏幕共享。
v3.10.0+
v3.10.0+
-
-
结束移动端的屏幕共享。
v3.10.5+
v3.10.5+
-
-
一起用模式
发起一起用模式。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+
结束一起用模式。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+
加入一起用模式。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+
离开一起用模式。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+
获取当前一起用模式相关信息。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+
设置一起用配置项。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+

事件

模块
事件名称
描述
Android
iOS
Windows
Mac
会中协同
应用分享结果事件。
v3.30.0+
v3.30.0+
v3.30.0+
v3.30.0+
应用共享状态事件。
-
-
v3.10.0+
v3.10.0+
用户屏幕共享状态。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
一起用模式的状态发生变化。
v3.12.0+
v3.12.0+
v3.12.0+
v3.12.0+

媒体与设备管理

模块
API 名称
描述
Android
iOS
Windows
Mac
蓝牙
初始化蓝牙设备。
v3.14.0+
-
-
-
扫描发现外围设备。
v3.14.0+
-
-
-
连接蓝牙设备。
v3.14.0+
-
-
-
获取外围设备提供的服务。
v3.14.0+
-
-
-
获取服务的特征 characteristics。
v3.14.0+
-
-
-
读写服务的特征值。
v3.14.0+
-
-
-
关闭蓝牙适配器。
v3.14.0+
-
-
-
断开蓝牙连接。
v3.14.0+
-
-
-
停止扫描发现外围设备
v3.14.0+
-
-
-
监听蓝牙低功耗连接状态改变事件、监听蓝牙适配器状态变化事件。
v3.14.0+
-
-
-
图片管理
选择图片。
v3.12.0+
v3.12.0+
-
-
压缩图片。
v3.12.0+
v3.12.0+
-
-
文件管理
保存文件到本地。
v2.19.0+
v2.19.0+
v2.19.0+
v2.19.0+

事件监听

API

API 名称
描述
Android
iOS
Windows
Mac
添加监听事件。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
取消监听事件。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
取消所有对某个事件的监听。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+
取消所有监听事件。
v2.17.0+
v2.17.0+
v2.17.0+
v2.17.0+

事件

事件名称
描述
Android
iOS
Windows
Mac
侧边栏应用位置发生变化时，触发此事件。
-
-
v2.17.0+
v2.17.0+
会中自身信息发生变化时，触发此事件。
v3.8.6+
v3.8.6+
v3.8.6+
v3.8.6+
语音激励成员发生变化时，触发此事件。
v3.9.2+
v3.9.2+
v3.9.2+
v3.9.2+
用户音频状态变化事件时，触发此事件。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
user-join
用户加入会议时，触发此事件。
v3.9.0+
v3.9.0+
v3.9.0+
v3.9.0+
中国站
目录