音视频通讯SDK API参考手册  Windows 1.6.0
tencent::av::AVSupportVideoPreview类 参考abstract

视频预览能力的封装类。 更多...

#include <av_device.h>

类 tencent::av::AVSupportVideoPreview 继承关系图:
tencent::av::AVCameraDevice tencent::av::AVLocalScreenVideoDevice tencent::av::AVRemoteScreenVideoDevice tencent::av::AVRemoteVideoDevice

struct  PreviewParam
 视频预览能力的封装类。 更多...
 

Public 类型

typedef void(* PreviewCallback) (VideoFrame *video_frame, void *custom_data)
 SetPreviewCallback()的回调函数。 更多...
 

Public 成员函数

virtual void SetPreviewCallback (PreviewCallback frame_callback, void *custom_data=NULL)=0
 设置视频预览回调。 更多...
 
virtual int SetPreviewParam (std::string id, uint32 width, uint32 height, ColorFormat color_format)=0
 设置预览视频画面的参数。 更多...
 
virtual int ClearPreviewParam ()=0
 清空所有预览视频画面的参数。 更多...
 
virtual PreviewCallback GetPreviewCallback ()=0
 获取视频预览回调函数。 更多...
 
virtual void * GetPreviewCustomData ()=0
 获取视频预览回调自定义数据。 更多...
 

详细描述

SDK的各种视频设备封装类,通过继承AVSupportVideoPreview,向App提供视频预览能力。 App可以通过AVSupportVideoPreview获得视频设备的输入/输出数据。

参数
device_id当为空字符串时,代表这个设备的所有画面都用这组设置的参数;当不为空时,如果该设备是AVRemoteVideoDevice时,将device_id设置为远端设备对应的成员identifier,就可以针对每个成员的画面设置这些参数。
width预览画面宽度。如果设置为0,代表用视频图像的默认宽度和高度。
height预览画面高度。如果设置为0,代表用视频图像的默认宽度和高度。
color_format预览视频图像的颜色格式。 如果设置为COLOR_FORMAT_NONE,代表用视频图像默认的颜色格式。
src_type视频源类型。每个设备的视频源类型是固定的。

类说明

struct tencent::av::AVSupportVideoPreview::PreviewParam

通过SetPreviewParam设置,通过ClearPreviewParam来清空设置,当有图像数据时,SDK会根据设置参数进行转换。

如果没有设置过任何参数,则拿到的图像数据为原始图像数据。

类成员
ColorFormat color_format 预览期望图像像素宽
string device_id
uint32 height 预览期望图像像素高
VideoSrcType src_type 预览期望图像格式
uint32 width 预览设备id

成员类型定义说明

typedef void(* tencent::av::AVSupportVideoPreview::PreviewCallback) (VideoFrame *video_frame, void *custom_data)

此函数是和SetPreviewCallback()一起使用的回调函数,用来向App回传视频数据。

参数
video_frame视频帧对象。
custom_data值等于调用SetPreviewCallback()时的入参custom_data。

成员函数说明

virtual int tencent::av::AVSupportVideoPreview::ClearPreviewParam ( )
pure virtual
备注
清空后,预览接口将返回原始图像。
virtual PreviewCallback tencent::av::AVSupportVideoPreview::GetPreviewCallback ( )
pure virtual
备注
App可以通过获取上次设置的音频预览回调函数,没有设置过返回NULL。
virtual void* tencent::av::AVSupportVideoPreview::GetPreviewCustomData ( )
pure virtual
备注
App可以通过获取上次设置的音频预览自定义数据,没有设置过返回NULL
virtual void tencent::av::AVSupportVideoPreview::SetPreviewCallback ( PreviewCallback  frame_callback,
void *  custom_data = NULL 
)
pure virtual

App可以通过设置视频预览回调,在回调函数中获得视频设备的输入/输出数据。

参数
[in]frame_callback函数指针,指向App定义的回调函数,NULL表示取消回调。
[in]custom_dataApp指定的一个没有类型的指针,SDK会在回调函数中把该值回传给App。
virtual int tencent::av::AVSupportVideoPreview::SetPreviewParam ( std::string  id,
uint32  width,
uint32  height,
ColorFormat  color_format 
)
pure virtual
参数
id画面Id。如果是本地摄像头画面,因为只有一路,可以填""。如果是远端视频画面,填每个画面的成员id即可。
width预览画面宽度,最好是4的倍数。
height预览画面高度,最好是4的倍数。
color_format色彩格式,SDK目前只支持RGB24、I420。
备注
可以给每路成员分别设置,也可以给所有成员统一设置。如果是给所有成员设置, 则id填""即可。