RtcEngine 接口类提供了应用程序调用所需的所有方法。更多...

类
class	FeedbackInfo

Public 成员函数
abstract void	destroy ()
	销毁 RtcEngine 对象。更多...

abstract QResult	setLocalVideoRender (IVideoRender render)

abstract QResult	setRemoteVideoRender (long userId, IVideoRender render)

abstract QResult	setRemoteScreenRender (long userId, IVideoRender render)

abstract QResult	joinChannel (String token, String channelId, long userId, RtcChannelConfig config)
	加入频道。更多...

abstract QResult	leaveChannel ()
	离开频道。

abstract QResult	startAudio ()
	开启音频。更多...

abstract QResult	stopAudio ()
	停止音频。更多...

abstract QResult	startVideo (VideoProfileType profileType, boolean frontCamera)
	开启视频。更多...

abstract QResult	startScreen ()
	开始屏幕采集。更多...

abstract QResult	startScreen (RtcScreenConfig config)
	开始屏幕采集。更多...

abstract QResult	stopScreen ()
	停止屏幕采集。更多...

abstract QResult	updateScreenConfig (RtcScreenConfig config)
	屏幕采集过程中更新采集配置。更多...

abstract QResult	startVideo (boolean frontCamera, RtcVideoConfig config)
	开启视频。更多...

abstract QResult	stopVideo ()
	停止视频。更多...

abstract QResult	startPreview (VideoProfileType profileType, boolean frontCamera)
	开启摄像头预览。更多...

abstract QResult	switchCamera ()
	切换前后置摄像头。更多...

abstract QResult	stopPreview ()
	停止摄像头预览。更多...

abstract QResult	subscribeAudio (long userId)
	订阅用户的音频。更多...

abstract QResult	unsubscribeAudio (long userId)
	取消订阅用户的音频。更多...

abstract QResult	subscribeVideo (long userId, VideoProfileType profileType)
	订阅用户的视频。更多...

abstract QResult	unsubscribeVideo (long userId)
	取消订阅用户的视频。更多...

abstract QResult	muteAudio ()
	静音。更多...

abstract QResult	unmuteAudio ()
	取消静音。更多...

abstract QResult	muteVideo ()
	暂停视频。更多...

abstract QResult	unmuteVideo ()
	恢复视频。更多...

abstract QResult	subscribeScreen (long userId)
	订阅用户的屏幕共享。更多...

abstract QResult	unsubscribeScreen (long userId)
	取消订阅用户的屏幕共享。更多...

abstract QResult	setLoudspeakerStatus (boolean onoff)
	设置扬声器启用状态。更多...

abstract boolean	isLoudspeakerOn ()
	获取扬声器启用状态。更多...

abstract QResult	setMicrophoneMuteStatus (boolean enable)
	设置麦克风采集数据静音状态(不包括伴音等其他声音) 更多...

abstract QResult	setRecordDeviceVolume (int volume)
	设置音频采集音量更多...

abstract int	getRecordDeviceVolume ()
	获取音频采集音量更多...

abstract QResult	setPlayoutDeviceVolume (int volume)
	设置音频播放音量更多...

abstract int	getPlayoutDeviceVolume ()
	获取音频播放音量更多...

abstract int	getRecordingLevel ()
	获取音频采集强度值更多...

abstract int	getPlayoutLevel ()
	获取音频播放强度值更多...

abstract RtcWhiteboard	getWhiteboard ()
	获取白板控制接口。更多...

abstract RtcWhiteboard	getWhiteboardById (String whiteboardId)
	通过白板id获取对应白板实例。更多...

abstract QResult	switchWhiteboard (String whiteboardId)
	切换白板控制接口更多...

abstract PanoAnnotationManager	getAnnotationMgr ()
	获取标注管理器接口。更多...

abstract PanoAnnotation	getAnnotationById (String annotationId)
	通过标注id获取对应标注实例。更多...

abstract RtcAudioMixingMgr	getAudioMixingMgr ()
	获取混音管理器接口。更多...

abstract RtcNetworkManager	getNetworkManager ()
	获取网络管理器接口。更多...

abstract RtcExternalAudioRecorder	getExternalAudioRecorder ()
	获取外接音频录制设备接口。更多...

abstract RtcExternalAudioPlayer	getExternalAudioPlayer ()
	获取外接音频播放设备接口。更多...

abstract RtcAudioDeviceManager	getAudioDeviceManager ()
	获取音频设备管理器接口。更多...

abstract RtcVideoStreamManager	getVideoStreamManager ()
	获取视频流管理器接口。更多...

abstract RtcVideoDeviceManager	getVideoDeviceManager ()
	获取视频设备管理器接口。更多...

abstract RtcMessageService	getMessageService ()
	获取消息服务的接口对象更多...

abstract RtcRemoteController	getRemoteController ()
	获取远程控制管理器接口。更多...

abstract RtcGroupManager	getGroupManager ()
	获取分组管理器接口。更多...

abstract QResult	setMediaStatsObserver (RtcMediaStatsObserver observer)
	设置媒体统计信息接收接口。更多...

abstract QResult	setAudioIndication (RtcAudioIndication indication, int intervalMs)
	设置用户指示器更多...

abstract QResult	setFaceBeautify (boolean enabled)
	设置是否启用美颜功能。更多...

abstract QResult	setFaceBeautifyIntensity (float intensity)
	设置美颜强度。更多...

abstract QResult	setMediaProcessor (MediaProcessorType type, Object processor, Object param)
	设置媒体处理模块更多...

abstract QResult	setDeviceBoundMediaProcessor (String deviceId, MediaProcessorType type, Object processor, Object param)
	向指定的设备设置媒体处理模块。更多...

abstract QResult	setOption (PanoOptionType type, Object value)
	设置可选项更多...

abstract QResult	setDeviceBoundOption (String deviceId, PanoOptionType type, Object value)
	向指定的设备设置可选项更多...

abstract QResult	snapshotVideo (String outputDir, long userId, RtcSnapshotVideoOption option)
	捕获指定用户的视频画面更多...

abstract QResult	startAudioDump (long maxDumpSize)
	开启音频转储。更多...

abstract QResult	stopAudioDump ()
	停止音频转储。更多...

abstract QResult	setAudioEqualization (AudioEqualizationMode option)
	设置音频均衡器模式。更多...

abstract QResult	setAudioReverb (AudioReverbMode option)
	设置音频混响器模式。更多...

abstract QResult	setAudioEarMonitoring (boolean enabled)
	设置是否启用耳返功能。更多...

abstract QResult	setVideoFrameRate (VideoFrameRateType type)
	调整视频采集帧率。更多...

abstract QResult	enableUploadDebugLogs (boolean onoff)
	是否允许上传PANO调试log。更多...

abstract QResult	enableUploadAudioDump (boolean onoff)
	是否允许上传音频数据。更多...

abstract QResult	sendFeedback (FeedbackInfo info)
	发送用户反馈到 PANO。更多...

abstract QResult	sendAudioControlMessage (byte[] data)
	发送音频控制消息. 备注：这个消息的数据最大长度为1024个字节，且最多每秒发送5次消息. 更多...

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

abstract QResult	setParameters (String params)
	设置自定义参数给PANO SDK。更多...

abstract QResult	callout (String phoneNo, boolean bindToUser)
	拨打电话号码。更多...

abstract QResult	dropCall (String phoneNo)
	挂断拨出或拨入的电话。更多...

abstract String	getSdkVersion ()
	返回 PANO SDK 的版本信息更多...

abstract long	getNativeHandle ()
	返回原生 RtcEngine 句柄更多...

静态 Public 成员函数
static RtcEngine	create (RtcEngineConfig config) throws Exception
	创建一个 RtcEngine 对象。更多...

static List< String >	checkPermission (Context context)

详细描述

RtcEngine 接口类提供了应用程序调用所需的所有方法。

RtcEngine 是SDK的基本接口类。创建一个 RtcEngine 对象，然后调用该对象的方法就可以使用SDK的通信功能。

成员函数说明

◆ callout()

abstract QResult com.pano.rtc.api.RtcEngine.callout	(	String	phoneNo,
		boolean	bindToUser
	)

abstract

拨打电话号码。

参数

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

返回

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

◆ checkPermission()

static List< String > com.pano.rtc.api.RtcEngine.checkPermission ( Context context )

inlinestatic

check privileges

参数

context Context

返回: the missing privileges

◆ create()

static RtcEngine com.pano.rtc.api.RtcEngine.create ( RtcEngineConfig config ) throws Exception

inlinestatic

创建一个 RtcEngine 对象。

参数

config RtcEngineConfig 对象.

返回: RtcEngine 对象

注解: 如果对象创建失败，将返回空对象。

◆ destroy()

abstract void com.pano.rtc.api.RtcEngine.destroy ( )

abstract

销毁 RtcEngine 对象。

注解: RtcEngine对象销毁后将不再有效。

◆ dropCall()

abstract QResult com.pano.rtc.api.RtcEngine.dropCall ( String phoneNo )

abstract

挂断拨出或拨入的电话。

参数

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

返回

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

◆ enableUploadAudioDump()

abstract QResult com.pano.rtc.api.RtcEngine.enableUploadAudioDump ( boolean onoff )

abstract

是否允许上传音频数据。

参数

onoff 是否允许.

返回

OK: 成功
其他: 失败

◆ enableUploadDebugLogs()

abstract QResult com.pano.rtc.api.RtcEngine.enableUploadDebugLogs ( boolean onoff )

abstract

是否允许上传PANO调试log。

参数

onoff 是否允许.

返回

OK: 成功
其他: 失败

◆ getAnnotationById()

abstract PanoAnnotation com.pano.rtc.api.RtcEngine.getAnnotationById ( String annotationId )

abstract

通过标注id获取对应标注实例。

参数

annotationId 标注ID

返回: PanoAnnotation 对象。

◆ getAnnotationMgr()

abstract PanoAnnotationManager com.pano.rtc.api.RtcEngine.getAnnotationMgr ( )

abstract

获取标注管理器接口。

返回: PanoAnnotationManager 对象。

◆ getAudioDeviceManager()

abstract RtcAudioDeviceManager com.pano.rtc.api.RtcEngine.getAudioDeviceManager ( )

abstract

获取音频设备管理器接口。

返回: RtcAudioDeviceManager 对象。

◆ getAudioMixingMgr()

abstract RtcAudioMixingMgr com.pano.rtc.api.RtcEngine.getAudioMixingMgr ( )

abstract

获取混音管理器接口。

返回: RtcAudioMixingMgr 对象。

◆ getExternalAudioPlayer()

abstract RtcExternalAudioPlayer com.pano.rtc.api.RtcEngine.getExternalAudioPlayer ( )

abstract

获取外接音频播放设备接口。

返回: RtcExternalAudioPlayer 对象。

◆ getExternalAudioRecorder()

abstract RtcExternalAudioRecorder com.pano.rtc.api.RtcEngine.getExternalAudioRecorder ( )

abstract

获取外接音频录制设备接口。

返回: RtcExternalAudioRecorder 对象。

◆ getGroupManager()

abstract RtcGroupManager com.pano.rtc.api.RtcEngine.getGroupManager ( )

abstract

获取分组管理器接口。

返回: RtcGroupManager 对象。

◆ getMessageService()

abstract RtcMessageService com.pano.rtc.api.RtcEngine.getMessageService ( )

abstract

获取消息服务的接口对象

返回

非空：消息服务接口对象。
空: 失败

◆ getNativeHandle()

abstract long com.pano.rtc.api.RtcEngine.getNativeHandle ( )

abstract

返回原生 RtcEngine 句柄

返回

原生 RtcEngine 句柄

非0: 原生句柄
0: 失败

◆ getNetworkManager()

