容器类
显示容器的基类
CRVideo.Container()
Methods
- handler() ------ object对象
- height() ------ 容器的高度
- id() ------ id
- style() ------ 容器的样式
- width() ------ 容器的宽度
- top() ------ 容器的头部位置
- left() ------ 容器的左边位置
- shows() ------ 容器的显示
- hidden() ------ 容器的消失
屏幕共享播放的呈现容器
CRVideo_CreatScreenShareObj(VideoContainerObj)
- 功能:
- 创建屏幕video对象,并封装返回这个对象
- 参数:
- VideoContainerObj ----- 视屏配置对象,定义见VideoContainerObj
- 返回值:
- 封装好的video对象
Methods
clear() ------ 清空缓存的图像
ctrlOpen(value) ------ 开启控制模式
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | true: 开启, false:不开启 |
- enableMarked(value) ------ 开启标注模式
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | 0: 不开启, 1:开启 |
- isPicEmpty(num) ------ 检查图像是否为空
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | 0: 有图像, 1:无图像 |
- keepAspectRatio(num) ------ 绘制模式,是否拉伸绘制
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | true: 保持比例不拉伸, false:不保持比例进行拉伸 |
- savePic(pathFileName) ------ 拍照
- 返回值:0:成功; 非0:保存遇到的错误码(bool)
参数 | 类型 | 说明 |
---|---|---|
pathFileName | string | 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg) |
- setPenStyle(intRgba:, penWidth) ------ 设置标注画笔样式
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
intRgba | num | 颜色,排列方式bgr(8:8:8) |
penWidth | num | 画笔宽度 |
视频的呈现容器
CRVideo_CreatVideoObj(VideoContainerObj)
- 功能:
- 创建video对象,并封装返回这个对象
- 参数:
- VideoContainerObj ----- 视屏配置对象,定义见VideoContainerObj
- 返回值:
- 封装好的video对象
Methods
clear() ------ 清理当前图像
getVideoID() ------ 获取当前显示的用户的视频设备
- 返回值:视频ID (string)
getVisibleNickName() ------ 获取是否显示昵称
- 返回值:否显示昵称 (bool)
handler() ------ object对象
- 继承:CRVideo.Container.handler()
height() ------ 容器的高度
- 继承:CRVideo.Container.height()
id() ------ id
- 继承:CRVideo.Container.id()
isPicEmpty() ------ 检查图像是否为空
- 返回值:图像是否为空 (bool)
keepAspectRatio(value) ------ 设置显示的视频画面是否保持比例
参数 | 类型 | 说明 |
---|---|---|
value | bool | true: 保持比例不拉伸, false:不保持比例进行拉伸 |
- savePic(pathFileName) ------ 拍照
- 返回值:0:成功; 非0:保存遇到的错误码 (bool)
参数 | 类型 | 说明 |
---|---|---|
pathFileName | string | 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg) |
- savePicToBase64(format) ------ 拍照
- 返回值:Base64为图片数据字符串,不成功则为空 (string)
参数 | 类型 | 说明 |
---|---|---|
format | string | 图片格式,支持bmp, png, gif, jpg, jpeg |
- setVideo(userID, videoID) ------ 设置显示的目标用户视频
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
userID | string | 目标用户ID |
videoID | number | 用户的指定视频设备(-1,代表用户的默认视频设备) |
注意:配置后就会建立视频通道并占用带宽。 如果不再观看时,应设为空:setVideo("", -1)。
- setVisibleNickName(value) ------ 设置是否显示昵称
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | 否显示昵称 |
- visibleNickName(value) ------ 检查昵称是否可见
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
value | bool | 0: 可见, 1:不可见 |
style() ------ 容器的样式
- 继承:CRVideo.Container.style()
width() ------ 容器的宽度
- 继承:CRVideo.Container.width()
shows() ------ 容器的显示
- 继承:CRVideo.Container.shows()
hidden() ------ 容器的消失
- 继承:CRVideo.Container.hidden()
left() ------ 容器的左边位置
- 继承:CRVideo.Container.left()
top() ------ 容器的头部位置
- 继承:CRVideo.Container.top()
影音播放的呈现容器
CRVideo_CreatMediaObj(VideoContainerObj)
- 功能:
- 创建屏幕video对象,并封装返回这个对象
- 参数:
- VideoContainerObj ----- 视屏配置对象,定义见VideoContainerObj
- 返回值:
- 封装好的video对象
Methods
- disableToolBar(bDisable) ------ 工具条是否可用
参数 | 类型 | 说明 |
---|---|---|
bDisable | number | 0:可用; 非0:不可用; |
shows() ------ 容器的显示
- 继承:CRVideo.Container.shows()
hidden() ------ 容器的消失
- 继承:CRVideo.Container.hidden()
left() ------ 容器的左边位置
- 继承:CRVideo.Container.left()
top() ------ 容器的头部位置
- 继承:CRVideo.Container.top()
handler() ------ object对象
- 继承:CRVideo.Container.handler()
height() ------ 容器的高度
- 继承:CRVideo.Container.height()
id() ------ id
- 继承:CRVideo.Container.id()
keepAspectRatio(value) ------ 绘制模式,是否拉伸绘制
参数 | 类型 | 说明 |
---|---|---|
value | bool | true: 保持比例不拉伸, false:不保持比例进行拉伸 |
- savePicToBase64(format) ------ 保存播放影音画面到图片文件
- 返回值:Base64字符串 (string)
参数 | 类型 | 说明 |
---|---|---|
format | string | 支持格式:bmp, png, gif, jpg, jpeg |
- savePicToFile(pathFileName) ------ 保存播放影音画面到图片文件
- 返回值:0成功,非0失败 (number)
参数 | 类型 | 说明 |
---|---|---|
pathFileName | string | 本地绝对路径文件名(支持格式:bmp, png, gif, jpg, jpeg) |
- setToolBarUIElementVisible(UIElement, isVisible) ------ 显示隐藏播放工具条上的界面元素
- 返回值:无
参数 | 类型 | 说明 |
---|---|---|
UIElement | CRVideo_ToolBarUI | 界面元素 |
isVisible | bool | 是否可见 |
style() ------ 容器的样式
- 继承:CRVideo.Container.style()
width() ------ 容器的宽度
- 继承:CRVideo.Container.width()