房间自定义属性
功能介绍
房间自定义属性用于在房间维度存储业务侧需要的键值信息,例如会议主题、当前主持人、业务状态标记等。同一房间内的与会成员可共享这些字段。
本模块提供完整的生命周期能力:设置整包属性、查询全部或指定键、增量添加或更新、按键删除以及清空全部属性;各操作通过异步接口发起,结果在对应回调中返回。属性发生变更时,可通过 CRVideo_NotifyMeetingAttrsChanged 获知更新。
成员维度的自定义属性见 成员自定义属性。
注意:
须在成功进入房间后,方可设置或查询房间自定义属性。
下文按典型操作分节说明接口调用与对应回调,各小节末尾列出相关 API 链接。
1. 设置房间属性
- 调用接口:
var attrs = {"MeetingName": "xxx", "departmentName": "xxx"};
var options = {"notifyAll": 1}; // 1:通知房间内所有人,参见 CRVideo_MeetingAttrOptions
CRVideo_SetMeetingAttrs(attrs, options, cookie);
- 回调通知:
CRVideo_SetMeetingAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
2. 获取房间属性
- 调用接口:
CRVideo_GetMeetingAllAttrs(cookie);
- 回调通知:
CRVideo_GetMeetingAllAttrsSuccess.callback = function(attr, cookie){
// 获取成功
}
CRVideo_GetMeetingAllAttrsFail.callback = function(sdkErr, cookie){
// 获取失败
}
相关 API 请参考:
3. 获取房间特定属性
- 调用接口:
var keys = ["MeetingName", "CompanyName"];
CRVideo_GetMeetingAttrs(keys, cookie);
- 回调通知:
CRVideo_GetMeetingAttrsSuccess.callback = function(attr, cookie){
// 获取成功
}
CRVideo_GetMeetingAttrsFail.callback = function(sdkErr, cookie){
// 获取失败
}
相关 API 请参考:
4. 添加或更新属性
- 调用接口:
var attrs = {"MeetingName": "xxx"};
var options = {"notifyAll": 1};
CRVideo_AddOrUpdateMeetingAttrs(attrs, options, cookie);
- 回调通知:
CRVideo_AddOrUpdateMeetingAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
- CRVideo_AddOrUpdateMeetingAttrs
- CRVideo_AddOrUpdateMeetingAttrsRslt
- CRVideo_NotifyMeetingAttrsChanged
5. 删除房间特定属性
- 调用接口:
var keys = ["MeetingName", "CompanyName"];
var options = {"notifyAll": 1};
CRVideo_DelMeetingAttrs(keys, options, cookie);
- 回调通知:
CRVideo_DelMeetingAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考:
6. 清除房间全部属性
- 调用接口:
var options = {"notifyAll": 1};
CRVideo_ClearMeetingAttrs(options, cookie);
- 回调通知:
CRVideo_ClearMeetingAttrsRslt.callback = function(sdkErr, cookie){
if (sdkErr != 0){
// 失败
} else {
// 成功
}
}
相关 API 请参考: