C++SDK
1.0.0
|
#include <easyroom.h>
类 | |
class | IListener |
Public 类型 | |
enum | OperateType { ot_publishMicrophone = 1, ot_unpublishMicrophone = 2, ot_publishCamera = 3, ot_unpublishCamera = 4, ot_attachRender = 5, ot_detachRender = 6 } |
typedef void(* | FuncJoinResult) (const RoomId &roomId, Result result) |
Public 成员函数 | |
virtual void | release ()=0 |
virtual Result | setListener (IListener *listener)=0 |
房间加入退出逻辑 更多... | |
virtual Result | join (const User &user, FuncJoinResult joinresult)=0 |
virtual bool | isWorking () const =0 |
virtual Result | leave (Result reason)=0 |
virtual Result | kickoutUser (Result reason, const UserId &userId)=0 |
virtual Result | sendPublicData (const char *data, uint32 len)=0 |
virtual Result | sendPrivateData (const char *data, uint32 len, const UserId &toId)=0 |
virtual const RoomId & | getRoomId () const =0 |
房间信息和用户信息操作 更多... | |
virtual const RoomInfo & | getRoomInfo () const =0 |
virtual const User & | getSelfUser () const =0 |
virtual const UserId & | getSelfUserId () const =0 |
virtual uint32 | getParticipantsCount () const =0 |
virtual Result | getParticipants (uint32 begindex, uint32 &ncount, UsersType &users)=0 |
virtual Result | setVideoParams (const VideoParams ¶m)=0 |
音视频操作 更多... | |
virtual VideoParams | getVideoParams () const =0 |
virtual Result | setAudioParams (const AudioParams ¶m)=0 |
virtual AudioParams | getAudioParams () const =0 |
virtual Result | setVideoSource (FakeVideoCapturer *vcapturer)=0 |
virtual Result | setAudioSource (FakeAudioCapturer *acapturer)=0 |
virtual Result | publishMicrophone ()=0 |
virtual Result | unpublishMicrophone ()=0 |
virtual Result | previewCamera (IVideoRender *render)=0 |
virtual Result | unpreviewCamera ()=0 |
virtual Result | publishCamera ()=0 |
virtual Result | unpublishCamera ()=0 |
virtual Result | attachRender (const UserId &userId, IVideoRender *render)=0 |
virtual Result | detachRender (const UserId &userId)=0 |
virtual Result | switchCamera ()=0 |
virtual bool | ismuteMicrophone () const =0 |
virtual Result | muteMicrophone ()=0 |
virtual Result | unmuteMicrophone ()=0 |
virtual Result | setAudioMixerDataListener (IAudioRender *listener, uint32 sampleRate)=0 |
音视频导出操作 更多... | |
virtual Result | setVideoMixerDataListener (IVideoRender *listener)=0 |
virtual IMVideoMixer * | getVideoMixer ()=0 |
virtual Result | enableStats (bool isEnable)=0 |
房间统计信息 更多... | |
virtual const RoomStats & | getRoomStats () const =0 |
virtual Result | setOption (RoomOption type, const String &value)=0 |
virtual String | getOption (RoomOption type)=0 |
静态 Public 成员函数 | |
static IEasyRoom * | obtain (const RoomId &roomId) |
Protected 成员函数 | |
virtual | ~IEasyRoom () |
简易房间接口类
简易房间接口定义了独立的简易房间对象创建和释放、房间功能操作。
|
inlineprotectedvirtual |
|
pure virtual |
关联视频数据和显示对象,在render中显示视频
[in] | userId | 摄像头Id,唯一标示一路共享的摄像头视频。 |
[in] | *render | 显示对象接口指针。 |
解除摄像头视频数据的所有显示对象关联
[in] | userId | 摄像头Id,唯一标示一路共享的摄像头视频。 |
|
pure virtual |
房间统计信息
当前房间启用或关闭流量统计功能
[in] | isEnable | 启用或关闭。 |
|
pure virtual |
|
pure virtual |
获取房间选项
[in] | type | 房间选项类型。 |
|
pure virtual |
获取房间中的用户列表
[in] | begindex | 起始索引。 |
[in,out] | ncount | 请求数量;实际返回数量。 |
[out] | users | 用户列表集合。 |
|
pure virtual |
|
pure virtual |
房间信息和用户信息操作
获取房间Id
|
pure virtual |
|
pure virtual |
|
pure virtual |
获取本用户信息
|
pure virtual |
获取本用户Id
|
pure virtual |
获取视频混频布局接口
|
pure virtual |
|
pure virtual |
判断本地麦克风是否静默
|
pure virtual |
|
pure virtual |
加入房间
[in,out] | user | 用户信息:用户Id(不能包含'{'、'}'字符),用户名,用户数据等;当应用层不传入user.userId时,SDK将创建一个新的guid作为user.userId,同时返回给应用层。 |
[in] | joinresult | 加房间回调接口。 |
|
pure virtual |
房间中踢出用户
[in] | reason | 踢出用户的理由代码。 |
[in] | userId | 被踢出用户Id。 |
当前用户离开房间
[in] | reason | 用户离开房间的原因代码,正常离开为AVD_OK。 |
|
pure virtual |
本地麦克风静默
获取或创建房间接口
[in] | roomId | 房间Id。 |
|
pure virtual |
预览本地缺省摄像头视频
[in] | *render | 显示对象接口指针 |
|
pure virtual |
发布缺省摄像头视频
|
pure virtual |
打开本地麦克风发布到房间中
|
pure virtual |
释放房间接口
|
pure virtual |
透明通道,发送私有数据
[in] | *data | 发送的数据指针。 |
[in] | len | 发送的数据长度。 |
[in] | toId | 目的用户Id。 |
透明通道,发送广播数据
[in] | *data | 发送的数据指针。 |
[in] | len | 发送的数据长度。 |
|
pure virtual |
音视频导出操作
设置获取混音数据回调接口
[in] | listener | 混音数据回调指针。 |
[in] | sampleRate | 导出混音数据的采样率:16000,44100,48000。 |
|
pure virtual |
设置音频麦克风采集、推流等参数
[in] | param | 音频参数。 |
|
pure virtual |
|
pure virtual |
设置房间选项
[in] | type | 房间选项类型。 |
[in] | value | 房间选项值字符串。 |
|
pure virtual |
设置获取视频数据回调接口,此数据仅回调一份数据:数据为主视频+各个Overlay的视频,视频大小为主视频大小;如使用ILivecast接口,不需要设置此接口。
|
pure virtual |
音视频操作
设置视频摄像头采集、推流等参数
[in] | param | 视频参数。 |
|
pure virtual |
|
pure virtual |
视频切换摄像头
|
pure virtual |
本地麦克风静默取消
|
pure virtual |
取消预览缺省摄像头视频
|
pure virtual |
取消发布缺省摄像头视频
|
pure virtual |
关闭本地麦克风发布到房间中