RtcEngine, PanoRtc的核心接口更多...

#include <PanoRtcEngine.h>

类
class	Callback
	RtcEngine的回调函数，在使用RtcEngine之前必须要设置回调以获取事件通知。更多...

struct	ChannelConfiguration
	频道配置参数，用于加入会议更多...

struct	Configuration
	RtcEngine 配置参数，用于RtcEngine初始化更多...

Public 成员函数
virtual QResult	initialize (const Configuration &config)=0
	使用配置参数初始化RtcEngine 更多...

virtual QResult	joinChannel (const char token, const char channelId, uint64_t userId, const ChannelConfiguration &config)=0
	加入频道更多...

virtual QResult	leaveChannel ()=0
	离开频道更多...

virtual QResult	startAudio ()=0
	开启音频更多...

virtual QResult	stopAudio ()=0
	关闭音频更多...

virtual QResult	startSoundCardShare ()=0
	开始声卡音频共享更多...

virtual QResult	stopSoundCardShare ()=0
	停止声卡音频共享更多...

virtual QResult	startSoundCardMonitor (RtcRenderSink *sink)=0
	开始声卡数据监控器更多...

virtual QResult	stopSoundCardMonitor ()=0
	停止声卡数据监控器更多...

virtual QResult	startVideo (void *window, const VideoConfig &config)=0
	开启视频，并且设置渲染窗口更多...

virtual QResult	startVideo (RtcRenderSink *sink, VideoProfileType profileType)=0
	开启视频，并且设置数据接收槽更多...

virtual QResult	startVideo (RtcRenderSink *sink, const VideoSourceConfig &config)=0
	开启视频，并且设置数据接收槽更多...

virtual QResult	stopVideo ()=0
	关闭视频更多...

virtual QResult	subscribeAudio (uint64_t userId)=0
	订阅用户的音频。更多...

virtual QResult	unsubscribeAudio (uint64_t userId)=0
	取消订阅用户的音频。更多...

virtual QResult	subscribeVideo (uint64_t userId, void *window, const VideoConfig &config)=0
	订阅用户的视频，并设置渲染窗口。更多...

virtual QResult	subscribeVideo (uint64_t userId, RtcRenderSink *sink, VideoProfileType profileType)=0
	订阅用户的视频，并设置视频数据接收槽。更多...

virtual QResult	unsubscribeVideo (uint64_t userId)=0
	取消订阅用户的视频。更多...

virtual QResult	muteAudio ()=0
	静音。更多...

virtual QResult	unmuteAudio ()=0
	取消静音。更多...

virtual QResult	muteVideo ()=0
	暂停视频。更多...

virtual QResult	unmuteVideo ()=0
	恢复视频。更多...

virtual QResult	startScreen ()=0
	开启屏幕共享。更多...

virtual QResult	startScreen (RtcRenderSink *sink)=0
	开启共享，并且设置数据接收槽更多...

virtual QResult	startScreen (RtcRenderSink *sink, const ScreenConfig &config)=0
	开启共享，并且设置数据接收槽更多...

virtual QResult	updateScreenConfig (const ScreenConfig &config)=0
	更新屏幕共享采集配置。更多...

virtual QResult	stopScreen ()=0
	停止屏幕共享。更多...

virtual QResult	muteScreen ()=0
	暂停屏幕共享。更多...

virtual QResult	unmuteScreen ()=0
	恢复屏幕共享。更多...

virtual QResult	subscribeScreen (uint64_t userId, void *window)=0
	订阅用户的屏幕共享, 并且设置渲染窗口。更多...

virtual QResult	subscribeScreen (uint64_t userId, RtcRenderSink *sink)=0
	订阅用户的屏幕共享并且设置数据接收槽更多...

virtual QResult	unsubscribeScreen (uint64_t userId)=0
	取消订阅用户的屏幕共享。更多...

virtual QResult	callout (const char *phoneNo, bool bindToUser)=0
	拨打电话号码。更多...

virtual QResult	dropCall (const char *phoneNo)=0
	挂断拨出或拨入的电话。更多...

