开发者中心 - 小鱼易连

setVideoProfile

版本支持: v3.3.0+

接口概述: 设置摄像头采集参数，发送、接受视频最大能力，呼叫前设置有效

接口定义:

virtual void setVideoProfile(const XYVideoProfile& videoProfile) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoProfile	XYVideoProfile	是	无	配置信息

setRenderResources

版本支持: v3.3.0+

接口概述: 设置订阅参会者列表(最大20个)，优先请流

接口定义:

virtual void setRenderResources(const XYArray<void*>& resources) = 0;

接口参数:

参数名	类型	必填	默认值	描述
resources	XYArray	是	无	订阅者参会列表数据为uri为参会者设备唯一标志，如：123456@DESK，123456为小鱼用户ID，DESK(桌面)为终端类型

setVideoRenderConfig

版本支持: v3.3.0+

接口概述: 设置本地视频渲染配置

接口定义:

virtual void setVideoRenderConfig(bool bEnablePushData, const XYArray<void*>& localWnd, void* localContentWnd) = 0;

接口参数:

参数名	类型	必填	默认值	描述
bEnablePushData	bool	是	无	是否继续往上层回传视频渲染数据
localWnd	XYArray	是	无	本地视频显示窗口句柄
localContentWnd	void*	是	无	共享内容回显窗口句柄

setLocalPreviewFlip

版本支持: v3.3.0+

接口概述: 设置本地视频镜像翻转

接口定义:

virtual void setLocalPreviewFlip(bool bFlip) = 0;

接口参数:

参数名	类型	必填	默认值	描述
bFlip	bool	是	无	是否翻转

openOtherLocalPreview

版本支持: v3.3.0+

接口概述: （d3d11）开启本地其他路视频

接口定义:

virtual void openOtherLocalPreview(void* hwnd) = 0;

接口参数:

参数名	类型	必填	默认值	描述
hwnd	void*	是	无	窗口句柄

closeOtherLocalPreview

版本支持: v3.3.0+

接口概述: （d3d11）关闭本地其他路视频

接口定义:

virtual void closeOtherLocalPreview(void* hwnd) = 0;

接口参数:

参数名	类型	必填	默认值	描述
hwnd	void*	是	无	窗口句柄

startCamera

版本支持: v3.3.0+

接口概述: 启动摄像头采集 & 用于摄像头检测会中或者会议建立以后（onCallStateChanged(connected)）

接口定义:

virtual void startCamera() = 0;

stopCamera

版本支持: v3.3.0+

接口概述: 关闭摄像头采集 & 用于摄像头检测会中或者退会之前关闭（onCallStateChanged(disconnected)）

接口定义:

virtual void stopCamera() = 0;

clearLocalPreview

版本支持: v3.3.0+

接口概述: 清空本地视频渲染画面

接口定义:

virtual void clearLocalPreview() = 0;

clearOtherLocalPreview

版本支持: v3.3.0+

接口概述: 清空本地其它路视频渲染画面

接口定义:

virtual void clearOtherLocalPreview(void* hwnd) = 0;

接口参数:

参数名	类型	必填	默认值	描述
hwnd	void*	是	无	窗口句柄

bindGLRender

版本支持: v3.3.0+

接口概述: ui与native gl render 绑定

接口定义:

virtual void bindGLRender(void* videoRenderId) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoRenderId	void*	是	无	ui video render id

unbindGLRender

版本支持: v3.3.0+

接口概述: ui与native gl render 解绑

接口定义:

virtual void unbindGLRender(void* videoRenderId) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoRenderId	void*	是	无	ui video render id

canPaintGL

版本支持: v3.3.0+

接口概述: can paint gl

接口定义:

virtual bool canPaintGL(void* videoRenderId) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoRenderId	void*	是	无	ui video render id

返回值:
返回bool类型的绘制状态

paintGL

版本支持: v3.3.0+

接口概述: ui上调用gl render，实现opengl画面渲染

接口定义:

virtual void paintGL(void* videoRenderId, const XYGLOption& option) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoRenderId	void*	是	无	ui video render id
option	XYGLOption	是	无	绘制选项

getVideoFrame

版本支持: v3.3.0+

接口概述: 获取视频裸数据

接口定义:

virtual bool getVideoFrame(const char* sourceId, bool isContent, XYVideoFrame& frame, XYVideoFormat videoFromat = YUY2) = 0;

接口参数:

参数名	类型	必填	默认值	描述
sourceId	const char*	是	无	视频流id
isContent	bool	是	无	是否为内容共享
frame	XYVideoFrame	是	无	获取到的视频帧信息
videoFromat	XYVideoFormat	否	YUY2	视频格式

