视频会议组件

CloudroomVideoMeeting 是会议核心控件,实现通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等功能 单例组件,整个程序的生命过程中只能有有一个实例


接口函数

注册、反注册监听回调通知

void registerCallBack(CloudroomVideoCallback callBack)
  • 功能 注册监听回调
  • 返回值
  • 参数
    • callBack 监听回调对象
void unregisterCallBack(CloudroomVideoCallback callBack)
  • 功能 反注册监听回调
  • 返回值
  • 参数
    • callBack 监听回调对象
void setMeetingCallBack(CloudroomVideoCallback callBack)
  • 功能 注册监听回调,注:建议使用registerCallBack替代
  • 返回值
  • 参数
    • callBack 监听回调对象

进入/退出/结束会议

void enterMeeting(int meetID, String pswd, String userID, String nikeName)
  • 功能 使用会议ID和密码(可为空)进入指定的视频会议
  • 返回值
  • 参数
    • meetID 视频会议ID
    • pswd 本次会议中的密码
    • userID 用户账号
    • nickName 用户昵称
  • 回调函数 enterMeetingRslt
void exitMeeting()
  • 功能 离开会议
  • 返回值
  • 参数

调用此接口离开会话时,其他会话用户会收到userLeftMeeting的消息通知

void stopMeeting(String cookie)
  • 功能 结束会议
  • 返回值
  • 参数
    • meetID 会议id
    • cookie 自定义数据(在响应消息中回传给调用者)
  • 回调函数 stopMeetingRslt

调用此接口结束会议时,其他会话用户会收到 meetingStopped

会议成员列表

ArrayList<MemberInfo> getAllMembers()
  • 功能 获取所有用户的信息
  • 返回值 所有用户的信息,详见定义MemberInfo
  • 参数

会议成员信息

MemberInfo getMemberInfo(String userId)
  • 功能 获取某个用户的信息
  • 返回值 用户的信息,详见定义MemberInfo说明
  • 参数
    • userID 用户ID

会议成员昵称

String getNickName(String userId)
  • 功能 获取某个用户的昵称
  • 返回值 用户的昵称
  • 参数
    • userID 用户ID

修改会议成员昵称

void setNickName(String userID, String nickName)
  • 功能 设置某个用户的昵称
  • 返回值
  • 参数
    • userID 用户ID
    • nickname 新的用户昵称
  • 回调函数 setNickNameRsp

    调用此接口如果设置成功,其他会话用户会收到 notifyNickNameChanged

用户是否在会议中

boolean isUserInMeeting(String userID)
  • 功能 判断某个用户是否在会议中
  • 返回值 用户是否在会议中
  • 参数
    • userID 用户的id

麦克风/扬声器列表(已废弃,无效)

void getAudioDeviceName(ArrayList<String> micNames,
            ArrayList<String> speakerNames)
  • 功能 获取系统上的麦克风扬声器
  • 返回值
  • 参数
    • micNames 麦克风设备列表
    • speakerNames 扬声器列表

麦克风设置

void setAudioCfg(AudioCfg cfg)
  • 功能 设置麦克风音频参数
  • 返回值
  • 参数
    • cfg 音频参数,详见定义AudioCfg

获取麦克风设置

AudioCfg getAudioCfg()
  • 功能 获取音频参数
  • 返回值 音频参数,详见定义AudioCfg
  • 参数

麦克风音量增益

boolean setMicVolumeScaling(int scale)
  • 功能 设置麦克风音量增益
  • 返回值 是否成功
  • 参数
    • scale 麦克风音量增益(范围:1-20)

麦克风声音大小

int getMicEnergy(String userID)
  • 功能 获取用户说话声音大小
  • 返回值 音量大小(0~10)
  • 参数
    • userID 用户的ID

开/关麦克风

void openMic(String userID)
  • 功能 打开用户的麦克风
  • 返回值
  • 参数
    • userID 用户的ID

打开麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数先会进入到AOPENING状态,等服务器处理后才会进入AOPEN状态,此时说话才能被采集到

void closeMic(String userID)
  • 功能 关闭用户的麦克风
  • 返回值
  • 参数
    • userID 用户的ID

关麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数会变为ACLOSE 关麦操作是立即生效的,会立即停止采集

麦克风状态

ASTATUS getAudioStatus(String userID)
  • 功能 获取用户的麦状态
  • 返回值 麦克风设备状态,详见定义ASTATUS
  • 参数
    • userID 登录成功后分配的ID

麦克风音量(已废弃,无效)

boolean setMicVolume(int level)
  • 功能 设置麦克风音量大小
  • 返回值 是否成功
  • 参数
    • level 麦克风音量大小
int getMicVolume()
  • 功能 获取麦克风音量大小
  • 返回值 麦克风音量大小
  • 参数

读写属性,音量范围取值 0-255

扬声器音量

boolean setSpeakerVolume(int level)
  • 功能 设置本地扬声器音量
  • 返回值 是否成功
  • 参数
    • level 本地扬声器音量
int getSpeakerVolume()
  • 功能 获取本地扬声器音量
  • 返回值 本地扬声器音量
  • 参数

读写属性,音量等级取值 0-255

扬声器静音

void setSpeakerMute(boolean bMute)
  • 功能 设置播放是否静音
  • 返回值 是否静音
  • 参数
    • bMute 播放是否静音
boolean getSpeakerMute()
  • 功能 获取播放是否静音
  • 说明 是否静音
  • 参数

声音外放

boolean setSpeakerOut(boolean speakerOut)
  • 功能 设置外放状态
  • 返回值 是否成功
  • 参数
    • speakerOut 是否外放
boolean getSpeakerOut()
  • 功能 获取外放状态
  • 返回值 是否外放
  • 参数

关闭所有人麦克风

void setAllAudioClose()
  • 功能 关闭所有用户的麦克风
  • 返回值
  • 参数

调用此接口后会话内其他人的麦克风会关闭,同时收到消息audioStatusChanged

摄像头设备列表

ArrayList<UsrVideoInfo> getAllVideoInfo(String userId)
  • 功能 获取用户所有的摄像头信息
  • 返回值 用户所有的摄像头信息,详见UsrVideoInfo说明
  • 参数
    • userID 用户ID

自定义摄像头

short createCustomVideoDev(String camName, VIDEO_FORMAT pixFmt, int width, int height, String extParams)
  • 功能 创建自定义摄像头(sdk最大支持5个)
  • 返回值 <0失败,>=0为videoID(摄像头ID)
  • 参数
    • camName 摄像头名称
    • pixFmt 格,详见定义VIDEO_FORMAT
    • width 图像宽度
    • height 图像高度
    • extParams 扩展参数,没有为空

添加成功后与本地摄像头处理一致;getAllVideoInfo接口可以识别摄像头类型

void destroyCustomVideoDev(short videoID)
  • 功能 消毁自定义摄像头
  • 返回值
  • 参数
    • videoID 摄像头id (createCustomVideoDev返回值)
void inputCustomVideoDat(short videoID, byte[] data, int timeStamp)
  • 功能 输入摄像头图像数据
  • 返回值
  • 参数
    • videoID 摄像头id (createCustomVideoDev返回值)
    • data 图像数据(请保证格式、和尺寸与摄像头匹配)
    • timeStamp 保留字段,请填0,

      视频设置

void setVideoCfg(VideoCfg cfg)
  • 功能 设置摄像头参数
  • 返回值
  • 参数
    • cfg 摄像头参数,详见定义VideoCfg

视频设备私有参数配置

void setLocVideoAttributes(short videoID, VideoAttributes attributes)
  • 功能 设置某个摄像头私有参数
  • 返回值
  • 参数
    • videoID 本地摄像头id
    • attributes 摄像头私有参数, 详见定义VideoAttributes
VideoAttributes getLocVideoAttributes(short videoID)
  • 功能 获取某个摄像头私有参数
  • 返回值 摄像头私有参数, 详见定义VideoAttributes
  • 参数
    • videoID 本地摄像头id

会议内可观看摄像头列表

ArrayList<UsrVideoId> getWatchableVideos()
  • 功能 获取会议内所有可观看的摄像头
  • 返回值 会议内所有可观看的摄像头,详见定义UsrVideoId
  • 参数

开/关摄像头

void openVideo(String userID)
  • 功能 打开用户的摄像头,以便本地、远端显示视频图像
  • 返回值
  • 参数
    • userID 用户的ID
  • 回调函数 openVideoDevRslt
void closeVideo(String userID)
  • 功能 关闭用户的摄像头
  • 返回值
  • 参数
    • userID 用户的ID

调用打开和关闭麦克风接口都会触发对应用户的videoStatusChanged

视频状态

VSTATUS getVideoStatus(String userID)
  • 功能 获取用户的摄像头状态
  • 返回值 麦克风摄像头状态,请参见VSTATUS定义
  • 参数
    • userID 用户的ID

获取/设置默认视频

short getDefaultVideo(String userID)
  • 功能 获取指定用户的默认摄像头
  • 返回值 摄像头ID
  • 参数
    • userID 用户ID

如果用户没有摄像头,返回0

void setDefaultVideo(String userID, short videoID)
  • 功能 设置默认的摄像头
  • 返回值
  • 参数
    • userID 用户ID
    • videoID 摄像头ID

videoID 应该从getAllVideoInfo返回值中获取

摄像头图像数据

RawFrame getVideoImg(UsrVideoId usrVideoID)
  • 功能 获取指定用户摄像头的最新图像
  • 返回值 指定用户摄像头的最新图像,详见RawFrame
  • 参数
    • UsrVideoId 用户摄像头ID,详见定义UsrVideoId

本地摄像头参数

String getLocalVideoParams(short videoID)
  • 功能 获取指定本地摄像头参数
  • 返回值 指定本地摄像头参数,json格式,如{"摄像头参数名称":[可用参数列表]}
  • 参数
    • videoID 摄像头ID
void setLocalVideoParam(short videoID, String param, String value)
  • 功能 设置指定本地摄像头参数
  • 返回值
  • 参数
    • videoID 摄像头ID
    • param 摄像头参数名称
    • value 摄像头参数值

屏幕共享状态

boolean isScreenShareStarted()
  • 功能 获取屏幕共享是否已开启
  • 返回值 屏幕共享是否已开启
  • 参数

屏幕共享图像数据

ScreenShareImg getShareScreenDecodeImg()
  • 功能 获取屏幕共享解码图像
  • 返回值 屏幕共享解码图像,详见ScreenShareImg说明
  • 参数

创建本地混图器

CRVIDEOSDK_ERR_DEF createLocMixer(String mixerID, MixerCfg mixerCfg, ArrayList<MixerContent> mixerContent)
  • 功能 创建本地混图器(用于本地录制、本地推流)
  • 返回值 CRVIDEOSDK_ERR_DEF
  • 参数
    • mixerID 混图器唯一标识
    • mixerCfg 混图器规格配置,详见定义MixerCfg
    • mixerContent 混图器内容配置,详见定义MixerContent
  • 注意事项
    • 当需要多个不同内容的录制、或直播时,就要创建多个混图器
    • 混图器开消比较大,多个同样图像的输出应该有一个混图器加上多个输出实现

更新本地混图器内容

CRVIDEOSDK_ERR_DEF updateLocMixerContent(String mixerID, ArrayList<MixerContent> mixerContent)

消毁本地混图器

void destroyLocMixer(String mixerID)
  • 功能 消毁本地混图器
  • 返回值
  • 参数
    • mixerID 混图器唯一标识,请确保创建了有效的混图器createLocMixer
  • 注意事项
    • 消毁本地混图器后, 基于此混图器的录制输出、直播推流输出将自动结束

获取本地混图器状态

MIXER_STATE getLocMixerState(String mixerID)
  • 功能 获取本地混图器状态
  • 返回值 MIXER_STATE
  • 参数
    • mixerID 混图器唯一标识,请确保创建了有效的混图器createLocMixer

开启本地录制、直播推流

CRVIDEOSDK_ERR_DEF addLocMixerOutput(String mixerID, ArrayList<MixerOutPutCfg> mixerOutput)
  • 功能 开启本地录制、开启直播推流
  • 返回值 CRVIDEOSDK_ERR_DEF
  • 参数
    • mixerID 混图器唯一标识,请确保创建了有效的混图器createLocMixer
    • mixerOutput 本地输出对象,详见定义MixerOutPutCfg
  • 注意事项
    • 可以一次添加多个输出,也可以依据业务需要稍后再添加新的输出
    • 多个输出不能同名、或同一url
    • 每个输出,有独立的信息通知,请见事件locMixerOutputInfo
    • 如果输出异常时,将自动停止

停止本地录制、直播推流

void rmLocMixerOutput(String mixerID, ArrayList<String> nameOrUrls)
  • 功能 停止本地录制、直播推流
  • 返回值
  • 参数
    • mixerID 混图器唯一标识,请确保创建了有效的混图器createLocMixer
    • nameOrUrls 要停止的录制文件名或直播url列表
  • 注意事项
    • 所有输出停止后并不会消毁混图器,如果混图器不再需要请手工消毁;

录制文件列表

ArrayList<RecordFileShow> getAllRecordFiles()
  • 功能 取得所有录制文件信息
  • 返回值 所有录制文件信息,详见定义RecordFileShow
  • 参数

录制列表添加/删除文件

int addFileToRecordMgr(String fileName, String filePath)
  • 功能 添加本地文件到录制文件管理中
  • 返回值 -1:本地文件不存在,0:成功,1:文件已经被添加过
  • 参数
    • filename 文件名,不含路径
    • filePath 文件路径,不含文件名

第三方录制文件调用此接口后可进行本地回放和上传到视频服务器上,和自己录制的文件一样可以正常在线播放和下载

void removeFromFileMgr(String fileName)
  • 功能 删除本地的录制文件,上传中的文件会被取消上传
  • 返回值 无
  • 参数
    • filename 文件名

已上传完成的服务器文件不受影响

上传/取消上传录制文件

void uploadRecordFile(String fileName)
  • 功能 上传文件
  • 返回值
  • 参数
    • filename 文件名
void uploadRecordFile(String fileName, String svrPathFileName)
  • 功能 上传文件到服务器指定位置
  • 返回值
  • 参数
    • filename 文件名
    • svrPathFileName 文件存放在服务器上的相对路径文件名(如/AA/BB/CC/test.mp4)
void cancelUploadRecordFile(String filename)
  • 功能 取消上传中的录制文件
  • 返回值
  • 参数
    • filename 文件名

回放录制文件

void playbackRecordFile(String filename)
  • 功能 回放录制文件
  • 返回值
  • 参数
    • filename 文件名

可创建影音控件显示录制内容,功能同接口startPlayMedia,如果录制文件被加密,则只能使用playbackRecordFile来回放

开始云端录制、云端直播

CRVIDEOSDK_ERR_DEF startSvrMixer(Map<String, MixerCfg> mutiMixerCfgs, Map<String, ArrayList<MixerContent>> mutiMixerContents, Map<String, ArrayList<MixerOutPutCfg>> mutiMixerOutputs)

更新云端录制、云端直播内容

CRVIDEOSDK_ERR_DEF updateSvrMixerContent(Map<String, ArrayList<MixerContent>> mutiMixerContents)

停止云端录制、云端直播