abstract RtcNetworkManager com.pano.rtc.api.RtcEngine.getNetworkManager ( )

abstract

获取网络管理器接口。

返回: RtcNetworkManager 对象。

◆ getPlayoutDeviceVolume()

abstract int com.pano.rtc.api.RtcEngine.getPlayoutDeviceVolume ( )

abstract

获取音频播放音量

返回: 返回播放设置的音量，取值范围是0~255

◆ getPlayoutLevel()

abstract int com.pano.rtc.api.RtcEngine.getPlayoutLevel ( )

abstract

获取音频播放强度值

返回: 返回播放的强度值

◆ getRecordDeviceVolume()

abstract int com.pano.rtc.api.RtcEngine.getRecordDeviceVolume ( )

abstract

获取音频采集音量

返回: 返回采集设置的音量，取值范围是0~255

◆ getRecordingLevel()

abstract int com.pano.rtc.api.RtcEngine.getRecordingLevel ( )

abstract

获取音频采集强度值

返回: 返回采集的强度值

◆ getRemoteController()

abstract RtcRemoteController com.pano.rtc.api.RtcEngine.getRemoteController ( )

abstract

获取远程控制管理器接口。

返回: RtcRemoteController 对象。

◆ getSdkVersion()

abstract String com.pano.rtc.api.RtcEngine.getSdkVersion ( )

abstract

返回 PANO SDK 的版本信息

返回: PANO SDK 版本字符串，比如 1.0.1

◆ getVideoDeviceManager()

abstract RtcVideoDeviceManager com.pano.rtc.api.RtcEngine.getVideoDeviceManager ( )

abstract

获取视频设备管理器接口。

返回: RtcVideoDeviceManager 对象。

◆ getVideoStreamManager()

abstract RtcVideoStreamManager com.pano.rtc.api.RtcEngine.getVideoStreamManager ( )

abstract

获取视频流管理器接口。

返回: RtcVideoStreamManager 对象。

注解: 如果应用各端都不会同时发送多路视频流，则无需使用视频流管理器。

◆ getWhiteboard()

abstract RtcWhiteboard com.pano.rtc.api.RtcEngine.getWhiteboard ( )

abstract

获取白板控制接口。

返回: RtcWhiteboard 对象。

◆ getWhiteboardById()

abstract RtcWhiteboard com.pano.rtc.api.RtcEngine.getWhiteboardById ( String whiteboardId )

abstract

通过白板id获取对应白板实例。

返回: RtcWhiteboard 对象。

◆ isLoudspeakerOn()

abstract boolean com.pano.rtc.api.RtcEngine.isLoudspeakerOn ( )

abstract

获取扬声器启用状态。

返回: 是否启用。

◆ joinChannel()

abstract QResult com.pano.rtc.api.RtcEngine.joinChannel	(	String	token,
		String	channelId,
		long	userId,
		RtcChannelConfig	config
	)

abstract

加入频道。

参数

token	应用服务器从PANO获得的安全令牌。
channelId	客户定义的频道标识，字符串类型，最大长度为128个字节。
userId	客户定义的用户标识。在 [0xFFFEFF0000000000, 0xFFFEFFFFFFFFFFFF] 之间的 ID 保留给 SDK 使用
config	频道配置信息，可配置频道模式、用户名等参数。

返回

OK: 成功
其他值: 失败

注解: 同一时刻只能加入一个频道。

◆ muteAudio()

abstract QResult com.pano.rtc.api.RtcEngine.muteAudio ( )

abstract

静音。

返回

OK: 成功
其他: 失败

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

◆ muteVideo()

abstract QResult com.pano.rtc.api.RtcEngine.muteVideo ( )

abstract

暂停视频。

返回

OK: 成功
其他: 失败

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

◆ queryDeviceRating()

abstract DeviceRating com.pano.rtc.api.RtcEngine.queryDeviceRating ( )

abstract

查询当前设备的评分值。

返回: 设备评分

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

◆ sendAudioControlMessage()

abstract QResult com.pano.rtc.api.RtcEngine.sendAudioControlMessage ( byte[] data )