返回值:
返回bool类型的获取状态, 是否获取成功

getVideoDataBySourceId

版本支持: v3.3.0+

接口概述: 获取视频源的图像信息

接口定义:

virtual const XYArray<uint8_t>& getVideoDataBySourceId(const char* videoSourceId) = 0;

接口参数:

参数名	类型	必填	默认值	描述
videoSourceId	const char*	是	无	视频流id

返回值:
返回XYArray类型的图像数据, 图像的字节数组

getSpeakerPeakMeter

版本支持: v3.3.0+

接口概述: 获取本地扬声器能量(音量检测使用)

接口定义:

virtual int getSpeakerPeakMeter() = 0;

返回值:
返回int类型的扬声器能量, 本地扬声器能量

getSpeakerVolume

版本支持: v3.3.0+

接口概述: 获取扬声器能量(具体值 0-100)

接口定义:

virtual int getSpeakerVolume() = 0;

返回值:
返回int类型的扬声器音量, 扬声器能量

setSpeakerVolume

版本支持: v3.3.0+

接口概述: 设置本地扬声器能量（具体值0-100）

接口定义:

virtual void setSpeakerVolume(int volume) = 0;

接口参数:

参数名	类型	必填	默认值	描述
volume	int	是	无	设置数值

getMicPeakMeter

版本支持: v3.3.0+

接口概述: 获取本地麦克风能量（检测使用）

接口定义:

virtual int getMicPeakMeter() = 0;

返回值:
返回int类型的麦克风能量, 麦克风能量

getMicVolume

版本支持: v3.3.0+

接口概述: 获取麦克风能量（具体值0-100）

接口定义:

virtual int getMicVolume() = 0;

返回值:
返回int类型的麦克风音量, 麦克风能量

setMicVolume

版本支持: v3.3.0+

接口概述: 设置麦克风能量（具体值0-100）

接口定义:

virtual void setMicVolume(int value) = 0;

接口参数:

参数名	类型	必填	默认值	描述
value	int	是	无	麦克风能量

startAudioCapture

版本支持: v3.3.0+

接口概述: 开始音频采集

接口定义:

virtual void startAudioCapture() = 0;

stopAudioCapture

版本支持: v3.3.0+

接口概述: 停止音频采集

接口定义:

virtual void stopAudioCapture() = 0;

setAudioPeakMeterEnabled

版本支持: v3.3.0+

接口概述: 开启远端音频能量峰值计量

接口定义:

virtual void setAudioPeakMeterEnabled(bool enable) = 0;

接口参数:

参数名	类型	必填	默认值	描述
enable	bool	是	无	是否开启

getAudioPeakMeters

版本支持: v3.3.0+

接口概述: 获取远端音频能量

接口定义:

virtual const XYArray<XYAudioMeterInfo>& getAudioPeakMeters() = 0;

返回值:
返回XYArray<XYAudioMeterInfo>类型的音频能量信息, 远端音频能量信息List

setMicDataByAEEnabled

版本支持: v3.3.0+

接口概述: 音频旁路

接口定义:

virtual void setMicDataByAEEnabled(bool enabled) = 0;

接口参数:

参数名	类型	必填	默认值	描述
enabled	bool	是	无	是否开启

releaseAudioFocus

版本支持: v3.3.0+

接口概述: 释放音频焦点, 会外设备检测完成之后, 如果需要释放音频的话调用

接口定义:

virtual void releaseAudioFocus() = 0;

enablePulseHelper

版本支持: v3.3.0+

接口概述: pulse支持

接口定义:

virtual void enablePulseHelper(bool enable) = 0;

接口参数:

参数名	类型	必填	默认值	描述
enable	bool	是	无	是否开启

setAudioAutoGainCtrl

版本支持: v3.3.0+

接口概述: 设置mic增益, 通过调节mic采集增益来放大输出声音, 但是噪声也会放大

接口定义:

virtual void setAudioAutoGainCtrl(int gain) = 0;

接口参数:

参数名	类型	必填	默认值	描述
gain	int	是	无	增益范围[0 - 20]

pausePSE

版本支持: v3.3.0+

接口概述: PSE 开启/关闭

接口定义:

virtual void pausePSE(bool pause) = 0;

接口参数:

参数名	类型	必填	默认值	描述
pause	bool	是	无	是否暂停

isCurSelectHeadSet

版本支持: v3.3.0+

接口概述: 检查使用的采集设备是否为耳机

接口定义:

virtual bool isCurSelectHeadSet() = 0;

返回值:
返回bool类型的设备类型, 是否为耳机

2025-08-08 14:58:54

导出PDF文档