void stopSvrMixer()
  • 功能 停止云端录制、云端直播
  • 返回值
  • 参数
  • 注意事项

获取云端录制、云端直播状态

MIXER_STATE getSvrMixerState()
  • 功能 获取云端录制、云端直播状态
  • 返回值 MIXER_STATE
  • 参数

设置/获取会话内主功能页

void switchToPage(MAIN_PAGE main, SubPage sub)
  • 功能 功能切换
  • 返回值
  • 参数
    • main 功能类型,详见定义MAIN_PAGE
    • sub 子页面标识(如创建白板时返回的boardID),详见定义SubPage
MAIN_PAGE getCurrentMainPage()
  • 功能 获取当前主功能区
  • 返回值
    • mainPage 当前主功能区,详见定义MAIN_PAGE
  • 参数
SubPage getCurrentSubPage()
  • 功能 获取当前子页面
  • 返回值 当前子页面,详见定义SubPage
  • 参数

获取/设置会议内视频分屏模式

int getVideoWallMode()
  • 功能 获取视频墙当前分屏模式
  • 返回值 分屏模式,类型见VIDEO_LAYOUT_MODE定义
  • 参数
void setVideoWallMode(VIDEO_WALL_MODE wallMode)
  • 功能 设置视频墙分屏模式
  • 返回值
  • 参数

主视频

void setMainVideo(String userID)
  • 功能 设置当前哪个用户为主视频
  • 返回值
  • 参数
    • userID 用户ID
String getMainVideo()
  • 功能 获取当前哪个用户为主视频
  • 返回值 用户ID
  • 参数

读写属性

创建/关闭电子白板

SubPage createBoard(String title, int width, int height, int pageCount)
  • 功能 创建电子白板
  • 返回值 返回boardID,详见定义SubPage
  • 参数
    • title 白板名称
    • width 白板宽度
    • height 白板高度
    • pageCount 白板内有多个页(一般空白板1页,文档白板为实际页数)

其他参会者会收到notifyCreateBoard事件;同时后台会记录下白板数据,新入会者会收到notifyInitBoards事件 注意:创建完白板后,一定要及尽快调用initBoardPageDat初始化各页数据;如果需要所有参会者同步切到此白板,请调用switchToPage

void closeBoard(String boardID)
  • 功能 关闭电子白板
  • 返回值
  • 参数
    • boardID 白板标识

其他参会者将收到notifyCloseBoard事件;同时后台会移除对应白板的所有信息

初始化白板图元数据

void initBoardPageDat(SubPage boardID, int boardPageNo, String imgID, String elemetDatas)
  • 功能 初始化白板指定页数据
  • 返回值
  • 参数
    • boardID 白板标识
    • boardPageNo 白板第几页(0:代表第一页)
    • imgID 白板的背景图片标识(空代表无背影图)
    • elemetDatas 白板的初始图元(空代表无图元,一般在导入历史文件才用到),白板图元数据Json数组,详见定义BoardElement
  1. imgID非空时, 代表背景的图片ID。 img来源请参见getNetDiskDocFilePageInfo
  2. 其他参会者将收到notifyInitBoardPageDat事件;
  3. 后台会记录下白板的页数据,在新用户入会时,也会收到notifyInitBoardPageDat事件

添加/修改/删除白板图元

String createElementID()
  • 功能 创建图元标识
  • 返回值 elementID图元标识
void addBoardElement(SubPage boardID, int boardPageNo, String element)
  • 功能 添加图元信息
  • 返回值
  • 参数
    • boardID 白板标识
    • boardPageNo 白板的页序号(0为第一页)
    • element 图元信息,Json数据格式详见定义BoardElement

其他参会者会收到:notifyAddBoardElement事件同时后台会保存图元,新入会者会在notifyInitBoardPageDat中得到这些图元

void modifyBoardElement(String boardID, int boardPageNo, String element)
  • 功能 修改图元信息
  • 返回值
  • 参数
    • boardID 白板标识
    • boardPageNo 白板的页序号(0为第一页)
    • element 图元信息,Json数据格式详见定义BoardElement

其他参会者会收到:notifyModifyBoardElement事件,同时后台会覆盖对应图元的数据,新入会者会在notifyInitBoardPageDat中得到这些图元

void delBoardElement(String boardID, int boardPageNo, ArrayList<String> elementIDs)
  • 功能 删除图元
  • 返回值
  • 参数
    • boardID 白板标识
    • boardPageNo 白板的页序号(0为第一页)
    • elementIDs 图元id列表

其他参会者会收到notifyDelBoardElement事件,同时后台会移除这些图元,新入会者会在notifyInitBoardPageDat中将不包含这些图元

设置白板鼠标热点

void setMouseHotSpot(SubPage boardID, int boardPageNo, int x, int y)
  • 功能 设置鼠标热点信息
  • 返回值
  • 参数
    • boardID 白板标识,详见定义SubPage
    • boardPageNo 白板的页序号(0为第一页)
    • x 屏幕横坐标
    • y 屏幕纵坐标

白板翻页