abstract

发送音频控制消息. 备注：这个消息的数据最大长度为1024个字节，且最多每秒发送5次消息.

参数

data 音频控制消息数据.

返回

OK: 成功
其他: 失败

◆ sendFeedback()

abstract QResult com.pano.rtc.api.RtcEngine.sendFeedback ( FeedbackInfo info )

abstract

发送用户反馈到 PANO。

参数

info 反馈信息

返回

OK: 成功
其他: 失败

◆ setAudioEarMonitoring()

abstract QResult com.pano.rtc.api.RtcEngine.setAudioEarMonitoring ( boolean enabled )

abstract

设置是否启用耳返功能。

参数

enabled 是否启用。

返回

OK: 成功
其他: 失败

◆ setAudioEqualization()

abstract QResult com.pano.rtc.api.RtcEngine.setAudioEqualization ( AudioEqualizationMode option )

abstract

设置音频均衡器模式。

参数

option 音频均衡器选项： 0：无音效； 1：低音； 2：高音； 3：声乐； 4：强劲； 5：流行； 6：现场； 7：舞曲； 8：俱乐部； 9：轻柔； 10：摇滚； 11：聚会； 12：古典； 13：测试用例

返回

OK: 成功
其他: 失败

◆ setAudioIndication()

abstract QResult com.pano.rtc.api.RtcEngine.setAudioIndication	(	RtcAudioIndication	indication,
		int	intervalMs
	)

abstract

设置用户指示器

参数

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

返回

OK: 成功
其他: 失败

◆ setAudioReverb()

abstract QResult com.pano.rtc.api.RtcEngine.setAudioReverb ( AudioReverbMode option )

abstract

设置音频混响器模式。

参数

option 音频混响选项： 0：无音效； 1：人声 I； 2：人声 II； 3：声乐； 4：明亮小房间； 5：黑暗小房间； 6：中等房间； 7：大房间； 8：教堂大厅；9 大教堂；

返回

OK: 成功
其他: 失败

◆ setDeviceBoundMediaProcessor()

abstract QResult com.pano.rtc.api.RtcEngine.setDeviceBoundMediaProcessor	(	String	deviceId,
		MediaProcessorType	type,
		Object	processor,
		Object	param
	)

abstract

向指定的设备设置媒体处理模块。

参数

deviceId	设备ID。
type	处理类型。目前支持的类型： VideoTexturePreprocessor 。
processor	外接处理模块。值为空表示停止对应的媒体处理。
param	处理模块所需参数，跟处理模块类型相关。

返回

OK: 成功
其他: 失败

◆ setDeviceBoundOption()

abstract QResult com.pano.rtc.api.RtcEngine.setDeviceBoundOption	(	String	deviceId,
		PanoOptionType	type,
		Object	value
	)

abstract

向指定的设备设置可选项

参数

deviceId	设备ID。
type	可选项类型PanoOptionType。目前支持的类型： FaceBeautify ， PanoOptionBuiltinTransform ， VideoQuadTransform ， VideoBrightnessAdjuster 。
value	参数的定义需遵循不同的object所定义的参数

返回

OK: 成功
其他: 失败

◆ setFaceBeautify()

abstract QResult com.pano.rtc.api.RtcEngine.setFaceBeautify ( boolean enabled )

abstract

设置是否启用美颜功能。

参数

enabled 是否启用。

返回

OK: 成功
其他: 失败

◆ setFaceBeautifyIntensity()

abstract QResult com.pano.rtc.api.RtcEngine.setFaceBeautifyIntensity ( float intensity )

abstract

设置美颜强度。

参数

intensity 强度值。

返回

OK: 成功
其他: 失败

◆ setLocalVideoRender()

abstract QResult com.pano.rtc.api.RtcEngine.setLocalVideoRender ( IVideoRender render )

abstract

设置本地用户的视频画布。一个画布同时只能被用于一个用户，如果要把一个画布用于另一个用户，则需先将画布的当前用户的画布设为空。

参数

render 视频画布，null值将会取消本地用户画布

返回

OK: 成功
其它值: 失败

◆ setLoudspeakerStatus()

abstract QResult com.pano.rtc.api.RtcEngine.setLoudspeakerStatus ( boolean onoff )

abstract

设置扬声器启用状态。

参数

onoff 是否启用。

返回

OK: 成功
其他: 失败

◆ setMediaProcessor()

abstract QResult com.pano.rtc.api.RtcEngine.setMediaProcessor	(	MediaProcessorType	type,
		Object	processor,
		Object	param
	)

abstract

设置媒体处理模块

参数

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

返回

OK: 成功
其他: 失败

◆ setMediaStatsObserver()

abstract QResult com.pano.rtc.api.RtcEngine.setMediaStatsObserver ( RtcMediaStatsObserver observer )

abstract

设置媒体统计信息接收接口。

参数

observer 接口对象。

返回

OK: 成功
其他: 失败

◆ setMicrophoneMuteStatus()

abstract QResult com.pano.rtc.api.RtcEngine.setMicrophoneMuteStatus ( boolean enable )

abstract

设置麦克风采集数据静音状态(不包括伴音等其他声音)

参数

enable 静音开关，打开/关闭静音开关

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

◆ setOption()

abstract QResult com.pano.rtc.api.RtcEngine.setOption	(	PanoOptionType	type,
		Object	value
	)

abstract

设置可选项

参数

type	可选项类型PanoOptionType
value	参数的定义需遵循不同的object所定义的参数

返回

OK: 成功
其他: 失败

◆ setParameters()

abstract QResult com.pano.rtc.api.RtcEngine.setParameters ( String params )

abstract

设置自定义参数给PANO SDK。

参数

params JSON格式参数。

返回

OK: 成功
- 其它值: 失败

◆ setPlayoutDeviceVolume()

abstract QResult com.pano.rtc.api.RtcEngine.setPlayoutDeviceVolume ( int volume )

abstract

设置音频播放音量

参数

volume 音量，合法的取值范围是0～255

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

◆ setRecordDeviceVolume()

abstract QResult com.pano.rtc.api.RtcEngine.setRecordDeviceVolume ( int volume )

abstract

设置音频采集音量

参数

volume 音量，合法的取值范围是0～255

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

◆ setRemoteScreenRender()

abstract QResult com.pano.rtc.api.RtcEngine.setRemoteScreenRender	(	long	userId,
		IVideoRender	render
	)

abstract

设置远端用户的桌面共享画布。一个画布同时只能被用于一个用户，如果要把一个画布用于另一个用户，则需先将画布的当前用户的画布设为空。

参数

userId	远端用户的用户ID
render	桌面共享画布，null值将会取消此用户的桌面共享画布

返回

OK: 成功
其它值: 失败

◆ setRemoteVideoRender()

abstract QResult com.pano.rtc.api.RtcEngine.setRemoteVideoRender	(	long	userId,
		IVideoRender	render
	)

abstract

设置远端用户的视频画布。一个画布同时只能被用于一个用户，如果要把一个画布用于另一个用户，则需先将画布的当前用户的画布设为空。

参数

userId	远端用户的用户ID
render	视频画布，null值将会取消此用户的视频画布

返回

OK: 成功
其它值: 失败

◆ setVideoFrameRate()

abstract QResult com.pano.rtc.api.RtcEngine.setVideoFrameRate ( VideoFrameRateType type )

abstract

调整视频采集帧率。

参数

type 视频帧率类型.

返回

OK: 成功
其他: 失败

◆ snapshotVideo()

abstract QResult com.pano.rtc.api.RtcEngine.snapshotVideo	(	String	outputDir,
		long	userId,
		RtcSnapshotVideoOption	option
	)

abstract

捕获指定用户的视频画面

参数

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

返回

OK: 成功
其他: 失败

◆ startAudio()

abstract QResult com.pano.rtc.api.RtcEngine.startAudio ( )

abstract

开启音频。

返回

OK: 成功
其他: 失败

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

◆ startAudioDump()

abstract QResult com.pano.rtc.api.RtcEngine.startAudioDump ( long maxDumpSize )

abstract

开启音频转储。

参数

maxDumpSize 转储文件大小，单位字节。-1表示不限大小

返回

OK: 成功
其他: 失败

◆ startPreview()

abstract QResult com.pano.rtc.api.RtcEngine.startPreview	(	VideoProfileType	profileType,
		boolean	frontCamera
	)

abstract

开启摄像头预览。

参数

profileType	视频分辨率。
frontCamera	使用前置或后置摄像头。

返回

OK: 成功
其他: 失败

注解: 本接可在未加入通道前调用。

◆ startScreen() [1/2]

abstract QResult com.pano.rtc.api.RtcEngine.startScreen ( )

abstract

开始屏幕采集。

返回

OK: 成功。
其他: 失败。

◆ startScreen() [2/2]

abstract QResult com.pano.rtc.api.RtcEngine.startScreen ( RtcScreenConfig config )

abstract

开始屏幕采集。

参数

config 参数配置。

返回

OK: 成功。
其他: 失败。

◆ startVideo() [1/2]

abstract QResult com.pano.rtc.api.RtcEngine.startVideo	(	boolean	frontCamera,
		RtcVideoConfig	config
	)

abstract

开启视频。

参数

frontCamera	使用前置或后置摄像头。
config	视频配置

返回

OK: 成功
其他: 失败

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

◆ startVideo() [2/2]

abstract QResult com.pano.rtc.api.RtcEngine.startVideo	(	VideoProfileType	profileType,
		boolean	frontCamera
	)

abstract

开启视频。

参数

profileType	视频分辨率。
frontCamera	使用前置或后置摄像头。

返回

OK: 成功
其他: 失败

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

◆ stopAudio()

abstract QResult com.pano.rtc.api.RtcEngine.stopAudio ( )

abstract

停止音频。

返回

OK: 成功
其他: 失败

◆ stopAudioDump()

abstract QResult com.pano.rtc.api.RtcEngine.stopAudioDump ( )

abstract

停止音频转储。

返回

OK: 成功
其他: 失败

◆ stopPreview()

abstract QResult com.pano.rtc.api.RtcEngine.stopPreview ( )

abstract

停止摄像头预览。

返回

OK: 成功
其他: 失败

◆ stopScreen()

abstract QResult com.pano.rtc.api.RtcEngine.stopScreen ( )

abstract

停止屏幕采集。

返回

OK: 成功。
其他: 失败。

◆ stopVideo()

abstract QResult com.pano.rtc.api.RtcEngine.stopVideo ( )

abstract

停止视频。

返回

OK: 成功
其他: 失败

◆ subscribeAudio()

abstract QResult com.pano.rtc.api.RtcEngine.subscribeAudio ( long userId )

abstract

订阅用户的音频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

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

◆ subscribeScreen()

abstract QResult com.pano.rtc.api.RtcEngine.subscribeScreen ( long userId )

abstract

订阅用户的屏幕共享。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

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

◆ subscribeVideo()

abstract QResult com.pano.rtc.api.RtcEngine.subscribeVideo	(	long	userId,
		VideoProfileType	profileType
	)

abstract

订阅用户的视频。

参数

userId	客户定义的用户标识。
profileType	视频分辨率。

返回

OK: 成功
其他: 失败

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

◆ switchCamera()

abstract QResult com.pano.rtc.api.RtcEngine.switchCamera ( )

abstract

切换前后置摄像头。

返回

OK: 成功
其他: 失败

◆ switchWhiteboard()

abstract QResult com.pano.rtc.api.RtcEngine.switchWhiteboard ( String whiteboardId )

abstract

切换白板控制接口

参数

whiteboardId 白板Id。最大长度128字节。

返回

OK: 成功
其他: 失败

注解

