iOS-SDK

可视化组件

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

接口描述

可视化组件：

组件 方式 接口 描述
视频UI显示组件基类 主调 getVideoSize 获取绘制视频size
clearFrame 清除图像缓存
成员视频UI显示组件 主调 setUsrVideoId 设置显示的目标用户视频
getUsrVideoId 获取当前显示的用户/摄像头编号
getVideoImage 获取当前显示图像
屏幕共享UI显示组件 主调 无 无
影音共享UI显示组件 主调 无 无

接口函数详情

1. 视频UI显示组件基类

CLBaseView 是视频显示控件的基类，提供基础接口。如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现。

属性

@property (nonatomic, assign) BOOL keepAspectRatio

  • true:保持比例, false:不保持比例

-(CGSize)getVideoSize

  • 功能:  获取绘制视频size

  • 返回值:  视频大小

- (void)clearFrame

  • 功能:  清除图像缓存

  • 返回值:  无

2. 成员视频UI显示组件

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

设置视频源

-(void)setUsrVideoId:(UsrVideoId *)usrVideoId

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

  • 返回值:  无

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

-(void)setUsrVideoId:(UsrVideoId *)usrVideoId qualityLv:(int)qualityLv

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

  • 返回值:  无

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

  • 注意事项:

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

3. 屏幕共享UI显示组件

CLShareView 是屏幕共享开启后远端显示控件， 是由视频房间组件内相关接口的封装而成，如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现。 该方式整个程序内建议只创建一个实例。

  • 使用方式:

    • 只需要摆放好控件，设置正确尺寸即可显示。

4. 影音共享UI显示组件

CLMediaView 影音显示控件， 是由视频房间组件内相关接口的封装而成，如果此方式不满足需求，可以使用视频房间组件内相关的接口自行实现功能。 单例方式，整个程序的生命过程中只能有一个实例。

  • 使用方式:

  • 只需要摆放好控件，设置正确尺寸即可显示。

← 常量定义→