Loading...

    API概览

    本文档适用于小鱼易连Web SDK 4.x版本，此版本是基于v3.x版本架构升级版本，需要一定的迁移升级操作；

    提示

    请务必在https协议或者http://localhost域名下集成Web SDK，否则会导致采集音视频流失败问题

    XYRTC

    XYRTC模块是小鱼易连Web SDK提供的全局总入口，提供如下能力：

    1. 创建会议客户端​​XYRTCClient​​模块/日志模块；
    2. 浏览器兼容检测；
    3. 设置国际化语言；
    4. 获取SDK版本信息；

    属性

    属性

    描述

    ​​logger​​

    SDK内部的日志模块

    ​​version​​

    小鱼易连Web SDK的版本和构建时间

    方法

    方法

    描述

    ​​createClient​​

    创建会议客户端​​​​XYRTCClient​​​​模块，提供实时音视频通话框架能力，一次会议创建一次即可

    ​​createLogger​​

    创建自定义Logger日志模块

    ​​checkSupportWebRTC​​

    检测浏览器是否支持WebRTC能力

    ​​checkSupportShareContent​​

    检测浏览器是否支持共享内容能力

    ​​setLocale​​

    设置Web SDK国际化语言

    XYRTCClient类

    音视频通话客户端​​​​ XYRTCClient​​​​ 模块，通过 ​​XYRTC.createClient​​ 创建，代表一次音视频会话，一次入会只需要创建一个客户端模块。客户端模块提供了音视频通话的核心功能，包含以下方法：

    初始化

    方法

    描述

    ​​on​​

    注册监听事件，详见Client事件模块

    ​​setFeatureConfig​​

    设置SDK功能开关

    登录

    方法

    描述

    ​​loginXYlinkAccount​​

    小鱼易连账号登录，即将废弃，建议使用 loginXYAccount

    ​​loginExternalAccount​​

    三方账号登录/授权码登录

    ​​loginXYAccount​​

    三方账号统一认证登录 - 小鱼易连账号登录

    ​​loginExtToken​​

    三方账号统一认证登录 - Token登录

    ​​loginWithAuthCode​​

    三方账号统一认证登录 - 授权码登录

    ​​setLoginTokenInfo​​

    无登录模式调用，需要在调用 ​​makeCall​​ 前配置已登录用户和网关信息

    呼叫

    方法

    描述

    ​​makeCall​​

    发起会议呼叫

    轨道管理

    方法

    描述

    ​​createVideoAudioTrack​​

    创建摄像头和麦克风Track模块

    ​​createContentTrack​​

    创建分享内容Track模块

    媒体管理

    方法

    描述

    ​​getAudioStream​​

    获取音频的Stream数据

    ​​getAudioAnalyser​​

    获取音频的分析器实例，用于获取远端或本地端音频音量大小

    ​​getVideoStream​​

    获取视频的Stream数据

    ​​getSnapshot​​

    指定画面屏幕截图

    ​​muteAudio​​

    关闭麦克风

    ​​muteVideo​​

    关闭摄像头

    ​​unmuteAudio​​

    开启麦克风

    ​​unmuteVideo​​

    开启摄像头

    ​​publish​​

    推送自定义Track轨道流

    ​​removeAudioAnalyser​​

    销毁音频分析器，释放资源

    ​​setTranslationLanguage​​

    通话字幕，设置本地说话的语言

    ​​setVideoProfile​​

    设置上下行视频的分辨率和帧率

    ​​startTranslation​​

    开启通话字幕

    ​​stopTranslation​​

    停止通话字幕

    ​​subscribeBulkRoster​​

    订阅参会者信息，通过​​​​bulkRoster​​​​事件监听详细内容

    拉流/布局

    方法

    描述

    ​​forceFullScreen​​

    自动布局-设置指定参会者全屏显示画面

    ​​playAudio​​

    音频播放异常情况下，重新播放会中声音

    ​​playLocalVideo​​

    画面播放异常情况下，重新播放本地视频

    ​​playVideo​​

    画面播放异常情况下，重新播放指定参会终端画面

    ​​requestNewLayout​​

    自定义布局-请求参会者的视频流，可以配置分辨率和帧率数据

    ​​requestAutoPollingLayout​​

    自定义布局-自动轮询请求参会者的视频流

    ​​removeAudioRender​​

    移除音频播放容器元素，释放资源

    ​​removeVideoRenderer​​

    移除视频播放容器元素，释放资源

    ​​removeSlaveVideoRenderer​​

    移除重复视画面频播放容器元素，释放资源

    ​​setAudioRenderer​​

    设置音频播放容器元素，SDK接管控制音频的播放

    ​​setFocusView​​

    自动布局-本地切换主画面

    ​​setPageInfo​​

    自动布局-翻页查看更多参会者画面

    ​​setVideoRenderer​​

    设置视频播放容器元素，SDK接管控制视频的播放和画面渲染

    ​​setLocalViewParams​​

    设置本地画面渲染参数

    ​​setSlaveVideoRenderer​​

    设置重复画面视频播放容器元素，SDK接管控制视频的重复播放和画面渲染

    ​​switchLayout​​

    自动布局-切换显示布局模式，默认是演讲者模式（SPEAKER）

    ​​setLayoutConfig​​

    自动布局-设置布局配置

    ​​setLayoutOrientation​​

    自动布局-设置移动端布局方向

    ​​setHideLocalView​​

    自动布局-会中动态切换显示/隐藏本地画面

    ​​updateLayoutSize​​

    自动布局-手动触发更新布局列表中的位置和尺寸信息

    会议操作/获取信息

    方法

    描述

    ​​checkMeetingNumber​​

    校验会议室号和入会密码

    ​​checkMeetingPassword​​

    校验会议室入会密码

    ​​getMeetingInviteInfo​​

    获取会议分享详情信息

    ​​getSelfRoster​​

    获取本地的参会者数据，包含用户基本信息、会议状态信息

    ​​toggleHideId​​

    隐身入会, 可调用此方法进行切换显示/隐藏状态

    会议调度

    方法

    描述

    ​​bindTrackGroup​​

    关联audio track与mediaGroupId通道，从而向特定通道发送音频数据

    ​​getConference​​

    获取随机云会议室

    ​​setPollingAudioStatus​​

    设置调度模式下设备的声音状态

    ​​startMonitor​​

    开始调度设备

    ​​startMonitorGroup​​

    启用多分组通道，进行多分组请流和资源创建

    ​​stopMonitor​​

    停止调度设备

    ​​stopMonitorGroup​​

    停止多分组通道，销毁资源

    录制

    方法

    描述

    ​​startCloudRecord​​

    开启云端录制

    ​​stopCloudRecord​​

    停止云端录制

    会控操作

    方法

    描述

    ​​endAllMeeting​​

    结束全体会议

    ​​getConfMgmtUrl​​

    获取当前会议会控H5地址

    ​​nextPollingPage​​

    轮询切换到下一页

    ​​onHandDown​​

    取消举手

    ​​onHandUp​​

    举手发言

    ​​onMute​​

    结束发言

    ​​rename​​

    修改本地参会者名称

    ​​sendVideoControlResult​​

    通知会控打开/关闭摄像头结果

    ​​signIn​​

    签到

    ​​startMeetingFocusView​​

    设置焦点画面

    ​​stopMeetingFocusView​​

    取消焦点画面

    ​​verifyControlPassword​​

    校验会控主持密码

    挂断会议

    方法

    描述

    ​​destroy​​

    挂断会议，销毁资源

    ​​off​​

    取消注册监听事件

    其他

    方法

    描述

    ​​sendCustomMessage​​

    发送自定义消息

    ​​​​setServerAddress​​​​

    设置服务器地址

    ​​switchDebug​​

    切换调试模式，控制发送和接收路所有流质量数据上报，通过监听 ​​meeting-stats​​ 事件获取数据

    ​​switchFeatureConfig​​

    动态切换功能开关

    事件

    客户端Client模块提供了多种类型的事件消息，开发者根据需求自行订阅监听，所有事件内容如下：

    会控

    事件Key

    描述

    ​​cancel-handup​​

    清除举手事件

    ​​focus-view​​

    焦点画面事件

    ​​interactiveToolInfo​​

    会控互动工具相关数据, 签到事件

    ​​meeting-control​​

    会控事件，包含麦克风静音/非静音、是否强制静音、主会场设备、对话模式等状态和信息

    ​​meeting-control-video​​

    会控上报开启/关闭摄像头事件

    ​​notification​​

    会控联席主持人/主持人/改名权限变更事件

    ​​onhold​​

    会控启用/关闭等候室事件

    ​​sub-title​​

    点名/滚动字幕事件

    会议状态/信息

    事件Key

    描述

    ​​audio-status​​

    本地麦克风状态事件

    ​​call-status​​

    会议呼叫状态事件

    ​​conference-info​​

    云会议室信息

    ​​disconnected​​

    强制挂断会议消息，收到此消息时，需要进行退出会议操作

    ​​enterprise-config​​

    企业配置信息(头像配置、禁用语音转写英文翻译)

    ​​layout-state​​

    轮询状态事件

    ​​media-changed-migrate​​

    媒体迁会事件

    ​​user-info​​

    登录用户信息和个人云会议室信息数据

    ​​video-status​​

    本地摄像头状态事件

    拉流/布局

    事件Key

    描述

    ​​conf-change-info​​

    会议人员数量/共享内容/主会场等发生变化事件

    ​​content​​

    当前正在共享内容的参会者信息

    ​​container-resize​​

    自动布局-布局容器尺寸变化事件

    ​​force-full-screen​​

    自动布局-参会人员强制全屏显示事件

    ​​layout​​

    参会成员布局列表数据，包含参会者基本信息、位置、尺寸、旋转等数据（自定义布局不包含位置、尺寸、旋转数据）

    ​​page-info​​

    自动布局-分页数据

    ​​rotation-change​​

    参会者视频画面旋转信息

    ​​screen-info​​

    自动布局-布局容器尺寸和位置信息

    ​​template-mode​​

    自动布局-当前布局模式

    媒体

    事件Key

    描述

    ​​audio-track​​

    音频轨道Tracks数据

    ​​bulkRoster​​

    订阅Roster事件（参会者数据）

    ​​in-out-reminder​​

    参会者出入会信息

    ​​networkLevel​​

    本地端网络质量等级

    ​​networkParameter​​

    监听远端参会者网络质量等级

    ​​participants-count​​

    会议总人数事件

    ​​roster​​

    参会者列表事件（仅上报前20路，包含本地数据）

    ​​speaker-info​​

    语音激励人员信息

    ​​speakers-info​​

    实时讲话人信息（最多3三路数据）

    ​​translation-content​​

    通话字幕内容

    ​​video-track​​

    视频轨道事件

    会议调度

    事件Key

    描述

    ​​multi-group-info​​

    多分组通道信息事件

    ​​start-monitor-report​​

    调度成功事件

    ​​stop-monitor-report​​

    停止调度事件

    录制

    事件Key

    描述

    ​​recording-state-changed​​

    本地录制结果上报事件

    ​​record-status-notification​​

    上报远端录制状态

    ​​record-permission​​

    录制权限事件

    其他

    事件Key

    描述

    ​​custom-message-recv​​

    远端推送的自定义消息

    ​​error​​

    错误事件

    ​​meeting-stats​​

    会议质量数据，包含接收/发送方的分辨率、带宽、码率、帧率、丢包等调试数据

    ​​play-failed​​

    播放音视频失败事件

    VideoAudioTrack

    摄像头和麦克风轨道实例，通过此实例可实现如下功能：

    1. 创建麦克风和摄像头流，如果是同时创建，则仅需授权一次权限，如果是单独创建麦克风或者摄像头流，则分别按需授权设备权限；
    2. 连接/启动AI插件处理器，可支持任意插件以管道流形式接入处理视频流；
    3. 提供设备/权限/错误信息等事件上报能力；
    4. 切换设备功能、切换前后置摄像头功能；
    5. 获取音频实时音量大小功能；

    属性

    属性

    描述

    ​​processorDestination​​

    AI插件-摄像头和麦克风轨道处理器链路的最终节点

    方法

    VideoAudioTrack 实例包含以下方法，同时继承 BaseTrack 类，拥有 BaseTrack 类的属性和方法；

    方法

    描述

    ​​capture​​

    采集麦克风和摄像头流，支持分别采集

    ​​close​​

    销毁当前Track资源

    ​​connect​​

    AI插件-连接插件处理器

    ​​getAudioLevel​​

    获取本地麦克风实时音量大小，范围：0-100

    ​​off​​

    取消监听事件

    ​​on​​

    监听事件

    ​​switchCamera​​

    切换前后置摄像头

    ​​switchDevice​​

    切换麦克风/摄像头/扬声器设备

    事件

    VideoAudioTrack实例包含以下事件：

    事件Key

    描述

    ​​device​​

    监听设备列表数据

    ​​permission​​

    监听设备授权权限变动状态

    ​​track-error​​

    监听轨道异常信息

    ContentTrack

    共享桌面/应用内容轨道实例，通过此实例可实现如下功能：

    1. 创建和销毁共享屏幕/应用/网页标签流；
    2. 获取采集流异常信息；

    方法

    ContentTrack实例包含以下方法：

    方法

    描述

    ​​capture​​

    采集屏幕/应用/网页标签视频流、支持在共享过程中，采集新的视频流

    ​​close​​

    结束共享内容，释放资源

    ​​createElectronContentStream​​

    创建Electron共享视频流

    ​​getElectronContentSources​​

    获取Electron采集资源信息

    ​​off​​

    取消监听事件

    ​​on​​

    监听事件

    ​​pause​​

    暂停分享

    ​​resume​​

    暂停分享

    事件

    ContentTrack实例包含以下事件：

    事件Key

    描述

    ​​start-share-content​​

    监听可以开始推送共享内容事件，当遇到权限等原因被拒绝后，则收不到此信息

    ​​stop-share-content​​

    监听结束共享内容事件，例如通过会控结束共享，则需要在此事件中结束本地共享内容

    ​​track-error​​

    监听轨道异常信息

    Logger模块

    小鱼易连Web SDK提供了本地日志模块，可以供开发者自定义创建日志模块或使用SDK内置的日志模块，通过设置日志等级，可以控制输出到控制台的内容，同时提供了上传/下载日志功能，方便开发者遇到问题时能快速反馈日志；

    无论是自定义日志还是SDK内置的日志模块，调用日志模块提供的方法时，会全量写入到本地日志文件中，不受日志等级的约束；

    日志模块提供如下的方法：

    方法

    描述

    ​​debug​​

    控制台输出调试信息，并写入日志

    ​​downloadLog​​

    下载日志数据到本地，可在浏览器控制台中调用

    ​​error​​

    控制台输出错误信息，并写入日志

    ​​fatal​​

    输出致命信息，并写入日志

    ​​log​​

    控制台输出LOG信息，并写入日志

    ​​setLogLevel​​

    调试模式下，控制台输出日志的等级

    ​​setLogServer​​

    设置日志服务器地址

    ​​uploadLog​​

    上传日志到小鱼服务器

    ​​warn​​

    控制台输出警告信息，并写入日志

    Helper模块

    小鱼易连Web SDK提供了一个Helper函数模块，方便开发者快速实现部分功能，提供了如下静态方法：

    方法

    描述

    ​​getLayoutRotateInfo​​

    自定义布局，辅助计算参会者在旋转画面时的旋转信息

    ​​getSendSupportedCodec​​

    获取浏览器支持的编解码器列表

    ​​getVideoInfoByRotation​​

    获取真实视频分辨率的宽高、比值

    ​​setOutputAudioDevice​​

    辅助函数，用于切换音频输出设备


    2024-07-22 11:10:10
    意见反馈