此接口用于多白板用例场景。
RtcEngine会自动创建白板Id为"default"的白板
RtcEngine会保留前缀为"pano-"的白板Id，请不要使用
当传入的whiteboardId之前没被设置过，RtcEngine会生成新的白板
切换后需要调用getWhiteboard()获得新的白板控制对象。

◆ unmuteAudio()

abstract QResult com.pano.rtc.api.RtcEngine.unmuteAudio ( )

abstract

取消静音。

返回

OK: 成功
其他: 失败

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

◆ unmuteVideo()

abstract QResult com.pano.rtc.api.RtcEngine.unmuteVideo ( )

abstract

恢复视频。

返回

OK: 成功
其他: 失败

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

◆ unsubscribeAudio()

abstract QResult com.pano.rtc.api.RtcEngine.unsubscribeAudio ( long userId )

abstract

取消订阅用户的音频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

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

◆ unsubscribeScreen()

abstract QResult com.pano.rtc.api.RtcEngine.unsubscribeScreen ( long userId )

abstract

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

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

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

◆ unsubscribeVideo()

abstract QResult com.pano.rtc.api.RtcEngine.unsubscribeVideo ( long userId )

abstract

取消订阅用户的视频。

参数

userId 客户定义的用户标识。

返回

OK: 成功
其他: 失败

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

◆ updateScreenConfig()

abstract QResult com.pano.rtc.api.RtcEngine.updateScreenConfig ( RtcScreenConfig config )

abstract

屏幕采集过程中更新采集配置。

参数

config 参数配置。

返回

OK: 成功。
其他: 失败。

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

RtcEngine.java

类

Public 成员函数

静态 Public 成员函数

详细描述

成员函数说明

◆ callout()

◆ checkPermission()

◆ create()

◆ destroy()

◆ dropCall()

◆ enableUploadAudioDump()

◆ enableUploadDebugLogs()

◆ getAnnotationById()

◆ getAnnotationMgr()

◆ getAudioDeviceManager()

◆ getAudioMixingMgr()

◆ getExternalAudioPlayer()

◆ getExternalAudioRecorder()

◆ getGroupManager()

◆ getMessageService()

◆ getNativeHandle()

◆ getNetworkManager()

◆ getPlayoutDeviceVolume()

◆ getPlayoutLevel()

◆ getRecordDeviceVolume()

◆ getRecordingLevel()

◆ getRemoteController()

◆ getSdkVersion()

◆ getVideoDeviceManager()

◆ getVideoStreamManager()

◆ getWhiteboard()

◆ getWhiteboardById()

◆ isLoudspeakerOn()

◆ joinChannel()

◆ muteAudio()

◆ muteVideo()

◆ queryDeviceRating()

◆ sendAudioControlMessage()

◆ sendFeedback()

◆ setAudioEarMonitoring()

◆ setAudioEqualization()

◆ setAudioIndication()

◆ setAudioReverb()

◆ setDeviceBoundMediaProcessor()

◆ setDeviceBoundOption()

◆ setFaceBeautify()

◆ setFaceBeautifyIntensity()

◆ setLocalVideoRender()

◆ setLoudspeakerStatus()

◆ setMediaProcessor()

◆ setMediaStatsObserver()

◆ setMicrophoneMuteStatus()

◆ setOption()

◆ setParameters()

◆ setPlayoutDeviceVolume()

◆ setRecordDeviceVolume()

◆ setRemoteScreenRender()

◆ setRemoteVideoRender()

◆ setVideoFrameRate()

◆ snapshotVideo()

◆ startAudio()

◆ startAudioDump()

◆ startPreview()

◆ startScreen() [1/2]

◆ startScreen() [2/2]

◆ startVideo() [1/2]

◆ startVideo() [2/2]

◆ stopAudio()

◆ stopAudioDump()

◆ stopPreview()

◆ stopScreen()

◆ stopVideo()

◆ subscribeAudio()

◆ subscribeScreen()

◆ subscribeVideo()

◆ switchCamera()

◆ switchWhiteboard()

◆ unmuteAudio()

◆ unmuteVideo()

◆ unsubscribeAudio()