void setBoardCurPageNo(SubPage boardID, int boardPageNo, int pagePos1, int pagePos2)
  • 功能 白板翻页
  • 返回值
  • 参数
    • boardID 白板标识,详见定义SubPage
    • boardPageNo 白板的页序号(0为第一页)
    • pagePos1 私有扩展参数1(如可用于页内x方向滚动位置)
    • pagePos2 私有扩展参数2(如可用于页内y方向滚动位置)

查询文档列表

void listNetDiskDocFile(String dir)
  • 功能 查询服务器指定目录下的内容(子目录名、上传的文档源文件及文档转换状态)
  • 返回值 无,查询结果请参见listNetDiskDocFileRslt
  • 参数
    • dir 要查询的目录,空或"/"时,代表查询根目录下的内容;

上传文档并转换

void uploadDocFileToNetDisk(String svrPathFileName, String locPathFileName)
  • 功能 上传并转换文档
  • 返回值 无,上传进度请参见notifyDocFileTransforProgress, 转换结果请调用listNetDiskDocFilegetDocPageFileInfo获取
  • 参数
    • svrPathFileName 服务器的路径文件名,包含目录时,服务器自动创建对应目录
    • locPathFileName 要上传文件的本地的路径文件名
  • 说明
    • 支持的文件格式有:doc,docx, ppt, pptx, pps, ppsx, xls, xlsx, et, ett, wps, wpt, dps, pdf, txt, log, ini, bmp, png, jpg, jpeg;

下载源始文档

void downloadNetDiskDocFile(String svrPathFileName, String locPathFileName)
  • 功能 下载源始文档
  • 返回值 无,下载进度请参见notifyDocFileTransforProgress
  • 参数
    • svrPathFileName 服务器的路径文件名
    • locPathFileName 文件下载后存放的本地的路径文件名,目录不存在时自动创建

取消文档传输

void cancelTransforNetDiskDocFile(String svrPathFileName)
  • 功能 取消文档传输
  • 返回值
  • 参数
    • svrPathFileName 服务器的路径文件名

删除文档

void deleteNetDiskDocFile(String svrPathFileName)
  • 功能 删除文档
  • 返回值 无, 删除结果请参见deleteNetDiskDocFileRslt
  • 参数
    • svrPathFileName 服务器的路径文件名

获取文档的转换信息

void getNetDiskDocFilePageInfo(String svrPathFileName)
  • 功能 获取文档的转换信息
  • 返回值 无, 结果请参见getNetDiskDocFilePageInfoRslt
  • 参数
    • svrPathFileName 服务器的路径文件名
  • 说明

下载文档转换后的页文件

void downloadNetDiskDocFilePage(String pagePathFileName, String locPathFileName)
  • 功能 下载文档转换后的页文件
  • 返回值 无,下载进度请参见notifyDocFileTransforProgress
  • 参数
    • pagePathFileName 页文件在服务器的路径文件名
    • locPathFileName 文件下载后存放的本地的路径文件名,目录不存在时自动创建
  • 说明
    • 页文件格式: 6字节保留,4字节图像格式(2:jpg, 4:png),4字节图像内容长度,图像内容

影音播放配置

void setMediaCfg (VideoCfg cfg)
  • 功能 配置远程影音共享时,图像质量参数
  • 返回值
  • 参数
    • cfg 图像质量参数,详见定义VideoCfg
VideoCfg getMediaCfg ()
  • 功能 获取影音共享图像质量参数
  • 返回值 图像质量参数,详见定义VideoCfg
  • 参数

开始/暂停/停止影音播放

void startPlayMedia(String filename, int bLocPlay)
  • 功能 播放影音文件
  • 返回值
  • 参数
    • filename 文件名,全路径
    • bLocPlay 是否仅仅本地播放(1:本地播放,0:会议内播放)
void startPlayMedia(String filename, int bLocPlay, boolean bPauseWhenFinished)
  • 功能 播放影音文件
  • 返回值
  • 参数
    • filename 文件名,全路径
    • bLocPlay 是否仅仅本地播放(1:本地播放,0:会议内播放)
    • bPauseWhenFinished 是否停在最后一帧

如果播放成功,其他人收到notifyMediaOpened,如果播放失败,请关注通知事件notifyMediaStop

void pausePlayMedia(boolean bPause)
  • 功能 暂停播放影音
  • 返回值
  • 参数
    • bPause 是否暂停
void stopPlayMedia()
  • 功能 停止影音播放
  • 返回值
  • 参数

其他人收到notifyMediaStop

设置播放进度

void setMediaPlayPos(int pos)
  • 功能 设置播放进度
  • 返回值
  • 参数
    • pos 设置播放位置,单位:毫秒

影音文件列表

ArrayList<String> getAllFilesInMediaPath()
  • 功能 取得影音文件夹下的所有可播放文件
  • 返回值 文件名列表
  • 参数

影音文件夹位于方法init的第二个参数sdkFilePath,sdk会在此文件中建立media的子文件夹,即为影音文件夹

影音播放信息

MediaInfo getMediaInfo()
  • 功能 取得影音文件信息
  • 返回值
  • 参数

影音播放音量

void setMediaVolume (int level)
  • 功能 设置影音播放的音量
  • 返回值
  • 参数
    • level 影音播放的音量,取值范围(0-255)
int getMediaVolume ()
  • 功能 读取影音播放的音量
  • 返回值 影音播放的音量,取值范围(0-255)
  • 参数

获取影音图像数据

MediaFrame getMediaImg(String userID)
  • 功能 取得影音帧信息
  • 返回值 影音帧信息,详见定义MediaFrame
  • 参数
    • userID 用户id

发送IM文本消息

String sendIMmsg(String text, String toUsrID, String cookie)
  • 功能 发送IM消息
  • 返回值 taskID 发送任务id
  • 参数
    • text 发送的文本消息
    • toUsrID 目标用户,如果用户ID为空,消息发送给会议内所有用户
    • cookie 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 回调函数 sendIMmsgRlst

添加图片资源

void setPicResource(String resID, Bitmap bitmap)
  • 功能 将图片资源设置给sdk
  • 返回值
  • 参数
    • resID 资源唯一标识;(可以是guid,也可以序号方式)
    • bitmap 图片对象,为空代表移除资源
void setPicResource(String resID, String picFile)
  • 功能 将图片资源设置给sdk
  • 返回值
  • 参数
    • resID 资源唯一标识;(可以是guid,也可以序号方式)
    • picFile 资源文件路径,为空代表移除资源
boolean setPicResource(String resID, View view)
  • 功能 将图片资源设置给sdk
  • 返回值
  • 参数
    • picID 资源唯一标识;(可以是guid,也可以序号方式)
    • view 控件对象,为空代表移除资源(注:不能是opengl显示控件,必须是在界面已经显示的控件)
boolean setPicResource(String resID, View view, Size size)
  • 功能 将图片资源设置给sdk
  • 返回值
  • 参数
    • picID 资源唯一标识;(可以是guid,也可以序号方式)
    • view 控件对象,为空代表移除资源(注:不能是opengl显示控件,必须是在界面已经显示的控件)
    • size 图片大小

通知回调函数

进入/结束会议结果

void enterMeetingRslt(CRVIDEOSDK_ERR_DEF sdkErr)
  • 功能 自己进入会议的结果
  • 参数
void stopMeetingRslt(CRVIDEOSDK_ERR_DEF sdkErr)
  • 功能 通知结束视频会议结果
  • 参数

设置会议成员昵称的结果

void setNickNameRsp(CRVIDEOSDK_ERR_DEF sdkErr, String userid, String newName)
  • 功能 设置昵称的结果
  • 参数
    • sdkErr 操作结果码, 详见定义CRVIDEOSDK_ERR_DEF
    • userid 用户id
    • newName 新的昵称

有人改昵称通知

void notifyNickNameChanged(String userID, String oldName, String newName)
  • 功能 某用户改变了昵称(改昵称的用户自身不会接收到此通知)
  • 参数
    • userID 改变昵称的某用户id
    • oldName 改变昵称的某用户昵称(改变之前的昵称)
    • newName 改变昵称的某用户昵称(改变之后的昵称)

有人进入/离开会议通知

void userEnterMeeting(String userID)
  • 功能 某用户进入了会议
  • 参数
    • userID 进入会议的用户id
void userLeftMeeting(String userID)
  • 功能 某用户离开了会议
  • 参数
    • userID 离开会议的用户id

会议掉线通知

void meetingDropped()
  • 功能 通知从会议里掉线了,收到该通知后可以调用enterMeeting尝试重新入会
  • 参数

如果用到了呼叫队列,掉线后不重新入会就必须调用hungupCall释放本次呼叫

会议被结束通知

void meetingStoped()
  • 功能 会议已被结束
  • 参数

网络状态变化通知

void netStateChanged(int level)
  • 功能 网络变化通知
  • 参数
    • level 网络状况等级(0~10,10分为最佳网络)

麦克风设备变化

void audioDevChanged()
  • 功能 通知本地音频设备有变化
  • 参数

麦克风状态变化

void audioStatusChanged(String userID, ASTATUS oldStatus, ASTATUS newStatus)
  • 功能 通知音频状态变化
  • 参数
    • userID 会议中设备的所有者
    • oldStatus 旧状态,详见定义ASTATUS
    • newStatus 新状态,详见定义ASTATUS

麦克风声音变化

void micEnergyUpdate( String userID, int oldLevel, int newLevel)
  • 功能 通知用户的说话声音强度更新
  • 参数
    • userID 用户标识ID
    • oldLevel 原来的说话声音强度(0~10)
    • newLevel 现在的说话声音强度(0~10)

打开摄像头结果

void openVideoRslt(String devID, boolean bSuccess)
  • 功能 打开摄像头设备操作结果
  • 参数
    • devID 摄像头设备ID
    • bSuccess 是否成功

视频状态变化

void videoStatusChanged(String userID, VSTATUS oldStatus, VSTATUS newStatus)
  • 功能 视频状态变化
  • 参数
    • userID 会议中设备的所有者
    • oldStatus 旧状态,详见定义VSTATUS
    • newStatus 新状态,详见定义VSTATUS

摄像头设备变化

void videoDevChanged(String userID)
  • 功能 通知用户的视频设备有变化
  • 参数
    • userID 设备变化的用户ID

通知视频图像数据

void notifyVideoData(UsrVideoId usrVideoID, long frameTime)
  • 功能 通知用户有新的视频数据
  • 参数
    • usrVideoID 用户摄像头标识ID,详见定义UsrVideoId
    • frmTime 图像的创建时间,可用作时间戳