virtual QResult	updateScreenScalingRatio (uint64_t userId, ScreenScalingRatio ratio)=0
	更新屏幕的绝对缩放比例。更多...

virtual QResult	updateScreenScalingRatioWithFocus (uint64_t userId, float ratio, int x, int y)=0
	更新屏幕的相对缩放比例。更多...

virtual QResult	updateScreenMovingDistance (uint64_t userId, int dx, int dy)=0
	更新屏幕的相对移动距离。更多...

virtual QResult	startAudioDump (const char *filePath, int64_t maxFileSize=-1)=0
	开启音频转储。更多...

virtual QResult	stopAudioDump ()=0
	停止音频转储。更多...

virtual QResult	setParameters (const char *param)=0
	设置自定义参数给PANO SDK。更多...

virtual AudioDeviceManager *	getAudioDeviceManager ()=0
	获取音频设备管理器的指针更多...

virtual VideoDeviceManager *	getVideoDeviceManager ()=0
	获取视频设备管理器的指针更多...

virtual NetworkManager *	getNetworkManager ()=0
	获取网络管理器的指针更多...

virtual ScreenSourceManager *	getScreenSourceManager ()=0
	获取屏幕源管理器的指针更多...

virtual AudioMixingManager *	getAudioMixingManager ()=0
	获取音频混音管理器更多...

virtual VideoStreamManager *	getVideoStreamManager ()=0
	获取视频流管理器更多...

virtual VideoRenderManager *	getVideoRenderManager ()=0
	获取视频渲染管理器更多...

virtual AnnotationManager *	getAnnotationManager ()=0
	获取标注管理器更多...

virtual RtcGroupManager *	getGroupManager ()=0
	获取分组管理器的接口指针更多...

virtual RtcMessage *	getMessageService ()=0
	获取消息服务的接口指针更多...

virtual RemoteController *	getRemoteController ()=0
	获取远程控制服务的接口指针更多...

virtual PanoRecording *	getRecordingService ()=0

virtual RtcWhiteboard *	getWhiteboardEngine ()=0
	获取白板引擎指针更多...

virtual QResult	switchWhiteboardEngine (const char *whiteboardId)=0
	切换白板引擎更多...

virtual QResult	setMediaStatsObserver (MediaStatsObserver *observer)=0
	设置媒体统计信息观察器更多...

virtual QResult	setScreenCaptureObserver (ScreenCaptureObserver *observer)=0
	设置屏幕共享抓屏观察器更多...

virtual QResult	setAudioIndication (AudioIndication *indication, uint32_t intervalMs=200)=0
	设置用户音频指示器更多...

virtual QResult	setMediaProcessor (MediaProcessorType type, void processor, void param=nullptr)=0
	设置媒体处理模块更多...

virtual QResult	snapshotVideo (const char *outputDir, uint64_t userId, SnapshotVideoOption option)=0
	捕获指定用户的视频画面更多...

virtual DeviceRating	queryDeviceRating ()=0
	查询当前设备的评分值。更多...

virtual QResult	setOption (OptionType option, void *param, uint32_t size)=0
	设置参数更多...

virtual QResult	sendFeedback (const FeedbackInfo &info)=0
	发送用户反馈到 PANO。更多...

virtual QResult	sendAudioControlMessage (const PanoData &data)=0
	从音频RTC通道传输(外部自定义)音频通知消息。备注：这个消息的数据最大长度为1024个字节，且最多每秒发送5次消息。更多...

virtual void	destroy ()=0

详细描述

RtcEngine, PanoRtc的核心接口

成员函数说明

◆ callout()

virtual QResult RtcEngine::callout	(	const char *	phoneNo,
		bool	bindToUser
	)

pure virtual

拨打电话号码。

参数

phoneNo	电话号码。
bindToUser	是否绑定到用户。

返回

OK: 操作成功
其他: 操作失败

◆ destroy()

virtual void RtcEngine::destroy ( )

pure virtual

销毁RtcEngine

◆ dropCall()

virtual QResult RtcEngine::dropCall ( const char * phoneNo )

pure virtual

挂断拨出或拨入的电话。

