音视频通话

房间自定义属性

功能介绍

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

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

下文按典型操作分节说明接口调用与对应回调,各小节末尾列出相关 API 链接。

1.设置房间属性

  • 调用接口:
//即将设置的属性
const char* meetAttrs = "{\"MeetingName\":\"xxx\",\"departmentName\":\"xxx\"}";
g_sdkMain->getSDKMeeting().setMeetingAttrs(meetAttrs, NULL, "");

  • 回调通知:

//设置会议属性结果
void setMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
	if(CRVSDKERR_NOERR != sdkErr)
  	{
    	//失败
  	}
	else
	{
		//成功
	}
}

相关API请参考:

相关结构定义请参考:

2.获取房间属性

  • 调用接口:

//获取的所有属性
g_sdkMain->getSDKMeeting().getMeetingAllAttrs("");
  • 回调通知:

void getMeetingAllAttrsSuccess(const char* attrs, const char* cookie)
{
    //获取会议属性成功
}

void getMeetingAllAttrsFail(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
    //获取会议属性失败
}

相关API请参考:

3.获取房间特定属性

  • 调用接口:

//获取的指定的属性
const char* keys = "[\"MeetingName\", \"CompanyName\"]";
g_sdkMain->getSDKMeeting().getMeetingAttrs(keys, "");

  • 回调通知:

void getMeetingAttrsSuccess(const char* attrs, const char* cookie)
{
    //获取会议属性成功
}

void getMeetingAttrsFail(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
    //获取会议属性失败
}

相关API请参考:

4.添加或更新属性

  • 调用接口:

const char* meetAttrs = "{ \"MeetingName\":\"xxx\" }";
g_sdkMain->getSDKMeeting().addOrUpdateMeetingAttrs(meetAttrs, NULL, "");

  • 回调通知:

void addOrUpdateMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
	if(CRVSDKERR_NOERR != sdkErr)
  	{
    	//失败
  	}
	else
	{
		//成功
	}
}

相关API请参考:

5.删除房间特定属性

  • 调用接口:

const char* keys = "[\"MeetingName\", \"CompanyName\"]";
g_sdkMain->getSDKMeeting().delMeetingAttrs(keys, NULL, "");

  • 回调通知:

void delMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
	if(CRVSDKERR_NOERR != sdkErr)
  	{
    	//失败
  	}
	else
	{
		//成功
	}
}

相关API请参考:

6.清除房间全部属性

  • 调用接口:

g_sdkMain->getSDKMeeting().clearMeetingAttrs(NULL, "");

  • 回调通知:

void clearMeetingAttrsRslt(CRVSDK_ERR_DEF sdkErr, const char* cookie)
{
	if(CRVSDKERR_NOERR != sdkErr)
  	{
    	//失败
  	}
	else
	{
		//成功
	}
}

相关API请参考: