频道相关

创建频道

API介绍

创建频道后并不会主动加入频道,需要手动加入频道。该接口用户创建频道,同一时刻频道名互斥,不能重复创建。但如果频道名缺省,服务器会自动分配频道id。

对于频道在创建后如果没人加入,有效期2小时,当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。

API原型

参数说明

参数 类型 说明
param struct 接口传入参数,见头文件说明,或api文档
cb function 回调函数
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

回调返回中10405代表房间已经存在。其他非200是房间生成错误, 参考错误码

示例

加入频道

API介绍

加入频道接口。

API原型

参数说明

参数 类型 说明
param struct 接口传入参数,见头文件说明,或api文档
cb function 回调函数
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

回调返回错误码10404、10407、10417、10419、10420, 参考错误码

示例

离开频道

API介绍

离开频道接口。

API原型

参数说明

参数 类型 说明
param struct 接口传入参数,见头文件说明,或api文档
cb function 回调函数
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

回调返回错误码10404、10406, 参考错误码

示例

关闭频道

API介绍

关闭销毁频道。

API原型

参数说明

参数 类型 说明
param struct 接口传入参数,见头文件说明,或api文档
cb function 回调函数
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

回调返回错误码10404、10406, 参考错误码

示例

查询频道接口

API介绍

查询频道接口。该接口可以根据频道名查询频道信息。

API原型

参数说明

参数 类型 说明
param struct 接口传入参数,见头文件说明,或api文档
cb function 回调函数
user_data void* 注册回调时的APP自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理

返回值说明

无返回值。

回调返回参考错误码

示例