参数

phoneNo 电话号码。空值为挂断绑定到自己的电话。

返回

OK: 操作成功
其他: 操作失败

◆ getAnnotationManager()

virtual AnnotationManager * RtcEngine::getAnnotationManager ( )

pure virtual

获取标注管理器

返回

非空指针：指向标注管理器的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getAudioDeviceManager()

virtual AudioDeviceManager * RtcEngine::getAudioDeviceManager ( )

pure virtual

获取音频设备管理器的指针

返回

非空指针：指向音频设备管理器对象的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getAudioMixingManager()

virtual AudioMixingManager * RtcEngine::getAudioMixingManager ( )

pure virtual

获取音频混音管理器

返回

非空指针：指向音频混音管理器的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getGroupManager()

virtual RtcGroupManager * RtcEngine::getGroupManager ( )

pure virtual

获取分组管理器的接口指针

返回

非空指针：指向分组管理器接口对象的指针。
空指针: 失败

注解: 不要删除此指针， RtcEgine会维护其生命周期。

◆ getMessageService()

virtual RtcMessage * RtcEngine::getMessageService ( )

pure virtual

获取消息服务的接口指针

返回

非空指针：指向消息服务接口对象的指针。
空指针: 失败

◆ getNetworkManager()

virtual NetworkManager * RtcEngine::getNetworkManager ( )

pure virtual

获取网络管理器的指针

返回

非空指针：指向网络管理器对象的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getRemoteController()

virtual RemoteController * RtcEngine::getRemoteController ( )

pure virtual

获取远程控制服务的接口指针

返回

非空指针：指向远程控制服务接口对象的指针。
空指针: 失败

◆ getScreenSourceManager()

virtual ScreenSourceManager * RtcEngine::getScreenSourceManager ( )

pure virtual

获取屏幕源管理器的指针

返回

非空指针：指向屏幕源管理器对象的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getVideoDeviceManager()

virtual VideoDeviceManager * RtcEngine::getVideoDeviceManager ( )

pure virtual

获取视频设备管理器的指针

返回

非空指针：指向视频设备管理器对象的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getVideoRenderManager()

virtual VideoRenderManager * RtcEngine::getVideoRenderManager ( )

pure virtual

获取视频渲染管理器

返回

非空指针：指向视频渲染管理器的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ getVideoStreamManager()

virtual VideoStreamManager * RtcEngine::getVideoStreamManager ( )

pure virtual

获取视频流管理器

返回

非空指针：指向视频流管理器的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。; 如果应用各端都不会同时发送多路视频流，则无需使用视频流管理器。

◆ getWhiteboardEngine()

virtual RtcWhiteboard * RtcEngine::getWhiteboardEngine ( )

pure virtual

获取白板引擎指针

返回

非空指针：指向白板引擎的指针。
空指针: 失败

注解: 不要删除此指针， RtcEngine会维护其生命周期。

◆ initialize()

virtual QResult RtcEngine::initialize ( const Configuration & config )

pure virtual

使用配置参数初始化RtcEngine

参数

config 配置参数

返回

OK: 初始化成功
others: 初始化失败

注解

◆ joinChannel()

virtual QResult RtcEngine::joinChannel	(	const char *	token,
		const char *	channelId,
		uint64_t	userId,
		const ChannelConfiguration &	config
	)

pure virtual

加入频道

参数

token	App服务器向PANO获取的token，必须以"\0"结尾
channelId	应用定义的频道ID 最大长度是128字节必须以"\0"结尾频道ID只能由以下字符构成 "0-9", "a-z", "A-Z", 空格 (不能出现在首部和尾部), "!", "#", "$", "%", "&", "(", ")", "+", ",", "-", ".", ":" ";", "<", "=", ">", "?", "@", "[", "]", "^", "_", "\|", "~"
userId	应用定义的用户ID。在 [0xFFFEFF0000000000, 0xFFFEFFFFFFFFFFFF] 之间的 ID 保留给 SDK 使用
config	频道设置，可设置频道模式、用户名等参数

返回

OK: 调用成功
others：调用失败 @

注解: 用户需检查回调函数 onUserJoinIndication 获知加会结果, userId必须是一个非零整数，并且保证唯一。

◆ leaveChannel()

virtual QResult RtcEngine::leaveChannel ( )

pure virtual

离开频道

返回

OK: 调用成功
others：调用失败

注解: 此接口为同步调用

◆ muteAudio()

virtual QResult RtcEngine::muteAudio ( )

pure virtual

静音。

返回

OK: 成功
其他: 失败

注解: 静音前请先开启音频，否则操作将无效。

◆ muteScreen()

virtual QResult RtcEngine::muteScreen ( )

pure virtual

暂停屏幕共享。

返回

OK: 成功
其他: 失败

注解: 暂停屏幕共享前请先开启屏幕共享，否则操作将无效。

◆ muteVideo()

virtual QResult RtcEngine::muteVideo ( )

pure virtual

暂停视频。

返回

OK: 成功
其他: 失败

注解: 暂停视频前请先开启视频，否则操作将无效。

◆ queryDeviceRating()

virtual DeviceRating RtcEngine::queryDeviceRating ( )

pure virtual

查询当前设备的评分值。

返回: 设备评分

注解: 设备评分只在频道加入成功后才有效。

◆ sendAudioControlMessage()

virtual QResult RtcEngine::sendAudioControlMessage ( const PanoData & data )

pure virtual

从音频RTC通道传输(外部自定义)音频通知消息。备注：这个消息的数据最大长度为1024个字节，且最多每秒发送5次消息。

参数

data 音频控制消息

返回

OK: 成功
其他: 失败

◆ sendFeedback()

virtual QResult RtcEngine::sendFeedback ( const FeedbackInfo & info )

pure virtual

发送用户反馈到 PANO。

参数

info 反馈信息

返回

OK: 成功
其他: 失败

◆ setAudioIndication()

virtual QResult RtcEngine::setAudioIndication	(	AudioIndication *	indication,
		uint32_t	intervalMs = `200`
	)

pure virtual

设置用户音频指示器

参数

indication	提示汇报器
intervalMs	回调时间间隔，单位毫秒，不能低于10ms

返回

OK: 成功
其他: 失败

◆ setMediaProcessor()

virtual QResult RtcEngine::setMediaProcessor	(	MediaProcessorType	type,
		void *	processor,
		void *	param = `nullptr`
	)

pure virtual

设置媒体处理模块

参数

type	处理类型
processor	外接处理模块。值为空表示停止对应的处理。
param	处理模块所需参数，跟处理模块类型相关。

返回

OK: 成功
其他: 失败

注解: 媒体处理器指针必须保持其有效性，直到对应处理被停止。

◆ setMediaStatsObserver()

virtual QResult RtcEngine::setMediaStatsObserver ( MediaStatsObserver * observer )

pure virtual

设置媒体统计信息观察器

参数

observer 观察器

返回

OK: 成功
其他: 失败

◆ setOption()

virtual QResult RtcEngine::setOption	(	OptionType	option,
		void *	param,
		uint32_t	size
	)

pure virtual

设置参数

参数

option	参数类别
param	参数, 参数的定义需遵循不同的option所定义的参数结构
size	参数的大小

返回

OK: 成功
其他: 失败

◆ setParameters()

virtual QResult RtcEngine::setParameters ( const char * param )

pure virtual

设置自定义参数给PANO SDK。

参数

param JSON格式参数。

返回

OK: 成功
其他: 失败

◆ setScreenCaptureObserver()

virtual QResult RtcEngine::setScreenCaptureObserver ( ScreenCaptureObserver * observer )

pure virtual

设置屏幕共享抓屏观察器

参数

observer 观察器

返回

OK: 成功
其他: 失败

◆ snapshotVideo()

virtual QResult RtcEngine::snapshotVideo	(	const char *	outputDir,
		uint64_t	userId,
		SnapshotVideoOption	option
	)

pure virtual

捕获指定用户的视频画面

参数

outputDir	输出路径
userId	目标用户的ID
option	快照选项

返回

OK: 成功
其他: 失败

◆ startAudio()

virtual QResult RtcEngine::startAudio ( )

pure virtual

开启音频

返回

OK: 调用成功
others：调用失败

◆ startAudioDump()

virtual QResult RtcEngine::startAudioDump	(	const char *	filePath,
		int64_t	maxFileSize = `-1`
	)

pure virtual

开启音频转储。

参数

filePath	转储文件路径，包含文件名和后缀。例如：/path/panoaudio.dump
maxFileSize	最大转储文件大小. 如果值为-1，则文件大小不受限制。

返回

OK: 成功
其他: 失败

◆ startScreen() [1/3]

virtual QResult RtcEngine::startScreen ( )

pure virtual

开启屏幕共享。

返回

OK: 成功
其他: 失败

注解: 开启屏幕共享前请先加入一个频道，否则将返回失败。

◆ startScreen() [2/3]

virtual QResult RtcEngine::startScreen ( RtcRenderSink * sink )

pure virtual

开启共享，并且设置数据接收槽

参数

sink 共享数据接收槽

返回

OK: 调用成功
others：调用失败

◆ startScreen() [3/3]

virtual QResult RtcEngine::startScreen	(	RtcRenderSink *	sink,
		const ScreenConfig &	config
	)

pure virtual

开启共享，并且设置数据接收槽

参数

sink	共享数据接收槽
config	参数配置

返回

OK: 调用成功
others：调用失败

◆ startSoundCardMonitor()

virtual QResult RtcEngine::startSoundCardMonitor ( RtcRenderSink * sink )

pure virtual

开始声卡数据监控器

参数

sink 声卡数据接收槽

返回: 返回QResult来指示调用状态

注解: 用户需要先调用 startAudio 开启音频，才能使用声卡数据监控器

◆ startSoundCardShare()

virtual QResult RtcEngine::startSoundCardShare ( )

pure virtual

开始声卡音频共享

返回: 返回QResult来指示调用状态

注解: 用户需要先调用 startAudio 开启音频，才能使用声卡共享功能

◆ startVideo() [1/3]

virtual QResult RtcEngine::startVideo	(	RtcRenderSink *	sink,
		const VideoSourceConfig &	config
	)

pure virtual

开启视频，并且设置数据接收槽

参数

视频数据接收槽
config	视频源配置

返回

OK: 调用成功
others：调用失败

◆ startVideo() [2/3]

virtual QResult RtcEngine::startVideo	(	RtcRenderSink *	sink,
		VideoProfileType	profileType
	)

pure virtual

开启视频，并且设置数据接收槽

参数

视频数据接收槽
profileType	视频能力

返回

OK: 调用成功
others：调用失败

◆ startVideo() [3/3]

virtual QResult RtcEngine::startVideo	(	void *	window,
		const VideoConfig &	config
	)

pure virtual

开启视频，并且设置渲染窗口

参数

window	平台相关的窗口句柄，在windows平台，该参数必须是HWND
config	视频配置参数

返回

OK: 调用成功
others：调用失败

注解: 在 macOS iOS and Android 平台下必须从主线程调用。

◆ stopAudio()

virtual QResult RtcEngine::stopAudio ( )

pure virtual

关闭音频

返回

OK: 调用成功
others：调用失败

◆ stopAudioDump()

virtual QResult RtcEngine::stopAudioDump ( )

pure virtual

停止音频转储。

返回

OK: 成功
其他: 失败

◆ stopScreen()

virtual QResult RtcEngine::stopScreen ( )

pure virtual

停止屏幕共享。

返回

OK: 成功
其他: 失败

◆ stopSoundCardMonitor()

virtual QResult RtcEngine::stopSoundCardMonitor ( )

pure virtual

停止声卡数据监控器

返回: 返回QResult来指示调用状态

◆ stopSoundCardShare()

virtual QResult RtcEngine::stopSoundCardShare ( )

pure virtual

停止声卡音频共享

返回: 返回QResult来指示调用状态

◆ stopVideo()

virtual QResult RtcEngine::stopVideo ( )

pure virtual

关闭视频

返回

