方法 | 描述 |
SDK 单例(请在同一线程中使用) | |
初始化 SDK | |
获取sdk版本 |
方法 | 描述 |
小鱼账号密码登录 | |
三方账号登录 | |
tokne登录 | |
账号密码登录 | |
authcod登录 | |
退出登录 |
方法 | 描述 |
呼叫 | |
更改会议模式 | |
挂断 | |
结束全体会议 |
方法 | 描述 |
统一layout配置 | |
统一layout请流 |
方法 | 描述 |
本地视频 关闭,打开 | |
设置视频是否mute | |
获取本地视频source ID | |
设置本地镜像 | |
切换系统摄像头 | |
开启音频 | |
停止音频 | |
麦克风静音 | |
扬声器静音 |
方法 | 描述 |
获取主持会议配置信息 | |
获取会控地址 | |
举手发言/取消举手 | |
结束发言 | |
设置会控解除静音是否需要终端同意 | |
会控解除静音申请 | |
终端回调会控是否开启/关闭摄像头 |
方法 | 描述 |
开启云端录制 | |
结束录制 |
方法 | 描述 |
开启内容共享 | |
停止内容共享 | |
开启屏幕录制 | |
停止屏幕录制 | |
屏幕录制是否采集音频 | |
发送content数据 |
方法 | 描述 |
获取会中简单统计 | |
获取会中详细统计 |
方法 | 描述 |
添加回调 | |
移除回调 | |
写入log | |
保存crash日志 | |
日志上传 | |
获取日志标识 | |
更新dump日志 | |
保存详细日志dump | |
保存音频dump | |
音频dump设置 |
方法 | 描述 |
网络链接 | |
登录结果 | |
用户被踢 | |
入会状态 | |
会中请流 | |
会议信息 | |
点对点邀请 | |
会议呼叫错误 | |
出入会通知 | |
网络状态变化 | |
申请发言回调 | |
会中改名结果回调 | |
切换会议模式回调 | |
本地网络质量等级 | |
会议室状态回调 | |
主持人身份变更回调 | |
联席主持人权限变更 | |
会议中改名权限变更通知 | |
会控排序 回调 | |
会控静音/取消静音 | |
会控开启/关闭摄像头 | |
会中最新发言人 | |
结束分组回调 | |
是否检测到啸叫(用户可降低声音或关闭麦克风结束啸叫) | |
云端录制状态回调 | |
云端录制失败回调 | |
获取会控H5链接回调 | |
会控状态变化回调 | |
会控静音回调 | |
获取主持会议的相关配置信息和状态回调 | |
云端录制权限回调 | |
日志上传结果回调 | |
屏幕录制结束回调 | |
屏幕录制开始回调 |
/**
* 网络链接状态
* @param state 状态
*/
onNetworkStateChanged(state: XYSDKNetworkState): void;
/**
* 登录结果回调
* @param loginState 登录状态
* @param accountInfo 用户信息
* @param error 错误码
*/
onLoginStateChanged(loginState: XYSDKLoginState, accountInfo: XYSDKAccountInfo, error: XYSDKError): void;
/**
* 用户被踢
* @param reason 原因
*/
onKickOut(reason: XYSDKKickOutReason): void;
/**
* 入会状态回调
* @param callStateInfo 回调信息
*/
onCallStateChanged(callStateInfo: XYSDKCallStateInfo): void;
/**
* 会中请流回调
* @param streamArray 视频流数组
*/
onVideoStreamChanged(streamArray: XYSDKVideoStreamInfo[]): void;
/**
* 会议信息回调
* @param info 会议信息
*/
onConfInfoChanged(info: XYSDKConfInfo): void;
/**
* 点对点邀请
* @param invited 是否邀请
* @param callInfo 邀请信息
*/
onCallInvited(invited: boolean, callInfo: XYSDKCallInfo): void;
/**
* 会议邀请
* @param number 号码
* @param displayName 显示名称
*/
onMeetingInvited(number: string, displayName: string): void;
/**
* 会议呼叫错误
* @param error 错误吗
*/
onCallError(error: XYSDKCallError): void;
/**
* 出入会通知
* @param xYInOutInfos
*/
onConfInOutNotification(xYInOutInfos: XYSDKInOutInfo[]): void;
/**
* 网络状态变化
* @param
*/
onRemoteNetworkRecv(infos: XYSDKRemoteNetworkParam[]): void;
/**
* 申请发言回调
* @param callIndex
* @param xYApplySpeakInfo
*/
onApplySpeakingResult(callIndex: number, xYApplySpeakInfo: XYSDKApplySpeakInfo): void
/**
* 会中改名结果回调
* @param xYBaseResult
*/
onSetUserNameInMeetingResult(xYBaseResult: XYSDKBaseResult): void;
/**
* 切换会议模式回调
* @param callIndex
* @param callMode
* @param reason
*/
onConfCallModeChanged(callMode: XYSDKCallMode, reason: string): void;
/**
* 本地网络质量等级
* 上报规则:回调频率根据入会终端期望带宽和DBA(动态带宽调整)探测带宽的比例计算
* @param { 1、2、3、4 } level - 网络状况等级,4档:1、2、3、4 分别为:差、中、良、优
*/
onNetworkIndicatorLevelChanged(level: number): void;
/**
* 会议室状态回调
* @param xYConfProperty
*/
onConfPropertyChanged(xYConfProperty: XYConfProperty): void;
/**
* 主持人身份变更回调
* @param host
*/
onHostAuthorityChanged(host: boolean): void;
/**
* 联席主持人权限变更
* @param coChair
*/
onCoChairAuthorityChanged(coChair: boolean): void;
/**
* 会议中改名权限变更通知
* @param meetingId
* @param enable
*/
onModifyNameAuthority(meetingId: string, enable: boolean): void;
/**
* 会控排序 回调
* @param meetingId
*/
onMeetingControlEnableSort(meetingId: string): void;
/**
* 会控静音/取消静音
* @param xySDKControlMuteAction
*/
onMeetingControlMuteActionChange(xySDKControlMuteAction: XYSDKControlMuteAction): void;
/**
* 会控开启/关闭摄像头
* @param operation
*/
onMeetingControlVideoMuteActionChange(operation: XYSDKMeetingControlMuteChangeParam): void;
/**
* 会中最新发言人
* @param speakersInfos
*/
onSpeakersChanged(speakersInfos: XYSDKSpeakersInfoPut[]): void;
/**
* 结束分组回调
* @param result
*/
onEndDynamicGroupResult(result: XYSDKBaseResult): void;
/**
* 是否检测到啸叫(用户可降低声音或关闭麦克风结束啸叫)
* @param detected
*/
onHowlingDetected(detected: boolean): void;
/**
* 云端录制状态回调
* @param state
* @param err
* @param recordInfo
* @param reason
*/
onRecordResult(state: XYSDKCloudRecordState, err: XYSDKError, recordInfo: XYSDKRecordInfo, reason: string): void;
/**
* 云端录制失败回调
* @param result
*/
onRecordErrorResult(result: XYSDKBaseResult): void;
/**
* 获取会控H5链接回调
* @param url
* @param displayName
*/
onHostMeetingUrlResult(url: string, displayName: string): void;
/**
* 会控状态变化回调
* @param info
*/
onConfMgmtChanged(info: XYSDKConfMgmtInfo): void;
/**
* 会控静音回调
* @param result
*/
onMeetingControlMuteResult(result: XYSDKBaseResult): void;
/**
* 获取主持会议的相关配置信息和状态回调
* @param info
*/
onGetMeetingControlConfigResult(info: XYSDKMeetingControlConfigInfo): void;
/**
* 云端录制权限回调
* @param authorized
*/
onCloudRecordPermissionChanged(authorized: boolean): void;
/**
* @brief 日志上传结果回调
* @param result 回调结果
*/
onLogUploadResult(cresult: XYSDKLogUploadResult): void;
/**
* 屏幕录制结束回调
* @param code
*/
onScreenCaptureStop(code: XYSDKScreenCaptureStopCode): void;
/**
* 屏幕录制开始回调
* @param code
*/
onScreenCaptureStart(): void;
/**
* 获取sdk 对象
* @returns
*/
static getInstance(): XYRTCEngineIF;
/**
* 初始化SDK
* @param configs
* @returns
*/
init(configs: XYSDKConfig): XYSDKError;
/**
* 获取sdk 版本
*/
getVersion(): string;
/**
* 账号密码登录
* @param userName
* @param password
* @param enhancePassword 是否为强密码
*/
loginXYLinkAccount(userName: string, password: string, enhancePassword: string): void;
/**
* 使用第三方账户登录
* @param extUserId 三方用户ID,同一企业不能相同
* @param displayName 显示名称,不能包含以下字符 ';' ':' ',' '=' '-' '(' ')' '[' ']' '{' '}' '@' '#' '*' '\\' '\r' '\n' '\t'
*/
loginExternalAccount(extUserId: string, displayName: string): void;
/**
* token登录
* @param extId 企业标志,联系小鱼销售人员获取
* @param token
*/
loginExtToken(extId: string, token: string): void;
/**
* 账号登录
* @param extId 企业标志,联系小鱼销售人员获取
* @param countryCode 国家码
* @param account 用户名
* @param password 密码
*/
loginXYAccount(extId: string, countryCode: string, account: string, password: string): void;
/**
* authCode户登录
* @param extId 企业标志,联系小鱼销售人员获取
* @param displayName 显示名称
* @param extUID 三方用户ID,同一企业不能相同
* @param authCode 授权码
*/
loginExtUserId(extId: string, displayName: string, extUID: string, authCode: string): void;
/**
* 登出
*/
logout(): void;
/**
* makeCall 呼叫入会
* @param callConfig 配置信息
*/
makeCall(callConfig: XYSDKCallConfig): void;
/**
* 更改会议模式
* @param callMode 会议模式
* @param audioMute 音频状态
* @param videoMute 视频状态
*/
setCallMode(callMode: XYSDKCallMode, audioMute: boolean, videoMute: boolean): void;
/**
* 挂断
*/
hangup(): void;
/**
* 结束全体会议
*
* @param { string } callurl - 呼叫者Id
* @param { string } conferenceNo - 会议号
*/
endMeeting(callurl: string, conferenceNo: string): void;
/**
* 统一layout模版设置
* @param config
*/
setUnityLayoutConfig(config: XYSDKUnityLayoutLayoutConfig): void
/**
* 统一layout请流
* @param unityLayoutRequests
*/
changeLayout(unityLayoutRequests: Array<XYSDKUnityLayoutRequest>): void;
/**
* 本地视频 关闭,打开
* @param enable 是否打开
*/
setLocalVideoEnabled(enable: boolean): void;
/**
* 设置视频是否mute
* @param isMute 是否mute
*/
videoMute(isMute: boolean): void;
/**
* 获取本地sourceId
* @returns
*/
getLocalSourceID(): string;
/**
* 设置本地视频镜像
* @param flip
*/
setLocalVideoFlip(flip: boolean): void;
/**
* 切换系统摄像头
*/
switchPreviewCamera(): void;
/**
* 开启音频采集
* @param micMute 麦克风mute
* @param speakerMute 扬声器mute
*/
startAudio(micMute: boolean, speakerMute: boolean): void;
/**
* 停止音频采集
*/
stopAudio(): void;
/**
* 音频是否启动
* @returns
*/
isRunAudio(): boolean;
/**
* 麦克风静音
* @param mute 是否mute
* @param reason mute原因
*/
micMute(mute: boolean, reason: XYSDKAudioMuteReason): void;
/**
* 扬声器静音
* @param mute
*/
speakerMute(mute: boolean): void;
/**
* 获取主持会议的相关配置信息和状态
* @param conferenceNo 会议号
* @param scheduledMeetingId 预约id
*/
checkHostMeetingPermission(conferenceNo: string, scheduledMeetingId: string): void;
/**
* 获取会控H5链接
* @param number
*/
getHostMeetingUrl(number: string): void;
/**
* 举手发言/取消举手
* @param speaking
*/
speakingReq(speaking: boolean): void;
/**
* 结束发言
*/
speakingEnd(): void;
/**
* 主持人解除静音时,是否需要本人同意设置
* @param need 是否需要本人确认
*/
setNeedConsentWhenHostReqUnmute(need: boolean): void;
/**
* 收到会控请求后解除静音
* @param mID 会议id
* @param mNum 会议号
* @param callURI 解除静音者的callurl
* @param encryption 加密信息
*/
unmuteAsRequiredByHost(mID: string, mNum: string, callURI: string, encryption: string): void;
/**
* 终端回调会控是否开启/关闭摄像头
* @param agree 是否同意
* @param reason 原因
*/
replyMeetingControlMuteAction(agree: boolean, reason: string): void;
/**
* 开启云端录制, 是否在挂断会议时自动停止,true为自动停止, 否则为false
* @param autoStopByDropCall
*/
startCloudRecord(autoStopByDropCall: boolean): void;
/**
* 关闭远端录制
*/
stopCloudRecord(): void;
/**
* 开启共享
* @param mode
* @param bMediaFile 暂不支持 传 no
* @param bEnableAnnotation 暂不支持 传 no
*/
startContentSharing(mode: XYSDKDualStreamMode, bMediaFile: boolean, bEnableAnnotation: boolean): void
/**
* 停止共享
*/
stopContentSharing(): void;
/**
* 开启屏幕录制
* @param audioMute
*/
startScreenCapture(audioMute: boolean): void;
/**
* 停止屏幕录制
*/
stopScreenCapture(): void;
/**
* 更新屏幕录制是否采集音频
* @param callBack
*/
updateScreenCaptureMicMute(audioMute: boolean): void;
/**
* 发送content数据 deprecated see#inputExternalVideoData
* @param buffer
* @param bufLen
* @param width
* @param height
* @param stride
*/
putContentData(buffer: ArrayBuffer, bufLen: number, width: number, height: number, stride: number): void;
/**
* 获取通话简单统计信息
* @returns { XYStatistics } - 信息
*/
getStatistics(): XYSDKStatistics;
/**
* 获取通话详细统计信息
* @returns { XYDetailStatistics } - 信息
*/
getDetailStatistics(): XYSDKDetailStatistics;
/**
* 添加代理
* @param delegate
*/
addDelegate(delegate: XYRTCEngineDelegate): void;
/**
* 移除代理
* @param delegate
*/
removeDelegate(delegate: XYRTCEngineDelegate): void;
/**
* log 日志
* @param log
*/
log(log: string): void;
/**
* 保存crash日志
* @param filePath
*/
saveCrashFile(filePath: string): void;
/**
* 日志上传
* @param type 日志类型
* @param comments 日志描述
*/
logUpload(type: XYSDKLogType, comments: string, logId: string): void;
/**
* 根据日志类型获取日志标识
* @param dumpType 日志类型
* @returns 日志标识
*/
getDumpFlagValue(dumpType: XYSDKDumpType): number;
/**
* 更新会中dump日志
* @param dumpMask 标识 通过getDumpFlagValue获取哦
*/
setMediaDumpMask(dumpMask: number): void;
/**
* 获取详细日志dump
*/
saveDump(): void;
/**
* 保存音频dump
*/
saveAudioDump(): void;
/**
* 入会前设置 dump音频数据
*/
enableAudioDump(): void;