可视化组件

可视化组件由多个模块组成, 主要模块包括:成员视频UI显示组件屏幕共享UI显示组件影音共享UI显示组件。 通过集成SDK的相关控件, 让使用者进行更加快速, 高效的开发工作。

接口描述

可视化组件:

组件 方式 接口 描述
成员视频UI显示组件 主调 setUsrVideoId 设置显示的目标用户视频
getUsrVideoId 获取当前显示的用户/摄像头编号
savePicToFile 保存视频截图到图片文件
savePicToBase64
getPicFrameTime 获取图像时间戳
isPicEmpty 检查图像是否为空
getPicWidth, getPicHeight 获取图像宽、高
clear 清空缓存的图像
setScaleType,getScaleType 设置图像显示模式
屏幕共享UI显示组件 主调
影音共享UI显示组件 主调 savePicToFile 保存播放影音画面到图片文件
savePicToBase64
getPicFrameTime 获取图像时间戳
isPicEmpty 检查图像是否为空
getPicWidth, getPicHeight 获取图像宽、高
clear 清空缓存的图像
setScaleType,getScaleType 设置图像显示模式

接口函数详情

1. 成员视频UI显示组件

com.cloudroom.cloudroomvideosdk.VideoUIView 是视频显示控件,它显示设定的用户的视频, 是由视频房间组件内相关接口的封装而成,如果此方式不满足需求,可以使用视频房间组件内相关的接口自行实现。 多实例方式,在会话中可以为每一个视频用户创建一个用来显示其画面

设置视频源

void setUsrVideoId(UsrVideoId usrVideoId)

  • 功能:  设置显示的目标用户视频

  • 返回值:  无

参数 类型 含义
usrVideoId UsrVideoId 目标用户视频ID

void setUsrVideoId(UsrVideoId usrVideoId, int qualityLv)

  • 功能:  设置显示的目标用户视频

  • 返回值:  无

参数 类型 含义
usrVideoId UsrVideoId 目标用户视频ID
qualityLv int 视频档位(1:默认档位,2:对应quality2,3:对应quality3,如果2,3未开启时将显示1档的视频流)
  • 注意事项:

    • 从房间内可观看摄像头列表中获取userID和videoID

获取用户/摄像头编号

UsrVideoId getUsrVideoId()

  • 功能:  获取当前显示的用户

  • 返回值:  用户视频ID

保存成员画面截图

int savePicToFile(String pathFileName, CompressFormat format)

  • 功能:  保存视频截图到图片文件

  • 返回值:  0成功,非0为保存遇到的错误码

参数 类型 含义
pathFileName String 保存为本地路径文件名
format CompressFormat 图片格式

String savePicToBase64(CompressFormat format)

  • 功能:  保存视频截图为base64数据字符串

  • 返回值:  以base64编码的图片数据,不成功返回空

参数 类型 含义
format CompressFormat 图片格式

获取图像信息

  • 功能:  获取图像时间戳

  • 返回值:  当前图像数据对应的时间戳

boolean isPicEmpty()

  • 功能:  检查图像是否为空

  • 返回值:  图像是否为空

int getPicWidth()

  • 功能:  获取图像宽

  • 返回值:  宽

int getPicHeight()

  • 功能:  获取图像高

  • 返回值:  高

清空成员画面内容

void clear()

  • 功能:  清空缓存的图像

  • 返回值:  无

设置图像显示模式

void setScaleType(int scaleType)

  • 功能:  设置图像显示模式

  • 返回值:  无

参数 类型 含义
scaleType int

0:等比缩放留空居中显示;

1:等比缩放裁剪铺满显示;

2:不等比缩放铺满显示(可能导致图像拉伸);

int getScaleType()

  • 功能:  获取视频显示模式

  • 返回值:  int

    0:等比缩放留空居中显示;

    1:等比缩放裁剪铺满显示;

    2:不等比缩放铺满显示(可能导致图像拉伸);

2. 屏幕共享UI显示组件

com.cloudroom.cloudroomvideosdk.ScreenShareUIView 是屏幕共享开启后远端显示控件, 是由视频房间组件内相关接口的封装而成,如果此方式不满足需求,可以使用视频房间组件内相关的接口自行实现。

3. 影音共享UI显示组件

com.cloudroom.cloudroomvideosdk.MediaUIView 影音显示控件, 是由视频房间组件内相关接口的封装而成,如果此方式不满足需求,可以使用视频房间组件内相关的接口自行实现功能。

保存影音画面截图

int savePicToFile(String pathFileName, CompressFormat format)

  • 功能:  保存播放影音画面到图片文件

  • 返回值:  0成功,非0为保存遇到的错误码

参数 类型 含义
pathFileName String 保存为本地路径文件名
format CompressFormat 图片格式

String savePicToBase64(CompressFormat format)

  • 功能:  保存播放截图为base64数据字符串

  • 返回值:  以base64编码的图片数据,不成功返回空

参数 类型 含义
format CompressFormat 图片格式

获取影音图像信息

int getPicFrameTime()

  • 功能:  获取图像时间戳

  • 返回值:  当前图像数据对应的时间戳

boolean isPicEmpty()

  • 功能:  检查图像是否为空

  • 返回值:  图像是否为空

int getPicWidth()

  • 功能:  获取图像宽

  • 返回值:  宽

int getPicHeight()

  • 功能:  获取图像高

  • 返回值:  高

清空影音画面内容

void clear()

  • 功能:  清空缓存的图像

  • 返回值:  无

设置图像显示模式

void setScaleType(int scaleType)

  • 功能:  设置图像显示模式

  • 返回值:  无

参数 类型 含义
scaleType int

0:等比缩放留空居中显示;

1:等比缩放裁剪铺满显示;

2:不等比缩放铺满显示(可能导致图像拉伸);

int getScaleType()

  • 功能:  获取视频显示模式

  • 返回值:  int

    0:等比缩放留空居中显示;

    1:等比缩放裁剪铺满显示;

    2:不等比缩放铺满显示(可能导致图像拉伸);