收到此通知消息后,可通过getVideoImg获取图像显示;如果之前显示的帧时间和此值一致,说明此帧已显示过,直接忽略即可 如果使用了成员视频UI显示组件,不再需要自已关注此事件并进行显示处理

默认视频设备变化

void videoDevChanged(String userID,short videoID)
  • 功能 通知用户的视频默认设备有变化
  • 参数
    • userID 设备变化的用户ID
    • videoID 默认设备id

录制文件上传/取消上传错误

void uploadRecordFileErr(String fileName, int err)
  • 功能 上传录制文件错误通知
  • 参数
void cancelUploadRecordFileErr(int sdkErr)
  • 功能 取消上传错误通知
  • 参数

本地录制、本地直播状态变化通知

void locMixerStateChanged(String mixerID, MIXER_STATE state)
  • 功能 本地混图器状态变化通知
  • 参数
    • mixerID 混图器唯一标识
    • state 状态,详见定义MIXER_STATE

本地录制文件、本地直播信息通知

void locMixerOutputInfo(String mixerID, String nameOrUrl, String outputInfo)
  • 功能 本地录制文件、本地直播信息通知
  • 参数
    • mixerID 混图器唯一标识
    • nameOrUrl 录像名称、或直播url
    • outputInfo ,详见定义MixerOutputInfo

云端录制、云端直播状态变化通知

void svrMixerStateChanged(MIXER_STATE state, int err,String operatorID)
  • 功能 云端录制、云端直播状态变化通知
  • 参数

云端录制、云端直播内容变化通知

void svrMixerCfgChanged()
  • 功能 云端录制、云端直播内容变化通知
  • 参数

云端录制文件、云端直播信息变化通知

void svrMixerOutputInfo(MixerOutputInfo info)
  • 功能 云端录制文件、云端直播信息变化通知
  • 参数 outputInfo 通知内容,详见定义MixerOutputInfo

    开始/停止屏幕共享通知

void notifyScreenShareStarted()
  • 功能 通知他人开启了屏幕共享
  • 参数
void notifyScreenShareStopped()
  • 功能 通知他人停止了屏幕共享
  • 参数

通知屏幕共享图像数据

void notifyScreenShareData(String userID, Rect changedRect, Size frameSize)
  • 功能 通知对端屏幕图像有变化
  • 参数
    • userID 对端用户ID
    • changedRect 变化区域信息
    • frameSize 屏幕大小

如果使用了屏幕共享UI显示组件,不再需要自已关注此事件并进行显示处理。

发送IM消息结果

void sendIMmsgRlst(String taskID, CRVIDEOSDK_ERR_DEF sdkErr, String cookie)
  • 功能 发送IM消息时,通知使用者发送结果
  • 参数
    • taskID 发送任务id
    • sdkErr 操作返回码,详见定义CRVIDEOSDK_ERR_DEF
    • cookie 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

通知收到IM消息

void notifyIMmsg(String fromUserID, String text, int sendTime)
  • 功能 通知收到IM消息
  • 参数
    • fromUserID 消息来源
    • text 消息内容
    • sendTime 消息发送时间戳,从1970开始算起

会话内主功能页切换通知

void notifySwitchToPage(MAIN_PAGE mainPage, SubPage pageID)
  • 功能 通知功能切换
  • 参数
    • mainPage 功能类型,详见定义MAIN_PAGE
    • pageID 子页面标识,详见定义SubPage

会话内视频分屏模式通知

void notifyVideoWallMode(VIDEO_WALL_MODE model)
  • 功能 通知视频分屏模式切换
  • 参数

会话内主视频变化通知

void notifyMainVideo(String userID)
  • 功能 通知主视频更改
  • 参数
    • userID 主视频用户ID

通知初始化电子白板列表

void notifyInitBoards(ArrayList<SubPageInfo> boards)
  • 功能 SDK入会后通知会议中已经存在的白板列表
  • 参数
    • boards 已经创建好的白板列表, 详见定义SubPageInfo

通知初始化白板内图元数据

void notifyInitBoardPageDat(String boardID, int boardPageNo, String imgID, String elementDatas,String operatorID)
  • 功能 初始化白板页数据
  • 参数
    • boardID 白板标识
    • boardPageNo 白板页序号
    • imgID 页背景文件ID(空代表无背景), 使用downloadNetDiskDocFile进行下载
    • elementDatas 此页的所有图元,白板图元数据Json数组,详见定义BoardElement
    • operatorID 初始化用户(为空时,代表入会时后台事件)

通知创建/关闭白板

void notifyCreateBoard(SubPageInfo board, String operatorID)
  • 功能 通知创建白板
  • 参数
    • board 白板信息,详见定义SubPageInfo
    • operatorID 创建白板的用户ID
void notifyCloseBoard(SubPage boardID, String operatorID)
  • 功能 通知关闭白板
  • 参数
    • boardID 白板标识,详见定义SubPage
    • operatorID 关闭白板的用户ID

通知添加/修改/删除白板图元

void notifyAddBoardElement(SubPage boardID, int boardPageNo, String element, String operatorID)
  • 功能 通知添加图元信息
  • 参数
    • boardID 白板标识,详见定义SubPage
    • boardPageNo 白板页序号
    • element 图元信息, Json数据格式详见定义BoardElement
    • operatorID 添加图元的用户ID
void notifyModifyBoardElement(SubPage boardID, int boardPageNo, String element, String operatorID)
  • 功能 通知图元信息被修改
  • 参数
    • boardID 白板标识,详见定义SubPage
    • boardPageNo 白板页序号
    • element 图元信息, Json数据格式详见定义BoardElement
    • operatorID 添加图元的用户ID

应从页内找到旧的图元并替换

void notifyDelBoardElement(SubPage boardID, int boardPageNo, ArrayList<String> elementIDs, String operatorID)
  • 功能 通知图元被删除
  • 参数
    • boardID 白板标识,详见定义SubPage
    • elementIDs 图元id列表
    • operatorID 删除图元的用户ID

通知白板鼠标热点

void notifyMouseHotSpot(SubPage boardID, int boardPageNo, int x, int y, String operatorID)
  • 功能 通知鼠标热点消息
  • 参数
    • boardID 白板标识,详见定义SubPage
    • x 屏幕横坐标
    • y 屏幕纵坐标
    • operatorID 操作者的用户ID

通知白板翻页

void notifyBoardCurPageNo(SubPage boardID, int boardPageNo, int pagePos1, int pagePos2)
  • 功能 通知白板翻页
  • 返回值
  • 参数
    • boardID 白板标识,详见定义SubPage
    • boardPageNo 白板的页序号(0为第一页)
    • pagePos1 私有扩展参数1(如可用于页内x方向滚动位置)
    • pagePos2 私有扩展参数2(如可用于页内y方向滚动位置)

通知录制文件状态变化

void notifyRecordFileStateChanged(String fileName, int state)
  • 功能 通知录制文件状态更改
  • 参数
    • fileName 本地文件路径
    • state 状态,0未上传,1上传中,2已上传,3上传失败

通知录制文件上传成功

void uploadRecordFileSuccess(String fileName, String fileUrl)
  • 功能 通知录制文件状态更改
  • 参数
    • fileName 本地文件路径
    • fileUrl 服务端录制文件地址

通知录制文件上传进度

void notifyRecordFileUploadProgress(String fileName, int percent)
  • 功能 通知录制文件上传进度
  • 参数
    • fileName 本地文件路径
    • percent 进度0-100

通知影音打开/播放/暂停/停止

void notifyMediaOpened(int totalTime, int width, int height)
  • 功能 通知影音文件打开
  • 参数
    • totalTime 影音时长(毫秒)
    • width 宽度
    • height 高度
void notifyMediaStart(String userid)
  • 功能 通知影音开始播放
  • 参数
    • userid 操作者的用户id
void notifyMediaPause(String userid, int bPause)
  • 功能 通知设置鼠标热点消息
  • 参数
    • userid 操作者的用户id
    • bPause 是否暂停,1暂停,0播放
void notifyMediaStop(String userid, int reason)
  • 功能 通知影音播放停止
  • 参数
    • userid 操作者的用户id
    • reason 播放停止原因,数值参考MEDIA_STOP_REASON

通知更新影音播放进度

void notifyPlayPosSetted(int setPTS)
  • 功能 通知播放进度已设置完成
  • 参数
    • setPTS 播放进度

通知影音播放图像数据

void notifyMemberMediaData(String userid, int curPos)
  • 功能 通知影音帧数据已解码完毕
  • 参数
    • userid 操作者的用户id
    • curPos 该影音帧的时间,毫秒为单位

收到此通知消息后,可通过getMediaImg获取图像显示;但如果之前显示的帧时戳更大,说明此通知消息已过时,直接忽略即可 如果使用了影音共享UI显示组件,不再需要自已关注此事件和进行显示处理

通知语音PCM数据

void notifyAudioPCMDat(int aSide, byte[] audioDat)
  • 功能 通知语音PCM数据
  • 参数
    • aSide 声道类型
    • audioDat PCM数据

通知查询文档列表结果

void listNetDiskDocFileRslt(String dir, CRVIDEOSDK_ERR_DEF sdkERR, NetDiskDocDir docDir)
  • 功能 通知查询文档列表结果
  • 参数

通知查询文档转换结果

void getNetDiskDocFilePageInfoRslt(String svrPathFileName, CRVIDEOSDK_ERR_DEF sdkErr, NetDiskDocFilePageInfo pageInfo)
  • 功能 通知查询文档转换结果
  • 参数

通知删除文档结果

void deleteNetDiskDocFileRslt(String svrPathFileName, CRVIDEOSDK_ERR_DEF sdkERR)
  • 功能 通知删除文档结果
  • 参数

通知文档传输进度

void notifyNetDiskDocFileTrsfProgress(String svrPathFileName, int percent)
  • 功能 通知文档传输进度
  • 参数
    • svrPathFileName 传输的文档,或页文件名
    • percent 传输进度(等于100代表传输完成)
© HeDonghai all right reserved,powered by Gitbook文件修订时间: 2019-03-28 17:33:42

results matching ""

    No results matching ""