sendMessage

简要描述

发送聊天消息收到聊天消息的回调：onMessageReceived(tk_uid peerId, const std::string& message, const tk::VariantMap& extendJson)
函数原型

int sendMessage(tk_uid toId, const std::string& message, const tk::VariantMap& extendJson = tk::VariantMap()) 返回值：return 0 success 参数

参数	类型	说明
toId	tk_uid（std::string）	接受者ID(要通知给哪些用户。“__all”：所有人；“__allExceptSender”：除自己以外的所有人；“__allExceptAuditor”：除旁听用户以外的所有人；“__None”：不通知任何人；某用户的peerID：只发给该用户)
message	std::string&	消息内容
extendJson	tk::VariantMap&	用户自定义扩展字段

pubMsg

简要描述

发布自定义信令 进入房间成功后，可以发送自定义的一些信令，用于用户之间相互通信。 发布自定义信令后，收到信令回调： onRemotePubMsg(std::string msgid, std::string msgname, tk_uid fromId, tk_uid toId, tk::Variant data, tk_uid associatedUserID, const std::string& associatedMsgID , long ts)

关于自定义信令详见：入门必读-自定义信令

函数原型

virtual int pubMsg(const std::string& msgName , const std::string& msgId , tk_uid toId , const tk::Variant& data , tk_uid acassociatedUserID , const std::string& acassociatedMsgID , uint64_t expireTime) 返回值：返回值：请见错误码定义参数：

参数	说明
msgName	消息名字
msgId	消息id
toId	要通知给哪些用户（“__all”：所有人；“__allExceptSender”：除自己以外的所有人；“__allExceptAuditor”：除旁听用户以外的所有人；“__None”：不通知任何人；某用户的peerID：只发给该用户）
data	消息数据（可以是Number、String、Map或List）
acassociatedUserID	表示该信令关联到用户ID。若被关联的用户离开教室后，此信令也会被删除。若需要关联，则传入用户ID，否则 nil
acassociatedMsgID	表示该信令可以关联到另一个信令。若被关联的信令被删除后，此信令也会被删除。若需要关联，则传入另一信令ID，否则 nil
expireTime	是否保存（详见入门必读：自定义信令）

delMsg

简要描述

删除自定义信令删除信令回调： onRemoteDelMsg(std::string msgid, std::string msgname, tk_uid fromId, tk_uid toId, tk::Variant data, tk_uid associatedUserID , const std::string& associatedMsgID, long ts)

函数原型

    int delMsg(const std::string& msgName
    , const std::string& msgId
    , tk_uid toId
    , const tk::Variant& data = tk::Variant())

返回值：请见错误码定义参数：

参数	说明
msgName	消息名字
msgId	消息id
toId	要通知给哪些用户；“__all”：所有人；“__allExceptSender”：除自己以外的所有人；“__allExceptAuditor”：除旁听用户以外的所有人；“__None”：不通知任何人；某用户的peerID：只发给该用户
data	消息数据，可以是Number、String、Map或List

evictUser

简要描述

将用户踢出房间
函数原型

int evictUser(tk_uid peerID， int reason) 返回值：return 0 success 参数peerID：用户ID 参数reason：踢人数值，代表原因（reason是自定义的，且reason必须小于400）
有关用户被踢说明请查看 **踢人说明

switchOnlyAudioRoom

简要描述

切换纯音频房间 可以自由将房间切换到纯音频或者正常的房间。纯音频房间：即该房间所有用户都只会发布音频，没有视频。切换成功后，回调： onAudioRoomSwitch(tk_uid from,bool onlyAudio)
函数原型

int switchOnlyAudioRoom(bool onlyAudio) 返回值：return 0 success 参数onlyAudio：是否切换

selectServer

简要描述

切换服务器 调用此接口，可以切换sdk链接的服务器。可以调用 getServerList 接口获取到该房间可用的服务器列表。
函数原型

int selectServer(const std::string& servername) 返回值：return 0 success 参数servername：服务器名称

使用示例

1
2
3

std::vector<ServerInfo> list;
GetRoomClient()->getServerList(list);
GetRoomClient()->selectServer(list[0].serverareaname);

changeUserProperty

简要描述

修改用户的属性 可以调用此接口，修改指定用户的用户属性，比如奖杯数。调用后，自己和其他用户均会收到修改成功的回调： onUserPropertyChanged(tk_uid peerId,const std::string& key,const tk::Variant& value)

接口详情

    int changeUserProperty(tk_uid peerId
    , tk_uid tellWhom
    , const std::string& key
    , const tk::Variant& value)

返回值：return 0 success

参数： | 参数 | 说明 | | ---- | ---- | | peerId | 用户ID | | tellWhom | 表示修改某一用户的属性成功后，需将此次属性变化的通知给房间其他用户对象。详情见 TKRoomDefines.h 相关定义. 可以是某一用户ID，表示此信令只发送给该用户 | | key | 被修改的属性名称 | | value | 被修改的属性名称对应的值 |

使用示例

1	`GetRoomClient()->changeUserProperty("123abc", ALLUSER, "publishState", TK_PUBLISH_ALL);`