音视频通话

房间自定义属性

功能介绍

房间自定义属性用于在房间维度存储业务侧需要的键值信息,例如会议主题、当前主持人、业务状态标记等。同一房间内的与会成员可共享这些字段。

本模块提供完整的生命周期能力:设置整包属性、查询全部或指定键、增量添加或更新、按键删除以及清空全部属性;各操作通过异步接口发起,结果在对应回调中返回。

1. 设置房间属性

  • 调用接口:
const rtcsdk = new RTCSDK();

const meetAttrs = '{"MeetingName":"xxx","departmentName":"xxx"}';
rtcsdk.setMeetingAttrs(meetAttrs, "", "");
  • 回调通知:
rtcsdk.on('setMeetingAttrsRslt', (data) => {
    const { sdkErr } = data;
    if (sdkErr === 0) {
        // 成功
    }
});

相关 API 请参考:

2. 获取房间属性

  • 调用接口:
const rtcsdk = new RTCSDK();
rtcsdk.getMeetingAllAttrs("");
  • 回调通知:
rtcsdk.on('getMeetingAllAttrsSuccess', (data) => {
    const { attrs } = data;
    // 获取会议属性成功
});

rtcsdk.on('getMeetingAllAttrsFail', (data) => {
    const { sdkErr } = data;
    // 获取会议属性失败
});

相关 API 请参考:

3. 获取房间特定属性

  • 调用接口:
const rtcsdk = new RTCSDK();
const keys = '["MeetingName", "CompanyName"]';
rtcsdk.getMeetingAttrs(keys, "");
  • 回调通知:
rtcsdk.on('getMeetingAttrsSuccess', (data) => {
    const { attrs } = data;
    // 获取会议属性成功
});

rtcsdk.on('getMeetingAttrsFail', (data) => {
    const { sdkErr } = data;
    // 获取会议属性失败
});

相关 API 请参考:

4. 添加或更新属性

  • 调用接口:
const rtcsdk = new RTCSDK();
const meetAttrs = '{ "MeetingName":"xxx" }';
rtcsdk.addOrUpdateMeetingAttrs(meetAttrs, "", "");
  • 回调通知:
rtcsdk.on('addOrUpdateMeetingAttrsRslt', (data) => {
    if (data.sdkErr === 0) {
        // 成功
    }
});

相关 API 请参考:

5. 删除房间特定属性

  • 调用接口:
const rtcsdk = new RTCSDK();
const keys = '["MeetingName", "CompanyName"]';
rtcsdk.delMeetingAttrs(keys, "", "");
  • 回调通知:
rtcsdk.on('delMeetingAttrsRslt', (data) => {
    if (data.sdkErr === 0) {
        // 成功
    }
});

相关 API 请参考:

6. 清除房间全部属性

  • 调用接口:
const rtcsdk = new RTCSDK();
rtcsdk.clearMeetingAttrs("", "");
  • 回调通知:
rtcsdk.on('clearMeetingAttrsRslt', (data) => {
    if (data.sdkErr === 0) {
        // 成功
    }
});

相关 API 请参考: