焦点画面

功能说明

焦点画面功能允许主持人将某位参会者指定为焦点画面。被指定的参会者会显示在演讲者布局的大画面位置上，而其他参会者的画面则按照语音激励顺序依次排列。

注意：如果会议中已设置主会场或接收共享画面，则焦点画面功能将不生效；

提示

兼容性：Web SDK版本 v3.9.5 及以上版本。

实现方法

1. 启用焦点模式配置

在小鱼易连 Manager 平台，启用企业可见性配置项 “会控焦点模式”（enableFocusMode）；

2. 指定焦点画面

主持人可通过以下两种方式将某参会者指定为焦点画面：

通过会控平台设置；
调用 Web SDK的 startMeetingFocusView 方法，传入目标参会者的 rosterId；

3. 焦点画面事件上报

设置完成后，SDK 会通过 focus-view 事件上报当前焦点画面信息；

被指定为焦点画面的参会者将显示在大画面位置，而其他参会者按语音激励顺序排列；

示例代码

设置焦点画面

仅限主持人和联席主持人调用。其他角色调用将返回错误提示。

/**
 * 设置会议焦点画面
 *
 * @param {string} rosterId - 指定参会者的 rosterId
 * @returns {Promise<IReturnResult>} - 操作结果
 */
await XYClient.startMeetingFocusView(rosterId);

取消焦点画面

/**
 * 取消会议焦点画面
 *
 * @param {string} rosterId - 取消焦点画面的 rosterId
 * @returns {Promise<IReturnResult>} - 操作结果
 */
await XYRTCClient.stopMeetingFocusView(rosterId);

监听焦点画面信息

监听focus-view事件，获取当前焦点画面信息：

XYClient.on('focus-view', (e: IRoster | null) => {
  if (e) {
    console.log('当前焦点画面：', e);
  } else {
    console.log('已取消焦点画面');
  }
});

监听layout信息

获取会议布局更新信息：

XYClient.on('layout', (e: ILayout[]) => {
  console.log('当前布局信息：', e);
});

API参考

方法

事件

2025-01-14 16:36:09

导出PDF文档