OK: 调用成功
others：调用失败

注解: 此接口为同步调用

◆ subscribeAudio()

virtual QResult RtcEngine::subscribeAudio ( uint64_t userId )

pure virtual

订阅用户的音频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

注解: 订阅用户的音频前，请确保用户已开启音频。

◆ subscribeScreen() [1/2]

virtual QResult RtcEngine::subscribeScreen	(	uint64_t	userId,
		RtcRenderSink *	sink
	)

pure virtual

订阅用户的屏幕共享并且设置数据接收槽

参数

userId	客户定义的用户标识。
sink	屏幕共享数据接收槽。

返回

kPanoResultOK: 成功
其他: 失败

注解: 订阅用户的屏幕共享前，请确保用户已开启屏幕共享。

◆ subscribeScreen() [2/2]

virtual QResult RtcEngine::subscribeScreen	(	uint64_t	userId,
		void *	window
	)

pure virtual

订阅用户的屏幕共享, 并且设置渲染窗口。

参数

userId	客户定义的用户标识。
windows	系统相关的渲染窗口，在windows平台必须为HWND对象。

返回

OK: 成功
其他: 失败

注解: 订阅用户的屏幕共享前，请确保用户已开启屏幕共享。在 macOS iOS and Android 平台下必须从主线程调用。

◆ subscribeVideo() [1/2]

virtual QResult RtcEngine::subscribeVideo	(	uint64_t	userId,
		RtcRenderSink *	sink,
		VideoProfileType	profileType
	)

pure virtual

订阅用户的视频，并设置视频数据接收槽。

参数

userId	客户定义的用户标识。
sink。	视频数据接收槽。
profileType	视频能力。

返回

OK: 成功
其他: 失败

注解: 订阅用户的视频前，请确保用户已开启视频。

◆ subscribeVideo() [2/2]

virtual QResult RtcEngine::subscribeVideo	(	uint64_t	userId,
		void *	window,
		const VideoConfig &	config
	)

pure virtual

订阅用户的视频，并设置渲染窗口。

参数

userId	客户定义的用户标识。
window	平台相关的窗口对象，在windows平台，该参数必须是HWND对象。
config	视频参数。

返回

OK: 成功
其他: 失败

注解: 订阅用户的视频前，请确保用户已开启视频。在 macOS iOS and Android 平台下必须从主线程调用。

◆ switchWhiteboardEngine()

virtual QResult RtcEngine::switchWhiteboardEngine ( const char * whiteboardId )

pure virtual

切换白板引擎

参数

whiteboardId 白板Id

返回

OK: 成功
其他: 失败

注解

此接口用于多白板用例场景。
RtcEngine会自动创建白板Id为"default"的白板
RtcEngine会保留前缀为"pano-"的白板Id，请不要使用
当传入的whiteboardId之前没被设置过，RtcEngine会生成新的白板
调用该接口后，调用getWhiteboardEngine来获取当前的白板引擎指针

◆ unmuteAudio()

virtual QResult RtcEngine::unmuteAudio ( )

pure virtual

取消静音。

返回

OK: 成功
其他: 失败

注解: 取消静音前请先开启音频，否则操作将无效。

◆ unmuteScreen()

virtual QResult RtcEngine::unmuteScreen ( )

pure virtual

恢复屏幕共享。

返回

OK: 成功
其他: 失败

注解: 恢复屏幕共享前请先开启屏幕共享，否则操作将无效。

◆ unmuteVideo()

virtual QResult RtcEngine::unmuteVideo ( )

pure virtual

恢复视频。

返回

OK: 成功
其他: 失败

注解: 恢复视频前请先开启视频，否则操作将无效。

◆ unsubscribeAudio()

virtual QResult RtcEngine::unsubscribeAudio ( uint64_t userId )

pure virtual

取消订阅用户的音频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

注解: 当用户停止音频或者离开频道的时候，用户的音频将会被自动取消订阅。

◆ unsubscribeScreen()

virtual QResult RtcEngine::unsubscribeScreen ( uint64_t userId )

pure virtual

取消订阅用户的屏幕共享。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

注解: 当用户停止屏幕共享或者离开频道的时候，用户的屏幕共享将会被自动取消订阅。此接口为同步调用。

◆ unsubscribeVideo()

virtual QResult RtcEngine::unsubscribeVideo ( uint64_t userId )

pure virtual

取消订阅用户的视频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

注解: 当用户停止视频或者离开频道的时候，用户的视频将会被自动取消订阅。此接口为同步调用。

◆ updateScreenConfig()

virtual QResult RtcEngine::updateScreenConfig ( const ScreenConfig & config )

pure virtual

更新屏幕共享采集配置。

参数

config 参数配置。

返回

OK: 成功
其他: 失败

◆ updateScreenMovingDistance()

virtual QResult RtcEngine::updateScreenMovingDistance	(	uint64_t	userId,
		int	dx,
		int	dy
	)

pure virtual

更新屏幕的相对移动距离。

参数

userId	客户定义的用户标识。
dx	焦点在x轴上移动的距离 @parma dy 焦点在y轴上移动的距离

返回

OK: 成功
其他: 失败

注解

◆ updateScreenScalingRatio()

virtual QResult RtcEngine::updateScreenScalingRatio	(	uint64_t	userId,
		ScreenScalingRatio	ratio
	)

pure virtual

更新屏幕的绝对缩放比例。

参数

userId	客户定义的用户标识。
ratio	屏幕缩放比例类型。

返回

OK: 成功
其他: 失败

注解: 默认焦点是视图的中心点。

◆ updateScreenScalingRatioWithFocus()

virtual QResult RtcEngine::updateScreenScalingRatioWithFocus	(	uint64_t	userId,
		float	ratio,
		int	x,
		int	y
	)

pure virtual

更新屏幕的相对缩放比例。

参数

userId	客户定义的用户标识。
ratio	屏幕缩放比例值。
focus	屏幕焦点坐标值。

返回

OK: 成功
其他: 失败

注解

该类的文档由以下文件生成:

PanoRtcEngine.h

类

Public 成员函数

详细描述

成员函数说明

◆ callout()

◆ destroy()

◆ dropCall()

◆ getAnnotationManager()

◆ getAudioDeviceManager()

◆ getAudioMixingManager()

◆ getGroupManager()

◆ getMessageService()

◆ getNetworkManager()

◆ getRemoteController()

◆ getScreenSourceManager()

◆ getVideoDeviceManager()

◆ getVideoRenderManager()

◆ getVideoStreamManager()

◆ getWhiteboardEngine()

◆ initialize()

◆ joinChannel()

◆ leaveChannel()

◆ muteAudio()

◆ muteScreen()

◆ muteVideo()

◆ queryDeviceRating()

◆ sendAudioControlMessage()

◆ sendFeedback()

◆ setAudioIndication()

◆ setMediaProcessor()

◆ setMediaStatsObserver()

◆ setOption()

◆ setParameters()

◆ setScreenCaptureObserver()

◆ snapshotVideo()

◆ startAudio()

◆ startAudioDump()

◆ startScreen() [1/3]

◆ startScreen() [2/3]

◆ startScreen() [3/3]

◆ startSoundCardMonitor()

◆ startSoundCardShare()

◆ startVideo() [1/3]

◆ startVideo() [2/3]

◆ startVideo() [3/3]

◆ stopAudio()

◆ stopAudioDump()

◆ stopScreen()

◆ stopSoundCardMonitor()

◆ stopSoundCardShare()

◆ stopVideo()

◆ subscribeAudio()

◆ subscribeScreen() [1/2]

◆ subscribeScreen() [2/2]

◆ subscribeVideo() [1/2]

◆ subscribeVideo() [2/2]

◆ switchWhiteboardEngine()

◆ unmuteAudio()

◆ unmuteScreen()

◆ unmuteVideo()

◆ unsubscribeAudio()

◆ unsubscribeScreen()

◆ unsubscribeVideo()

◆ updateScreenConfig()

◆ updateScreenMovingDistance()

◆ updateScreenScalingRatio()

◆ updateScreenScalingRatioWithFocus()