会议服务
start
接口说明
创建会议
接口定义
void start(Context context, MeetingRequest param)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | 上下文 |
| param | MeetingRequest | 会议请求传参 |
MeetingRequest: 会议请求传参
public class MeetingRequest implements Parcelable{
/**
* 用户信息
*/
private UserInfo userInfo;
/**
* 会议参数
*/
private MeetingOptions meetingOptions;
}
返回值描述
无返回值
joinMeetingWithoutLogin
接口说明
未登录加入会议
接口定义
void joinMeetingWithoutLogin(Context context, MeetingRequest request)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | 上下文 |
| request | MeetingRequest | 会议请求传参 |
MeetingRequest: 会议请求传参
public class MeetingRequest implements Parcelable{
/**
* 用户信息
*/
private UserInfo userInfo;
/**
* 会议参数
*/
private MeetingOptions meetingOptions;
}
返回值描述
无返回值
join
接口说明
加入会议（已登录下）
接口定义
int join(Context context, MeetingRequest param)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | 上下文 |
| param | MeetingRequest | 会议请求传参 |
MeetingRequest: 会议请求传参
public class MeetingRequest implements Parcelable{
/**
* 用户信息
*/
private UserInfo userInfo;
/**
* 会议参数
*/
private MeetingOptions meetingOptions;
}
返回值描述
| 类型 | 含义 |
|---|---|
| int | 错误码 |
joinThirdPartyMeeting
接口说明
加入第三方会议
接口定义
void joinThirdPartyMeeting(JoinThirdPartyMeetingParam param)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| param | JoinThirdPartyMeetingParam | 加入第三方会议入会参数 |
JoinThirdPartyMeetingParam: 加入第三方会议入会参数
public class JoinThirdPartyMeetingParam {
/**
* 会议号码或url
*/
private String strMeetingNumberOrURI;
/**
* 是否开启麦克风
*/
private boolean openMic = false;
/**
* 是否开启摄像头
*/
private boolean openCamera = false;
/**
* 会议邀请类型
*/
private MeetingInviteType type;
}
返回值描述
无返回值
leave
接口说明
离开会议
接口定义
int leave()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| int | 错误码 |
end
接口说明
结束会议
接口定义
int end()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| int | 错误码 |
confGetCurRole
接口说明
获取会议中自己的角色权限
接口定义
MeetingMemberRole confGetCurRole()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| MeetingMemberRole | 角色权限 |
MeetingMemberRole: 角色权限
public enum MeetingMemberRole {
INVALID,
HOST,//ORGANIZER 会议创建者
CO_HOST,//PRESENTER 会议主持人
ATTENDEE,//ATTENDEE 参会者
AUDIENCE//CAST_VIEWER 观众
}
getMeetingStatus
接口说明
获取会议状态
接口定义
MeetingStatus getMeetingStatus()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| MeetingStatus | 会议状态 |
MeetingStatus: 会议状态
public enum MeetingStatus {
/**
* 空闲
*/
STATE_IDLE,
/**
* 去电中
*/
STATE_JOINING,
/**
* 来电中
*/
STATE_INMEETING,
/**
* 通话中
*/
STATE_FINISHING
}
getIsHost
接口说明
设自己是否是会议主持人
接口定义
boolean getIsHost()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | true：是主持人；false：不是主持人 |
setClickEvent
接口说明
设置点击事件
接口定义
void setClickEvent(Class<? extends DefaultClickEvent> clazz)
参数描述
无参数
返回值描述
无返回值
getMemberCount
接口说明
获取会议成员数量
接口定义
int getMemberCount()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| int | 会议成员数量 |
joinMeetingInvite
接口说明
接受会议邀请
接口定义
void joinMeetingInvite(MeetingInviteModel inviteModel)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| inviteModel | MeetingInviteModel | 邀请类型 |
MeetingInviteModel: 邀请类型
public class MeetingInviteModel {
/**
* 会议号码
*/
private String meetingNumber;
/**
* 会议凭证
*/
private String credential;
/**
* 位置
*/
private String location;
/**
* 会议标题
*/
private String title;
/**
* 被邀请人名称
*/
private String inviteName;
/**
* 邀请事务id
*/
private String inviteTransId;
/**
* 秘钥查询参数
*/
private String credentialQuery;
/**
* 被邀请人id
*/
private String inviterSubjectId;
}
返回值描述
无返回值
rejectMeetingInvite
接口说明
拒绝会议邀请
接口定义
void rejectMeetingInvite(MeetingInviteModel inviteModel)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| inviteModel | MeetingInviteModel | 邀请类型 |
MeetingInviteModel: 邀请类型
public class MeetingInviteModel {
/**
* 会议号码
*/
private String meetingNumber;
/**
* 会议凭证
*/
private String credential;
/**
* 位置
*/
private String location;
/**
* 会议标题
*/
private String title;
/**
* 被邀请人名称
*/
private String inviteName;
/**
* 邀请事务id
*/
private String inviteTransId;
/**
* 秘钥查询参数
*/
private String credentialQuery;
/**
* 被邀请人id
*/
private String inviterSubjectId;
}
返回值描述
无返回值
addMeetingEvent
接口说明
监听会议事件
接口定义
void addMeetingEvent(IMeetingEvent meetingEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| meetingEvent | IMeetingEvent | 会议事件 |
返回值描述
无返回值
addAudioEvent
接口说明
监听音频事件
接口定义
void addAudioEvent(IAudioEvent audioEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| audioEvent | IAudioEvent | 音频事件 |
返回值描述
无返回值
addVideoEvent
接口说明
监听视频事件
接口定义
void addVideoEvent(IVideoEvent videoEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| videoEvent | IVideoEvent | 视频事件 |
返回值描述
无返回值
removeMeetingEvent
接口说明
移除会议事件监听
接口定义
void removeMeetingEvent(IMeetingEvent meetingEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| meetingEvent | IMeetingEvent | 会议事件 |
返回值描述
无返回值
removeAudioEvent
接口说明
移除音频事件监听
接口定义
void removeAudioEvent(IAudioEvent audioEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| audioEvent | IAudioEvent | 音频事件 |
返回值描述
无返回值
removeVideoEvent
接口说明
移除视频事件监听
接口定义
void removeVideoEvent(IVideoEvent videoEvent)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| videoEvent | IVideoEvent | 视频事件 |
返回值描述
无返回值
restoreCallUI
接口说明
恢复通话界面
接口定义
boolean restoreCallUI(Context context)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | 上下文 |
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 接口调用结果 |
getMeetingInviteController
接口说明
获取会议邀请控制器
接口定义
IMeetingInviteController getMeetingInviteController()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IMeetingInviteController | 会议邀请控制器 |
getMeetingChatController
接口说明
获取会议邀请控制器
接口定义
IMeetingChatController getMeetingChatController()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IMeetingChatController | 会议聊天控制器 |
getAnnotationController
接口说明
获取会议批注控制器
接口定义
IAnnotationController getAnnotationController()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IAnnotationController | 会议批注控制器 |
getAiService
接口说明
获取会议Ai转写控制器
接口定义
IAiService getAiService()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IAiService | 会议Ai转写控制器 |
getMeetingParticipantsController
接口说明
获取会议成员列表控制器
接口定义
IMeetingParticipantsController getMeetingParticipantsController()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IMeetingParticipantsController | 会议成员列表控制器 |
getMeetingUIController
接口说明
获取会议UI界面控制器
接口定义
IMeetingUIController getMeetingUIController()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| IMeetingUIController | 会议UI界面控制器 |
setCameraSnapshotDumpDir
接口说明
设置会议截图保存路径
接口定义
void setCameraSnapshotDumpDir(String dir)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| dir | String | 会议截图保存路径 |
返回值描述
无返回值
showFloatWindow
接口说明
设置会议为浮窗模式
接口定义
void showFloatWindow()
参数描述
无参数
返回值描述
无返回值
muteAudio
接口说明
静音/解静音,对自己进行Mute、unMute
接口定义
void muteAudio(boolean mute,CallBack<Void, BizCodeModel> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| mute | boolean | 静音(true)/解静音(false) |
| callBack | CallBack | 回调参数，代表是否操作成功 |
返回值描述
无返回值
switchCamera
接口说明
切换前/后摄像头
接口定义
void switchCamera()
参数描述
无参数
返回值描述
无返回值
muteVideo
接口说明
视频mute/unMute,可以对自己进行摄像头的开启/关闭
接口定义
void muteVideo(boolean bMute)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bMute | boolean | 开启(false)/关闭(true)摄像头 |
返回值描述
无返回值
spotlightVideo
接口说明
设置焦点视频
接口定义
void spotlightVideo(int id, VoidCallback callback)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| id | int | 成员id |
| callback | VoidCallback | 回调参数，收到onSuccessGetResult代表成功 |
返回值描述
无返回值
unSpotlightVideo
接口说明
取消焦点视频
接口定义
void unSpotlightVideo(int id, VoidCallback callback)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| id | int | 成员id |
| callback | VoidCallback | 回调参数，收到onSuccessGetResult代表成功 |
返回值描述
无返回值
setUserAudioMute
接口说明
设置用户静音
接口定义
void setUserAudioMute(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
setUserAudioUnmute
接口说明
设置用户解静音
接口定义
void setUserAudioUnmute(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
changeMyName
接口说明
修改自己的名字
接口定义
void changeMyName(String strName)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| strName | String | 名字 |
返回值描述
无返回值
changeUserName
接口说明
改名
接口定义
void changeUserName(int userId, String strName)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
| strName | String | 名字 |
返回值描述
无返回值
setUserRole
接口说明
设置成员角色
接口定义
void setUserRole(int userId,MeetingMemberRole role)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
| role | MeetingMemberRole | 角色类型 |
MeetingMemberRole: 角色类型
public enum MeetingMemberRole {
INVALID,
HOST,//ORGANIZER 会议创建者
CO_HOST,//PRESENTER 会议主持人
ATTENDEE,//ATTENDEE 参会者
AUDIENCE//CAST_VIEWER 观众
}
返回值描述
无返回值
expelUser
接口说明
移除参会成员
接口定义
void expelUser(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
muteAll
接口说明
全体静音
接口定义
void muteAll()
参数描述
无参数
返回值描述
无返回值
unMuteAll
接口说明
全体解除静音
接口定义
void unMuteAll()
参数描述
无参数
返回值描述
无返回值
shareScreen
接口说明
共享辅流
接口定义
void shareScreen()
参数描述
无参数
返回值描述
无返回值
stopShareScreen
接口说明
停止共享辅流
接口定义
void stopShareScreen()
参数描述
无参数
返回值描述
无返回值
startCloudRecord
接口说明
开始云端录制
接口定义
void startCloudRecord()
参数描述
无参数
返回值描述
无返回值
stopCloudRecord
接口说明
停止云端录制
接口定义
void stopCloudRecord()
参数描述
无参数
返回值描述
无返回值
setWaitingRoomEnable
接口说明
启用或关闭等候室
接口定义
void setWaitingRoomEnable(boolean bEnable,CallBack<Void, BizCodeModel> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)等候室 |
| callBack | CallBack | 回调参数，收到onSuccess代表操作成功 |
返回值描述
无返回值
getWaitingRoomEnable
接口说明
获取等候室是否开启
接口定义
boolean getWaitingRoomEnable()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)等候室 |
getWaitingUserList
接口说明
获取当前等候室的成员列表
接口定义
List<MeetingMemberInfo> getWaitingUserList()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| List |
成员列表 |
MeetingMemberInfo: 会议成员信息
public class MeetingMemberInfo {
private String mDisplayTextPinyin = "";//名称的拼音
private String mDisplayNumber = "";//号码
/**
* 该字段，要区别于mute，需不需要mute是基于是否允许说话的条件的，
* 而这个能否说话的条件，就是这个字段mAllowTalk;
*/
private boolean mAllowTalk = false;
private boolean mIsSpotlight;//是否为焦点
private boolean mShareReceiving;//是否正在接收辅流
private boolean mShareSending;//是否正在发送辅流
private boolean mAudioSendOn;//能否发送音频
private boolean mAudioRecvOn;//能否接收音频
private boolean mAudioDeviceOn;//有没有音频设备
private boolean mVideoSendOn;//能否发送视频
private boolean mVideoRecvOn;//能否接收视频
private boolean mVideoDeviceOn;//有没有视频设备
private boolean mHandingUp;//正在举手
private boolean mIsBlocked;//是否被暂停视频
private boolean mChatEnable;//能否进行连天
private boolean mDtmfEnable;//能否进行dtmf服务
private boolean mFeccEnable;//是否支持fecc
private boolean mLocalRecordEnable;// 是否支持本地录制
private String mDisplayName = "";//名称
private MeetingEndpointType mEndpointType;//终端类型
private boolean mInLobby;//是否在会议大厅
private long mJoinTime;//加入会议时间
private boolean mPermRecord;//是否允许本地录制
private MeetingRecordStatus mLocalRecordState;//本地录制状态
private String mSubjectId = "";//用户中心唯一id
private int mUserId;//用户唯一id
private MeetingMemberRole mRole = MeetingMemberRole.INVALID;//成员角色
private long mTimestamp;//请求到该数据的时间戳，用于UI异步请求数据，刷新校验
private boolean mIsFemale;//性别
private boolean mIsColleague;//是否是同事
private int mShareSourceId;//辅流订阅id
private int mVideoSourceId;//主流订阅id
private MeetingFeedbackType mType = MeetingFeedbackType.INVALID;//图标示意类型
private boolean mAudioOnly;//是否仅允许音频
private ContactEntity mContactInfo;//用户信息
private boolean isNameChanged = true;//是否有改名过;默认true，使用会控下发的名称，false时使用本地匹配的联系人名称
private boolean isInterpreter; // 是否为传译员
private boolean mWhiteboardSending;//正在发送白板，目前是ui层赋的值，没有使用逻辑层的赋值，因为怕有时序问题
private String activeLanguage = "";//语言
private int mParentUserId; // 用于标记从流用户对应的主流用户userid
int mAudioOccupyType = AudioOccupyType.NONE; // 麦克风通话占用状态
private int mRollCallId = 0;//被点名id
private boolean isRollcall;//是否正在被点名
}
admitToMeeting
接口说明
允许等候室的某个成员加入会议
接口定义
void admitToMeeting(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
refuseToMeeting
接口说明
拒绝等候室的某个成员加入会议
接口定义
void refuseToMeeting(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
admitAllToMeeting
接口说明
对等候室成员全部允许加入会议
接口定义
void admitAllToMeeting()
参数描述
无参数
返回值描述
无返回值
refuseAllToMeeting
接口说明
对等候室成员全部拒绝加入会议
接口定义
void refuseAllToMeeting()
参数描述
无参数
返回值描述
无返回值
moveToWaitingRoom
接口说明
将某个参会成员移至等候室
接口定义
void moveToWaitingRoom(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
setSpeakingMode
接口说明
开启/关闭发言举手
接口定义
void setSpeakingMode(MeetingSpeakMode speakMode, CallBack<Void, BizCodeModel> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| speakMode | MeetingSpeakMode | 举手类型 |
| callBack | CallBack | 回调参数，收到onSuccess代表操作成功 |
MeetingSpeakMode: 举手类型
public enum MeetingSpeakMode {
/**
* 无效
*/
INVALID,
/**
* 自由
*/
FREE,
/**
* 举手
*/
HAND_UP
}
返回值描述
无返回值
getSpeakingMode
接口说明
获取是否发言举手
接口定义
MeetingSpeakMode getSpeakingMode()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| MeetingSpeakMode | 举手类型 |
MeetingSpeakMode: 举手类型
public enum MeetingSpeakMode {
/**
* 无效
*/
INVALID,
/**
* 自由
*/
FREE,
/**
* 举手
*/
HAND_UP
}
replyHandUp
接口说明
是否允许发言
接口定义
void replyHandUp(int userId, boolean permit)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
| permit | boolean | true：允许发言；false：不允许发言 |
返回值描述
无返回值
setMeetingLock
接口说明
设置开启/关闭禁止新成员入会
接口定义
void setMeetingLock(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)禁止新成员入会 |
返回值描述
无返回值
getMeetingLock
接口说明
获取开启/关闭禁止新成员入会
接口定义
boolean getMeetingLock()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)禁止新成员入会 |
setParticipantsShareEnable
接口说明
设置开启/关闭与会者允许共享屏幕
接口定义
void setParticipantsShareEnable(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)与会者允许共享屏幕 |
返回值描述
无返回值
getParticipantsShareEnable
接口说明
获取是否开启/关闭与会者允许共享屏幕
接口定义
boolean getParticipantsShareEnable()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)与会者允许共享屏幕 |
setParticipantsChatEnable
接口说明
设置开启/关闭与会者允许聊天
接口定义
void setParticipantsChatEnable(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)与会者允许聊天 |
返回值描述
无返回值
getParticipantsChatEnable
接口说明
获取是否开启/关闭与会者允许聊天
接口定义
boolean getParticipantsChatEnable()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)与会者允许聊天 |
setParticipantsRenameEnable
接口说明
设置开启/关闭与会者允许改名
接口定义
void setParticipantsRenameEnable(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)与会者允许改名 |
返回值描述
无返回值
getParticipantsRenameEnable
接口说明
获取是否开启/关闭与会者允许改名
接口定义
boolean getParticipantsRenameEnable()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)与会者允许改名 |
setAutoMuteWhenJoinEnable
接口说明
设置开启/关闭新成员入会自动静音
接口定义
void setAutoMuteWhenJoinEnable(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)新成员入会自动静音 |
返回值描述
无返回值
getAutoMuteWhenJoinEnable
接口说明
获取是否开启/关闭新成员入会自动静音
接口定义
boolean getAutoMuteWhenJoinEnable()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)新成员入会自动静音 |
setShowMiniWindow
接口说明
设置开启/关闭画中画的小窗口
接口定义
void setShowMiniWindow(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)画中画的小窗口 |
返回值描述
| 类型 | 含义 |
|---|---|
| int | 错误码 |
getShowMiniWindow
接口说明
获取是否开启/关闭画中画的小窗口
接口定义
boolean getShowMiniWindow()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)画中画的小窗口 |
setMeetingChatTipWay
接口说明
设置开启/关闭会议聊天提示方式
接口定义
void setMeetingChatTipWay(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)会议聊天提示方式 |
返回值描述
| 类型 | 含义 |
|---|---|
| int | 错误码 |
getMeetingChatTipWay
接口说明
获取是否开启/关闭会议聊天提示方式
接口定义
boolean getMeetingChatTipWay()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)会议聊天提示方式 |
setEnableMicOnMeetingEntry
接口说明
设置开启/关闭自动打开麦克风
接口定义
void setEnableMicOnMeetingEntry(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)自动打开麦克风 |
返回值描述
无返回值
getEnableMicOnMeetingEntry
接口说明
获取是否开启/关闭自动打开麦克风
接口定义
boolean getEnableMicOnMeetingEntry()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)自动打开麦克风 |
setEnableCameraOnMeetingEntry
接口说明
设置开启/关闭自动打开摄像头
接口定义
void setEnableCameraOnMeetingEntry(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)自动打开摄像头 |
返回值描述
无返回值
getEnableCameraOnMeetingEntry
接口说明
获取是否开启/关闭自动打开摄像头
接口定义
boolean getEnableCameraOnMeetingEntry()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)自动打开摄像头 |
switchMeetingOrientation
接口说明
切换界面横竖屏
接口定义
void switchMeetingOrientation()
参数描述
无参数
返回值描述
无返回值
getMeetingHistoryList
接口说明
获取入会历史
接口定义
void getMeetingHistoryList(BizCodeCallback<List<? extends IModel>> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| callBack | BizCodeCallback | 回调参数，回调中带有入会历史列表 |
返回值描述
无返回值
enableSkipPreviewWhenJoinMeeting
接口说明
获取是否开启/关闭加入会议跳过视频预览
接口定义
boolean enableSkipPreviewWhenJoinMeeting()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)加入会议跳过视频预览 |
setEnableSkipPreviewWhenJoinMeeting
接口说明
设置开启/关闭加入会议跳过视频预览
接口定义
void setEnableSkipPreviewWhenJoinMeeting(boolean skipPreview)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| skipPreview | boolean | 开启(true)/关闭(false)加入会议跳过视频预览 |
返回值描述
无返回值
getCurrentAudioDevice
接口说明
获取当前的输出设备是听筒/扬声器/蓝牙/有线耳机
接口定义
AudioDevice getCurrentAudioDevice()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| AudioDevice | 输出设备类型 |
AudioDevice: 输出设备类型
public enum AudioDevice {
/**
* 扬声器
*/
SPEAKER_PHONE,
/**
* 有线耳机
*/
WIRED_HEADSET,
/**
* 听筒
*/
EARPIECE,
/**
* 蓝牙
*/
BLUETOOTH,
NONE;
}
setUserVideoUnmute
接口说明
请求开启摄像头
接口定义
void setUserVideoUnmute(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
setUserVideoMute
接口说明
关闭摄像头
接口定义
void setUserVideoMute(int userId)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 用户id |
返回值描述
无返回值
getMeetingInfo
接口说明
获取会议详情
接口定义
MeetingInfoDatum getMeetingInfo()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| MeetingInfoDatum | 会议详情类型 |
MeetingInfoDatum: 会议详情类型
public class MeetingInfoDatum {
private boolean mAllowJoinBeforeHost; // 允许在主持人之前入会
private boolean mAutoLiveStream; // 自动直播
private boolean mAutoRecording; // 自动录播
private long mBeginTime; // 会议开始时间，单位毫秒，createType == Scheduled 时有效
private long mStartTime; // 会议实际开启时间(第一个媒体入会的时间)，单位毫秒
private MeetingCreateType mMeetingCreateType = MeetingCreateType.INVALID; // 会议创建类型
private long mEndTime; // 会议结束时间，单位毫秒，createType == Scheduled 时有效
private String mEnterpriseId = ""; // 企业id
private String mJoinUrl = ""; // 入会url
private String mWebinarSurveyLink = ""; // webinar会后调查url
private String mMeetingId = ""; // 会议id
private String mMeetingNumber = ""; // 会议号
private MeetingTypes mMeetingType = MeetingTypes.INVALID; // 会议类型
private boolean mOnlyAuthUserCanJoin; // 开启仅有权限的用户可以入会
private MeetingOrganizerInfo mOrganizer = new MeetingOrganizerInfo();
private String mTitle = ""; // 会议主题
private boolean mPracticeSession; // 研讨会准备模式
private String mPassword = ""; // 会议密码
//开启音频是否需要用户同意
private boolean askToUnMuteEnabled;
//开启摄像头是否需要用户同意
private boolean askToUnMuteVideoEnabled;
// 是否开启本地录制开关
private boolean allowLocalRecord;
//是否开启实时字幕
private boolean mLiveCaptionEnabled;
//是否有语音AI服务单
private boolean mAsrServiceAvailable;
//是否有图标示意
private boolean mSupportFeedback;
//是否是私有云录制
private boolean mPremiseRecordEnabled;
//是否开启备份录制
private boolean isAllowBackupRecord;
private boolean audienceHideNonVideoEnabled;//观众隐藏无视频源与会者
// 会控是否启用互动协作（启用则使用互动白板，否则使用辅流白板。互动白板和辅流白板是引擎白板的新旧版本）
private boolean mInteractCooperationEnabled;
// 是否开启主持人密钥功能
private boolean mHostKeyEnabled;
}
getMeetingQualityStatisticInfo
接口说明
获取通话统计数据
接口定义
void getMeetingQualityStatisticInfo(CallBack<CallStatistic, BizCodeModel> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| callBack | CallBack | 回调参数，onSuccess中带有通话统计数据 |
CallStatistic: 通话统计数据
public class CallStatistic {
boolean hasAudio;//是否有音频
boolean hasVideo;//是否有视频
boolean hasShare;//是否有辅流
private com.yealink.ylservice.model.CallStatistic.VideoChannel recvShareChannel;//接收通道
private com.yealink.ylservice.model.CallStatistic.VideoChannel sendShareChannel;//发送通道
private List<com.yealink.ylservice.model.CallStatistic.VideoChannel> recvVideoChannels;//已订阅的所有视频统计
private com.yealink.ylservice.model.CallStatistic.VideoChannel recvActiveVideoChannel;//分辨率和码率最高的那路视频统计
private com.yealink.ylservice.model.CallStatistic.VideoChannel sendVideoChannel;//发送视频通道
private int sendVideoBandwidth = 0;//发送的总码率
private int recvVideoBandwidth = 0;// 接收的总码率
private com.yealink.ylservice.model.CallStatistic.AudioChannel recvAudioChannel;//音频接收通道
private com.yealink.ylservice.model.CallStatistic.AudioChannel sendAudioChannel;//音频发送通道
}
返回值描述
无返回值
setCurrentSpeaker
接口说明
设置音频输出类型
接口定义
void setCurrentSpeaker(AudioDevice deviceType)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| deviceType | AudioDevice | 输出设备类型 |
AudioDevice: 输出设备类型
public enum AudioDevice {
/**
* 扬声器
*/
SPEAKER_PHONE,
/**
* 有线耳机
*/
WIRED_HEADSET,
/**
* 听筒
*/
EARPIECE,
/**
* 蓝牙
*/
BLUETOOTH,
NONE;
}
返回值描述
无返回值
dumpCameraImage
接口说明
会议截图
接口定义
void dumpCameraImage(CallBack<String,String> callBack)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| callBack | CallBack | 回调参数，收到onSuccess代表成功 |
返回值描述
无返回值
clearAllMeetingRecord
接口说明
清空全量的入会记录
接口定义
void clearAllMeetingRecord(CallBack<Void,BizCodeModel> callback)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| callback | CallBack | 回调参数，收到onSuccess代表成功 |
返回值描述
无返回值
deleteMeetingRecordByRecordId
接口说明
设置开启/关闭
接口定义
void deleteMeetingRecordByRecordId(int recordId, CallBack<Void, BizCodeModel> callback)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| recordId | int | 入会历史id |
| callback | CallBack | 回调参数，收到onSuccess代表成功 |
返回值描述
无返回值
setShowMeetingInviterInfo
接口说明
设置开启/关闭会议邀请弹窗显示邀请人信息
接口定义
void setShowMeetingInviterInfo(boolean bEnable)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | boolean | 开启(true)/关闭(false)会议邀请弹窗显示邀请人信息 |
返回值描述
无返回值
isShowMeetingInviterInfo
接口说明
获取是否开启/关闭会议邀请弹窗显示邀请人信息
接口定义
boolean isShowMeetingInviterInfo()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| boolean | 开启(true)/关闭(false)会议邀请弹窗显示邀请人信息 |
getUnJoinedMemberInfoList
接口说明
获取未入会成员列表
接口定义
List<UnjoinedMemberInfo> getUnJoinedMemberInfoList()
参数描述
无参数
返回值描述
| 类型 | 含义 |
|---|---|
| List |
未入会成员列表 |
UnjoinedMemberInfo: 未入会成员类型
public class UnjoinedMemberInfo {
/**
* 成员名称
*/
public String displayName;
/**
* 邀请事务id
*/
public String inviteTransId;
/**< 账号*/
public String account;
/**< subjectId*/
public String subjectId;
/**< 被邀请者信息*/
public String contact;
/**< 邀请类型*/
public MeetingInviteType inviteType;
/**< 邀请状态*/
public int inviteStatus;
}
removeUnjoindedMember
接口说明
移除未入会成员
接口定义
int removeUnjoindedMember(UnjoinedMemberInfo enjoinedMemberInfo)
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| enjoinedMemberInfo | UnjoinedMemberInfo | 未入会成员类型 |
UnjoinedMemberInfo: 未入会成员类型
public class UnjoinedMemberInfo {
/**
* 成员名称
*/
public String displayName;
/**
* 邀请事务id
*/
public String inviteTransId;
/**< 账号*/
public String account;
/**< subjectId*/
public String subjectId;
/**< 被邀请者信息*/
public String contact;
/**< 邀请类型*/
public MeetingInviteType inviteType;
/**< 邀请状态*/
public int inviteStatus;
}
返回值描述
无返回值