IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for Windows Platforms
IRoom Class Referenceabstract

Public Member Functions

virtual void EnterRoom (const std::string &nick_name, const std::function< void(void)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_failure)=0
 进入房间 More...
 
virtual void LeaveRoom (const std::function< void(void)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_failure)=0
 离开房间 More...
 
virtual alibaba::room::RoomDetail GetRoomDetail ()=0
 获取房间详细信息 More...
 
virtual void GetRoomDetailByRoomId (const std::string &room_id, const std::function< void(const ::alibaba::room::RoomDetail &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 从服务端获取房间详细信息 More...
 
virtual void ListUser (const ::alibaba::room::GetRoomUserListReq &req, const std::function< void(const ::alibaba::room::GetRoomUserListRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_failure)=0
 枚举房间在线用户 More...
 
virtual void GetCloudConfig (const std::vector< std::string > key_list, const std::function< void(const std::map< std::string, std::string > key_config_map)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_failure)=0
 获取云控参数 More...
 
virtual void UpdateRoomNotice (const std::string &notice, const std::function< void(const ::alibaba::room::UpdateRoomNoticeRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 更新房间公告 More...
 
virtual void UpdateRoomTitle (const std::string &title, const std::function< void(const ::alibaba::room::UpdateRoomTitleRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error)> &on_failure)=0
 更新房间名称 More...
 
virtual void SetRoomEventListener (const std::shared_ptr< alibaba::meta::RoomEventListener > &listener)=0
 设置房间事件回调 More...
 
virtual std::shared_ptr< IPluginGetPlugin (PluginEnum plugin)=0
 获取房间内的其他服务项,参考PluginEnum
 

Member Function Documentation

◆ EnterRoom()

virtual void IRoom::EnterRoom ( const std::string &  nick_name,
const std::function< void(void)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_failure 
)
pure virtual

进入房间

Parameters
nick_name进入房间的昵称
on_success成功的回调
on_failure失败的回调

◆ GetCloudConfig()

virtual void IRoom::GetCloudConfig ( const std::vector< std::string >  key_list,
const std::function< void(const std::map< std::string, std::string > key_config_map)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_failure 
)
pure virtual

获取云控参数

Parameters
on_success成功回调,返回kv结构数据
on_failure失败回调

◆ GetRoomDetail()

virtual alibaba::room::RoomDetail IRoom::GetRoomDetail ( )
pure virtual

获取房间详细信息

Returns
房间详细信息,参考 alibaba::room::RoomDetail

◆ GetRoomDetailByRoomId()

virtual void IRoom::GetRoomDetailByRoomId ( const std::string &  room_id,
const std::function< void(const ::alibaba::room::RoomDetail &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

从服务端获取房间详细信息

Parameters
on_success成功回调,参考 alibaba::room::RoomDetail
on_failure失败回调

◆ LeaveRoom()

virtual void IRoom::LeaveRoom ( const std::function< void(void)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_failure 
)
pure virtual

离开房间

Parameters
on_success成功的回调
on_failure失败的回调

◆ ListUser()

virtual void IRoom::ListUser ( const ::alibaba::room::GetRoomUserListReq req,
const std::function< void(const ::alibaba::room::GetRoomUserListRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_failure 
)
pure virtual

枚举房间在线用户

Parameters
on_success成功回调,参考 alibaba::room::GetRoomUserListRsp
on_failure失败回调

◆ SetRoomEventListener()

virtual void IRoom::SetRoomEventListener ( const std::shared_ptr< alibaba::meta::RoomEventListener > &  listener)
pure virtual

设置房间事件回调

Parameters
listener房间事件回调

◆ UpdateRoomNotice()

virtual void IRoom::UpdateRoomNotice ( const std::string &  notice,
const std::function< void(const ::alibaba::room::UpdateRoomNoticeRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

更新房间公告

Parameters
notice房间公告
on_success成功回调,参考 alibaba::room::UpdateRoomNoticeRsp
on_failure失败回调

◆ UpdateRoomTitle()

virtual void IRoom::UpdateRoomTitle ( const std::string &  title,
const std::function< void(const ::alibaba::room::UpdateRoomTitleRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error)> &  on_failure 
)
pure virtual

更新房间名称

Parameters
title房间名称
on_success成功回调,参考 alibaba::room::UpdateRoomNoticeRsp
on_failure失败回调

The documentation for this class was generated from the following file: