iOS/macOS(Objective-C)[v1.7.5.0]
构造函数 | 类方法 | 属性 | 所有成员列表
PanoRtcEngineKit类 参考

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

#import <PanoRtcEngineKit.h>

类 PanoRtcEngineKit 继承关系图:

构造函数

(instancetype) - init
 此方法不可用。
 
(PanoResult) - updateConfig:
 更新 PanoRtcEngineKit 对象配置。 更多...
 
(void) - destroy
 销毁 PanoRtcEngineKit 对象。 更多...
 
(PanoResult) - joinChannelWithToken:channelId:userId:config:
 加入频道。 更多...
 
(void) - leaveChannel
 离开频道。
 
(PanoResult) - startAudio
 开启音频。 更多...
 
(PanoResult) - stopAudio
 停止音频。 更多...
 
(PanoResult) - startSoundCardShare
 开启声卡音频共享。（仅限macOS） 更多...
 
(PanoResult) - stopSoundCardShare
 停止声卡音频共享。（仅限macOS） 更多...
 
(PanoResult) - startSoundCardMonitor:
 开始声卡数据监控器。（仅限macOS） 更多...
 
(PanoResult) - stopSoundCardMonitor
 停止声卡数据监控器。（仅限macOS） 更多...
 
(PanoResult) - startVideoWithView:config:
 开启视频（随带渲染视图）。 更多...
 
(PanoResult) - startVideoWithDelegate:profile:
 开启视频（随带外置渲染器）。 更多...
 
(PanoResult) - startVideoWithDelegate:config:
 开启视频（随带外置渲染器）。 更多...
 
(PanoResult) - stopVideo
 停止视频。 更多...
 
(PanoResult) - startScreen
 开启屏幕共享。 更多...
 
(PanoResult) - startScreenWithAppGroupId:
 开启屏幕共享。（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad） 更多...
 
(PanoResult) - stopScreen
 停止屏幕共享。 更多...
 
(PanoResult) - subscribeAudio:
 订阅用户的音频。 更多...
 
(PanoResult) - unsubscribeAudio:
 取消订阅用户的音频。 更多...
 
(PanoResult) - subscribeVideo:withView:config:
 订阅用户的视频（随带渲染视图）。 更多...
 
(PanoResult) - subscribeVideo:withDelegate:profile:
 订阅用户的视频（随带外置渲染器）。 更多...
 
(PanoResult) - unsubscribeVideo:
 取消订阅用户的视频。 更多...
 
(PanoResult) - subscribeScreen:withView:
 订阅用户的屏幕共享（随带渲染视图）。 更多...
 
(PanoResult) - subscribeScreen:withDelegate:
 订阅用户的屏幕共享（随带外置渲染器）。 更多...
 
(PanoResult) - unsubscribeScreen:
 取消订阅用户的屏幕共享。 更多...
 
(PanoResult) - callout:bindToUser:
 拨打电话号码。 更多...
 
(PanoResult) - dropCall:
 挂断拨出或拨入的电话。 更多...
 
(PanoResult) - updateScreenScaling:withRatio:
 更新屏幕的绝对缩放比例。 更多...
 
(PanoResult) - updateScreenScaling:withRatio:focus:
 更新屏幕的相对缩放比例。 更多...
 
(PanoResult) - updateScreenMoving:withDistance:
 更新屏幕的相对移动距离。 更多...
 
(PanoResult) - muteAudio
 静音。 更多...
 
(PanoResult) - unmuteAudio
 取消静音。 更多...
 
(PanoResult) - muteVideo
 暂停视频。 更多...
 
(PanoResult) - unmuteVideo
 恢复视频。 更多...
 
(PanoResult) - muteScreen
 暂停屏幕共享。 更多...
 
(PanoResult) - unmuteScreen
 恢复屏幕共享。 更多...
 
(PanoResult) - setAudioIndication:intervalMs:
 设置用户指示器。 更多...
 
(PanoResult) - setMicrophoneMuteStatus:
 设置麦克风采集数据静音状态(不包括伴音等其他声音) 更多...
 
(PanoResult) - setAudioDeviceVolume:withType:
 设置当前音频设备的音量。 更多...
 
(UInt32) - getAudioDeviceVolume:
 获取当前音频设备的音量。 更多...
 
(SInt16) - getRecordingLevel
 获取音频采集强度值。 更多...
 
(SInt16) - getPlayoutLevel
 获取音频播放强度值。 更多...
 
(PanoRtcCameraController *) - getCameraController:
 获取相机控制器的接口指针 更多...
 
(PanoResult) - startAudioRecording
 开始音频设备录音(建议配合外部采集播放时的一些特殊需求使用) 更多...
 
(PanoResult) - stopAudioRecording
 关闭音频设备录音(建议配合外部采集播放时的一些特殊需求使用) 更多...
 
(PanoResult) - startAudioPlayback
 开始音频设备播放(建议配合外部采集播放时的一些特殊需求使用) 更多...
 
(PanoResult) - stopAudioPlayback
 关闭音频设备播放(建议配合外部采集播放时的一些特殊需求使用) 更多...
 
(PanoResult) - setPlayoutDataMuteStatus:
 设置播放数据静音状态 更多...
 
(PanoResult) - setLoudspeakerStatus:
 设置扬声器启用状态。（仅限iOS） 更多...
 
(BOOL) - isEnabledLoudspeaker
 获取扬声器启用状态。（仅限iOS） 更多...
 
(PanoResult) - switchCamera
 切换前后置摄像头。（仅限iOS） 更多...
 
(BOOL) - isFrontCamera
 获取当前摄像头类型。（仅限iOS） 更多...
 
(NSString *_Nullable) - getCameraDeviceId:
 获取摄像头设备标识。（仅限iOS） 更多...
 
(PanoResult) - startPreviewWithView:config:
 开启当前摄像头预览（随带渲染视图）。（仅限iOS） 更多...
 
(PanoResult) - startPreviewWithDelegate:profile:
 开启当前摄像头预览（随带外置渲染器）。（仅限iOS） 更多...
 
(PanoResult) - stopPreview
 停止当前摄像头预览。（仅限iOS） 更多...
 
(BOOL) - isMultiCameraCaptureSupported
 指示此设备是否支持多摄像头采集。（仅限iOS） 更多...
 
(NSArray< PanoRtcDeviceInfo * > *_Nullable) - enumerateDevices:
 枚举设备。（仅限macOS） 更多...
 
(PanoResult) - setDevice:withType:
 设置当前设备。（仅限macOS） 更多...
 
(PanoResult) - setDefaultDeviceWithType:
 设置系统默认设备为当前设备。（仅限macOS） 更多...
 
(BOOL) - isDefaultDeviceWithType:
 检查当前设备是否为系统默认设备。（仅限macOS） 更多...
 
(NSString *_Nullable) - getDevice:
 获取当前设备。（仅限macOS） 更多...
 
(PanoResult) - startPreview:withView:config:
 开启摄像头预览（随带渲染视图）。（仅限macOS） 更多...
 
(PanoResult) - startPreview:withDelegate:profile:
 开启摄像头预览（随带外置渲染器）。（仅限macOS） 更多...
 
(PanoResult) - stopPreview:
 停止摄像头预览。（仅限macOS） 更多...
 
(PanoResult) - startAudioDeviceTestWithRecord:playout:
 开始音频设备测试。（仅限macOS） 更多...
 
(PanoResult) - stopAudioDeviceTest
 停止音频设备测试。（仅限macOS） 更多...
 
(PanoResult) - startRecordDeviceTest:
 开始音频采集设备测试。（仅限macOS） 更多...
 
(PanoResult) - stopRecordDeviceTest
 停止音频采集设备测试。（仅限macOS） 更多...
 
(PanoResult) - startPlayoutDeviceTest:filename:
 开始音频播放设备测试。（仅限macOS） 更多...
 
(PanoResult) - stopPlayoutDeviceTest
 停止音频播放设备测试。（仅限macOS） 更多...
 
(SInt16) - getTestRecordingLevel
 获取录制设备测试时的音频采集强度值。（仅限macOS） 更多...
 
(SInt16) - getTestPlayoutLevel
 获取播放设备测试时的音频播放强度值。（仅限macOS） 更多...
 
(NSArray< PanoRtcScreenSourceInfo * > *_Nullable) - enumerateScreenSources:
 枚举屏幕源。（仅限macOS） 更多...
 
(PanoResult) - setScreenSource:withType:
 设置当前屏幕源。（仅限macOS） 更多...
 
(PanoResult) - enableSreenFilterSelfApp:
 设置是否过滤自己进程。（仅限macOS） 更多...
 
(PanoResult) - setScreenOptimization:
 设置屏幕优化启用状态。（仅限macOS） 更多...
 
(PanoResult) - beginScreenConfiguration:
 开始配置更改，接下来的配置改变在调用commitConfiguration之前不会立即生效。（仅限macOS） 更多...
 
(PanoResult) - commitScreenConfiguration
 提交一组配置更改。（仅限macOS） 更多...
 
(PanoResult) - selectSharedScreen:
 选择需要共享的屏幕，必须在 beginScreenConfiguration 之后调用。（仅限macOS） 更多...
 
(PanoResult) - addSharedScreenSource:withType:
 添加屏幕采集源，必须在 beginScreenConfiguration 之后调用。（仅限macOS） 更多...
 
(PanoResult) - removeSharedScreenSource:withType:
 移除屏幕采集源，必须在 beginScreenConfiguration 之后调用。（仅限macOS） 更多...
 
(PanoResult) - addUnsharedScreenSource:withType:
 添加不被共享的屏幕源，必须在 beginScreenConfiguration 之后调用。（仅限macOS） 更多...
 
(PanoResult) - removeUnsharedScreenSource:withType:
 移除不被共享的屏幕源，必须在 beginScreenConfiguration 之后调用。（仅限macOS） 更多...
 
(PanoRtcExternalAudioRecorder *_Nonnull) - externalAudioRecorder
 获取外接音频录制设备。 更多...
 
(PanoRtcExternalAudioPlayer *_Nonnull) - externalAudioPlayer
 获取外接音频播放设备。 更多...
 
(PanoResult) - createAudioMixingTask:filename:
 创建混音任务。 更多...
 
(PanoResult) - destroyAudioMixingTask:
 销毁混音任务。 更多...
 
(PanoResult) - startAudioMixingTask:withConfig:
 启动混音任务。 更多...
 
(PanoResult) - updateAudioMixingTask:withConfig:
 更新混音任务配置参数。 更多...
 
(PanoResult) - stopAudioMixingTask:
 结束混音任务。 更多...
 
(PanoResult) - resumeAudioMixing:
 恢复被暂停的混音任务。 更多...
 
(PanoResult) - pauseAudioMixing:
 暂停混音任务。 更多...
 
(SInt64) - getAudioMixingDuration:
 获取音频文件的总时长。 更多...
 
(SInt64) - getAudioMixingCurrentTimestamp:
 获取当前时间戳。 更多...
 
(PanoResult) - seekAudioMixing:timestamp:
 跳转至指定时间戳。 更多...
 
(PanoResult) - snapshotVideo:userId:option:
 Capture specific user's video content 更多...
 
(PanoRtcWhiteboard *_Nonnull) - whiteboardEngine
 获取白板控制对象。 更多...
 
(PanoResult) - switchWhiteboardEngine:
 切换白板控制对象 更多...
 
(void *_Nullable) - getNativeHandle
 返回原生 PANO RtcEngine 句柄。 更多...
 
(PanoResult) - startAudioDumpWithFilePath:maxFileSize:
 开启音频转储。 更多...
 
(PanoResult) - stopAudioDump
 停止音频转储。 更多...
 
(PanoResult) - sendFeedback:
 发送用户反馈到 PANO。 更多...
 
(PanoDeviceRating) - queryDeviceRating
 查询当前设备的评分值。 更多...
 
(PanoResult) - startNetworkTestWithToken:delegate:
 启动网络测试。 更多...
 
(PanoResult) - stopNetworkTest
 停止网络测试。 更多...
 
(PanoResult) - setOption:forType:
 设置选项对象给PANO SDK。 更多...
 
(PanoResult) - setDeviceBoundOption:forType:forDevice:
 向指定的设备设置可选项。 更多...
 
(PanoResult) - setParameters:
 设置自定义参数给PANO SDK。 更多...
 
(PanoResult) - setMediaProcessor:processor:param:
 设置外部媒体处理模块。 更多...
 
(PanoResult) - setDeviceBoundMediaProcessor:processor:param:forDevice:
 向指定的设备设置媒体处理模块。 更多...
 
(PanoResult) - sendAudioControlMessage:
 发送音频控制消息。 更多...
 

类方法

(instancetype) + new
 此方法不可用。
 
(instancetype _Nonnull) + engineWithConfig:delegate:
 创建一个 PanoRtcEngineKit 对象。 更多...
 
(void) + setLogLevel:
 设置日志输出级别。 更多...
 
(NSString *_Nonnull) + getSdkVersion
 返回 PANO SDK 的版本信息 更多...
 

属性

PanoRtcVideoStreamManager * videoStreamManager
 获取视频流管理器对象。 更多...
 
PanoRtcAnnotationManager * annotationManager
 获取标注管理器对象。 更多...
 
PanoRtcMessage * messageService
 获取消息服务的接口指针 更多...
 
PanoRtcRemoteController * remoteController
 获取远程控制服务的接口指针 更多...
 
PanoRtcGroupManager * groupManager
 获取分组管理器的接口指针 更多...
 
PanoRtcVideoRenderManager * videoRenderManager
 获取视频渲染管理器 更多...
 
PanoRtcRecording * recordingService
 获取录制服务接口 更多...
 

详细描述

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

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

函数文档

◆ addSharedScreenSource:withType:

- (PanoResult) addSharedScreenSource: (PanoScreenSourceID)  id
withType: (PanoScreenSourceType)  type 

添加屏幕采集源，必须在 beginScreenConfiguration 之后调用。（仅限macOS）

参数
id屏幕源唯一标识.
typePanoScreenSourceType 枚举类型，不能为 kPanoScreen 类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ addUnsharedScreenSource:withType:

- (PanoResult) addUnsharedScreenSource: (PanoScreenSourceID)  id
withType: (PanoScreenSourceType)  type 

添加不被共享的屏幕源，必须在 beginScreenConfiguration 之后调用。（仅限macOS）

参数
id屏幕源唯一标识.
typePanoScreenSourceType 枚举类型，不能为显示器类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ beginScreenConfiguration:

- (PanoResult) beginScreenConfiguration: (BOOL)  resetConfig

开始配置更改，接下来的配置改变在调用commitConfiguration之前不会立即生效。（仅限macOS）

参数
resetConfig是否重置当前配置。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ callout:bindToUser:

- (PanoResult) callout: (NSString *_Nonnull)  phoneNo
bindToUser: (BOOL)  bindToUser 

拨打电话号码。

参数
phoneNo电话号码。
bindToUser是否绑定到用户。
返回
  • OK: 操作成功
  • 其他: 操作失败

◆ commitScreenConfiguration

- (PanoResult) commitScreenConfiguration

提交一组配置更改。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ createAudioMixingTask:filename:

- (PanoResult) createAudioMixingTask: (SInt64)  taskId
filename: (NSString *_Nonnull)  filename 

创建混音任务。

参数
taskId任务标识。
filename音频文件的完整路径。支持mp3，aac，wav。
返回
  • OK: 成功
  • 其他: 失败

◆ destroy

- (void) destroy

销毁 PanoRtcEngineKit 对象。

注解
PanoRtcEngineKit 对象在销毁后将不再有效。

◆ destroyAudioMixingTask:

- (PanoResult) destroyAudioMixingTask: (SInt64)  taskId

销毁混音任务。

参数
taskId任务标识。
返回
  • OK: 成功
  • 其他: 失败

◆ dropCall:

- (PanoResult) dropCall: (NSString *)  phoneNo

挂断拨出或拨入的电话。

参数
phoneNo电话号码。空值为挂断绑定到自己的电话。
返回
  • OK: 操作成功
  • 其他: 操作失败

◆ enableSreenFilterSelfApp:

- (PanoResult) enableSreenFilterSelfApp: (BOOL)  enable

设置是否过滤自己进程。（仅限macOS）

参数
enable是否过滤自己进程。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
默认启用过滤自己进程。

◆ engineWithConfig:delegate:

+ (instancetype _Nonnull) engineWithConfig: (PanoRtcEngineConfig *_Nonnull)  config
delegate: (id< PanoRtcEngineDelegate > _Nonnull)  delegate 

创建一个 PanoRtcEngineKit 对象。

参数
configPanoRtcEngineConfig 对象.
delegatePanoRtcEngineDelegate 协议对象.
返回
PanoRtcEngineKit 对象
注解
如果对象创建失败，将返回空对象。

◆ enumerateDevices:

- (NSArray< PanoRtcDeviceInfo * > *_Nullable) enumerateDevices: (PanoDeviceType)  type

枚举设备。（仅限macOS）

参数
typePanoDeviceType 枚举类型。
返回
PanoRtcDeviceInfo 数组。

◆ enumerateScreenSources:

- (NSArray< PanoRtcScreenSourceInfo * > *_Nullable) enumerateScreenSources: (PanoScreenSourceType)  type

枚举屏幕源。（仅限macOS）

参数
typePanoScreenSourceType 枚举类型。
返回
PanoRtcScreenSourceInfo 数组。

◆ externalAudioPlayer

- (PanoRtcExternalAudioPlayer *_Nonnull) externalAudioPlayer

获取外接音频播放设备。

返回
返回 PanoRtcExternalAudioPlayer 实例指针。

◆ externalAudioRecorder

- (PanoRtcExternalAudioRecorder *_Nonnull) externalAudioRecorder

获取外接音频录制设备。

返回
返回 PanoRtcExternalAudioRecorder 实例指针。

◆ getAudioDeviceVolume:

- (UInt32) getAudioDeviceVolume: (PanoDeviceType)  type

获取当前音频设备的音量。

参数
type设备类型，PanoDeviceType 枚举类型。
返回
当前音量。有效值范围: [0, 255]。

◆ getAudioMixingCurrentTimestamp:

- (SInt64) getAudioMixingCurrentTimestamp: (SInt64)  taskId

获取当前时间戳。

参数
taskId任务标识。
返回
毫秒级当前时间戳。如果失败或者混音任务已结束，返回值小于0。

◆ getAudioMixingDuration:

- (SInt64) getAudioMixingDuration: (SInt64)  taskId

获取音频文件的总时长。

参数
taskId任务标识。
返回
毫秒级总时长。如果失败，返回值小于0。
注解
总时长是根据文件平均码率估算出来的。对于某些非恒定码率的音频文件，可能与实际总时长相比存在一定偏差。

◆ getCameraController:

- (PanoRtcCameraController *) getCameraController: (NSString *_Nonnull)  deviceId

获取相机控制器的接口指针

返回
  • 非空指针： 指向相机控制器接口对象的指针。
  • 空指针: 失败

◆ getCameraDeviceId:

- (NSString *_Nullable) getCameraDeviceId: (BOOL)  frontCamera

获取摄像头设备标识。（仅限iOS）

参数
frontCamera摄像头设备类型，YES是前置摄像头，NO是后置摄像头。
返回
设备唯一标识。

◆ getDevice:

- (NSString *_Nullable) getDevice: (PanoDeviceType)  type

获取当前设备。（仅限macOS）

参数
type设备类型，PanoDeviceType 枚举类型。
返回
设备唯一标识。

◆ getNativeHandle

- (void *_Nullable) getNativeHandle

返回原生 PANO RtcEngine 句柄。

返回
原生 PANO RtcEngine 句柄。
  • 非nil: 原生句柄
  • nil: 失败

◆ getPlayoutLevel

- (SInt16) getPlayoutLevel

获取音频播放强度值。

返回
音频播放强度值。

◆ getRecordingLevel

- (SInt16) getRecordingLevel

获取音频采集强度值。

返回
音频采集强度值。

◆ getSdkVersion

+ (NSString *_Nonnull) getSdkVersion

返回 PANO SDK 的版本信息

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

◆ getTestPlayoutLevel

- (SInt16) getTestPlayoutLevel

获取播放设备测试时的音频播放强度值。（仅限macOS）

返回
音频播放强度值。

◆ getTestRecordingLevel

- (SInt16) getTestRecordingLevel

获取录制设备测试时的音频采集强度值。（仅限macOS）

返回
音频采集强度值。

◆ isDefaultDeviceWithType:

- (BOOL) isDefaultDeviceWithType: (PanoDeviceType)  type

检查当前设备是否为系统默认设备。（仅限macOS）

参数
type设备类型，PanoDeviceType 枚举类型。
返回
检查结果。
注解
仅支持 kPanoDeviceAudioRecord 和 kPanoDeviceAudioPlayout 设备类型。

◆ isEnabledLoudspeaker

- (BOOL) isEnabledLoudspeaker

获取扬声器启用状态。（仅限iOS）

返回
是否启用。

◆ isFrontCamera

- (BOOL) isFrontCamera

获取当前摄像头类型。（仅限iOS）

返回
是否是前置摄像头。

◆ isMultiCameraCaptureSupported

- (BOOL) isMultiCameraCaptureSupported

指示此设备是否支持多摄像头采集。（仅限iOS）

返回
一个布尔值，指示是否支持。
注解
iPhone XR，iPhone XS，iPhone XS Max，iPad Pro（第三代）或更高版本支持该功能。 iOS版本需要13或更高版本。

◆ joinChannelWithToken:channelId:userId:config:

- (PanoResult) joinChannelWithToken: (NSString *_Nonnull)  token
channelId: (NSString *_Nonnull)  channelId
userId: (UInt64)  userId
config: (PanoRtcChannelConfig *_Nullable)  config 

加入频道。

参数
token应用服务器从PANO获得的安全令牌。
channelId客户定义的频道标识。必须符合以下规则:
  • 最大长度是128字节；
  • 只能由以下字符构成： "0-9", "a-z", "A-Z", 空格 (不能出现在首部和尾部), "!", "#", "$", "%", "&", "(", ")", "+", ",", "-", ".", ":", ";", "<", "=", ">", "?", "@", "[", "]", "^", "_", "|", "~"。
userId客户定义的用户标识。必须是唯一的。 在 [0xFFFEFF0000000000, 0xFFFEFFFFFFFFFFFF] 之间的 ID 保留给 SDK 使用
config频道设置。（可选）
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
同一时刻只能加入一个频道。 用户需检查回调函数 onUserJoinIndication 获知加会结果。

◆ muteAudio

- (PanoResult) muteAudio

静音。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
静音前请先开启音频，否则操作将无效。

◆ muteScreen

- (PanoResult) muteScreen

暂停屏幕共享。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
暂停屏幕共享前请先开启屏幕共享，否则操作将无效。

◆ muteVideo

- (PanoResult) muteVideo

暂停视频。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
暂停视频前请先开启视频，否则操作将无效。

◆ pauseAudioMixing:

- (PanoResult) pauseAudioMixing: (SInt64)  taskId

暂停混音任务。

参数
taskId任务标识。
返回
  • OK: 成功
  • 其他: 失败

◆ queryDeviceRating

- (PanoDeviceRating) queryDeviceRating

查询当前设备的评分值。

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

◆ removeSharedScreenSource:withType:

- (PanoResult) removeSharedScreenSource: (PanoScreenSourceID)  id
withType: (PanoScreenSourceType)  type 

移除屏幕采集源，必须在 beginScreenConfiguration 之后调用。（仅限macOS）

参数
id屏幕源唯一标识.
typePanoScreenSourceType 枚举类型，不能为显示器类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ removeUnsharedScreenSource:withType:

- (PanoResult) removeUnsharedScreenSource: (PanoScreenSourceID)  id
withType: (PanoScreenSourceType)  type 

移除不被共享的屏幕源，必须在 beginScreenConfiguration 之后调用。（仅限macOS）

参数
id屏幕源唯一标识.
typePanoScreenSourceType 枚举类型，不能为显示器类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ resumeAudioMixing:

- (PanoResult) resumeAudioMixing: (SInt64)  taskId

恢复被暂停的混音任务。

参数
taskId任务标识。
返回
  • OK: 成功
  • 其他: 失败

◆ seekAudioMixing:timestamp:

- (PanoResult) seekAudioMixing: (SInt64)  taskId
timestamp: (SInt64)  timestampMs 

跳转至指定时间戳。

参数
taskId任务标识。
timestampMs时间戳。
返回
  • OK: 成功
  • 其他: 失败

◆ selectSharedScreen:

- (PanoResult) selectSharedScreen: (PanoScreenSourceID)  id

选择需要共享的屏幕，必须在 beginScreenConfiguration 之后调用。（仅限macOS）

参数
id屏幕源唯一标识.
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ sendAudioControlMessage:

- (PanoResult) sendAudioControlMessage: (NSData *)  data

发送音频控制消息。

参数
data音频控制消息数据。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
这个消息的数据最大长度为1024个字节，且最多每秒发送5次消息。

◆ sendFeedback:

- (PanoResult) sendFeedback: (PanoFeedbackInfo *_Nonnull)  info

发送用户反馈到 PANO。

参数
info反馈的信息。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setAudioDeviceVolume:withType:

- (PanoResult) setAudioDeviceVolume: (UInt32)  volume
withType: (PanoDeviceType)  type 

设置当前音频设备的音量。

参数
volume有效值范围: [0, 255]。
type设备类型，PanoDeviceType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setAudioIndication:intervalMs:

- (PanoResult) setAudioIndication: (BOOL)  enable
intervalMs: (UInt32)  intervalMs 

设置用户指示器。

参数
enable提示汇报器开启标志位(默认开启回调)。
intervalMs回调时间间隔，单位毫秒，不能低于10ms。
返回
  • OK: 成功
  • 其他: 失败

◆ setDefaultDeviceWithType:

- (PanoResult) setDefaultDeviceWithType: (PanoDeviceType)  type

设置系统默认设备为当前设备。（仅限macOS）

参数
type设备类型，PanoDeviceType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
仅支持 kPanoDeviceAudioRecord 和 kPanoDeviceAudioPlayout 设备类型。

◆ setDevice:withType:

- (PanoResult) setDevice: (NSString *_Nonnull)  deviceId
withType: (PanoDeviceType)  type 

设置当前设备。（仅限macOS）

参数
deviceId设备唯一标识。
type设备类型，PanoDeviceType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setDeviceBoundMediaProcessor:processor:param:forDevice:

- (PanoResult) setDeviceBoundMediaProcessor: (PanoMediaProcessorType)  type
processor: (NSObject *_Nullable)  processor
param: (void *_Nullable)  param
forDevice: (NSString *_Nonnull)  deviceId 

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

参数
type媒体处理类型。目前支持的类型： kVideoPreprocessor 。
processor媒体处理器。值为空表示停止对应的媒体处理。
param媒体处理需要的参数。
deviceId设备唯一标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
媒体处理器指针必须保持其有效性，直到对应处理被停止。

◆ setDeviceBoundOption:forType:forDevice:

- (PanoResult) setDeviceBoundOption: (NSObject *_Nullable)  option
forType: (PanoOptionType)  type
forDevice: (NSString *_Nonnull)  deviceId 

向指定的设备设置可选项。

参数
option选项对象。
typePanoOptionType 枚举类型。 目前支持的类型： kPanoOptionFaceBeautify ， kPanoOptionBuiltinTransform ， kPanoOptionQuadTransform 。
deviceId设备唯一标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setLogLevel:

+ (void) setLogLevel: (PanoLogLevel)  level

设置日志输出级别。

参数
levelPanoLogLevel 枚举类型.

◆ setLoudspeakerStatus:

- (PanoResult) setLoudspeakerStatus: (BOOL)  enable

设置扬声器启用状态。（仅限iOS）

参数
enable是否启用。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setMediaProcessor:processor:param:

- (PanoResult) setMediaProcessor: (PanoMediaProcessorType)  type
processor: (NSObject *_Nullable)  processor
param: (void *_Nullable)  param 

设置外部媒体处理模块。

参数
type媒体处理类型。
processor媒体处理器。值为空表示停止对应的媒体处理。
param媒体处理需要的参数。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
媒体处理器指针必须保持其有效性，直到对应处理被停止。

◆ setMicrophoneMuteStatus:

- (PanoResult) setMicrophoneMuteStatus: (BOOL)  muted

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

参数
muted静音开关， 打开/关闭 静音
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setOption:forType:

- (PanoResult) setOption: (NSObject *_Nullable)  option
forType: (PanoOptionType)  type 

设置选项对象给PANO SDK。

参数
option选项对象。
typePanoOptionType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setParameters:

- (PanoResult) setParameters: (NSString *_Nonnull)  param

设置自定义参数给PANO SDK。

参数
paramJSON格式参数。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解

◆ setPlayoutDataMuteStatus:

- (PanoResult) setPlayoutDataMuteStatus: (BOOL)  muted

设置播放数据静音状态

参数
muted静音开关， 打开/关闭 静音开关
返回
返回QResult来指示调用状态

◆ setScreenOptimization:

- (PanoResult) setScreenOptimization: (BOOL)  motion

设置屏幕优化启用状态。（仅限macOS）

参数
enable是否启用。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setScreenSource:withType:

- (PanoResult) setScreenSource: (PanoScreenSourceID)  id
withType: (PanoScreenSourceType)  type 

设置当前屏幕源。（仅限macOS）

参数
id屏幕源唯一标识.
typePanoScreenSourceType 枚举类型.
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ snapshotVideo:userId:option:

- (PanoResult) snapshotVideo: (NSString *_Nonnull)  outputDir
userId: (UInt64)  userId
option: (PanoRtcSnapshotVideoOption *_Nullable)  option 

Capture specific user's video content

参数
outputDiroutput directory
userIdthe id of target user
optionsnapshot option
返回
  • OK: Success
  • others: Failure

捕获指定用户的视频画面

参数
outputDir输出路径
userId目标用户的ID
option快照选项
返回
  • OK: 成功
  • 其他: 失败

◆ startAudio

- (PanoResult) startAudio

开启音频。

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

◆ startAudioDeviceTestWithRecord:playout:

- (PanoResult) startAudioDeviceTestWithRecord: (NSString *_Nonnull)  recordDeviceId
playout: (NSString *_Nonnull)  playoutDeviceId 

开始音频设备测试。（仅限macOS）

参数
recordDeviceId录音设备 ID。
playoutDeviceId播放设备 ID。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startAudioDumpWithFilePath:maxFileSize:

- (PanoResult) startAudioDumpWithFilePath: (NSString *_Nonnull)  filePath
maxFileSize: (SInt64)  maxFileSize 

开启音频转储。

参数
filePath转储文件路径，包含文件名和后缀。例如：/path/panoaudio.dump
maxFileSize最大转储文件大小. 如果值为-1，则文件大小不受限制。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startAudioMixingTask:withConfig:

- (PanoResult) startAudioMixingTask: (SInt64)  taskId
withConfig: (PanoRtcAudioMixingConfig *_Nonnull)  config 

启动混音任务。

参数
taskId任务标识。
config配置参数。
返回
  • OK: 成功
  • 其他: 失败
注解
实际的混音操作仅在加入频道后进行。

◆ startAudioPlayback

- (PanoResult) startAudioPlayback

开始音频设备播放(建议配合外部采集播放时的一些特殊需求使用)

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

◆ startAudioRecording

- (PanoResult) startAudioRecording

开始音频设备录音(建议配合外部采集播放时的一些特殊需求使用)

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

◆ startNetworkTestWithToken:delegate:

- (PanoResult) startNetworkTestWithToken: (NSString *_Nonnull)  token
delegate: (id< PanoRtcNetworkTestDelegate > _Nonnull)  delegate 

启动网络测试。

参数
tokenApp服务器向PANO获取的token。注意：不要使用加入频道时使用的 token。
delegate测试结果回调，在调用 stopNetworkTest 之前必须保持有效。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
网络测试会产生额外流量，尽量避免在通话过程中进行测试。

◆ startPlayoutDeviceTest:filename:

- (PanoResult) startPlayoutDeviceTest: (NSString *_Nonnull)  playoutDeviceId
filename: (NSString *_Nonnull)  filename 

开始音频播放设备测试。（仅限macOS）

参数
playoutDeviceId播放设备 ID。
filename音频文件的完整路径。支持mp3，aac，wav。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startPreview:withDelegate:profile:

- (PanoResult) startPreview: (NSString *_Nonnull)  deviceId
withDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate
profile: (PanoVideoProfileType)  profile 

开启摄像头预览（随带外置渲染器）。（仅限macOS）

参数
deviceId设备唯一标识。
delegatePanoRtcRenderDelegate 协议对象。
profilePanoVideoProfileType 枚举类型，摄像头预览的设定档。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startPreview:withView:config:

- (PanoResult) startPreview: (NSString *_Nonnull)  deviceId
withView: (PanoView *_Nonnull)  view
config: (PanoRtcVideoConfig *_Nullable)  config 

开启摄像头预览（随带渲染视图）。（仅限macOS）

参数
deviceId设备唯一标识。
viewPanoView 对象。
configPanoRtcVideoConfig 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
必须从主线程调用。

◆ startPreviewWithDelegate:profile:

- (PanoResult) startPreviewWithDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate
profile: (PanoVideoProfileType)  profile 

开启当前摄像头预览（随带外置渲染器）。（仅限iOS）

参数
delegatePanoRtcRenderDelegate 协议对象。
profilePanoVideoProfileType 枚举类型，摄像头预览的设定档。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startPreviewWithView:config:

- (PanoResult) startPreviewWithView: (PanoView *_Nonnull)  view
config: (PanoRtcVideoConfig *_Nullable)  config 

开启当前摄像头预览（随带渲染视图）。（仅限iOS）

参数
viewPanoView 对象。
configPanoRtcVideoConfig 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
必须从主线程调用。

◆ startRecordDeviceTest:

- (PanoResult) startRecordDeviceTest: (NSString *_Nonnull)  recordDeviceId

开始音频采集设备测试。（仅限macOS）

参数
recordDeviceId录音设备 ID。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startScreen

- (PanoResult) startScreen

开启屏幕共享。

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

◆ startScreenWithAppGroupId:

- (PanoResult) startScreenWithAppGroupId: (ios(11.0))  API_AVAILABLE

开启屏幕共享。（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）

参数
appGroupIdApplication Group Identifier。（可选）
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
开启屏幕共享前请先加入一个频道，否则将返回失败。 appGroupId为选填，设置使功能更加可靠。可参照文档获取Application Group Identifier。

◆ startSoundCardMonitor:

- (PanoResult) startSoundCardMonitor: (id< PanoRtcRenderDelegate > _Nonnull)  delegate

开始声卡数据监控器。（仅限macOS）

参数
delegatePanoRtcRenderDelegate 协议对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
用户需要先调用 startAudio 开启音频，才能使用声卡监控器功能

◆ startSoundCardShare

- (PanoResult) startSoundCardShare

开启声卡音频共享。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
用户需要先调用 startAudio 开启音频，才能使用声卡共享功能

◆ startVideoWithDelegate:config:

- (PanoResult) startVideoWithDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate
config: (PanoRtcVideoSourceConfig *_Nullable)  config 

开启视频（随带外置渲染器）。

参数
delegatePanoRtcRenderDelegate 协议对象。
configPanoRtcVideoSourceConfig 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
开启视频前请先加入一个频道，否则将返回失败。

◆ startVideoWithDelegate:profile:

- (PanoResult) startVideoWithDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate
profile: (PanoVideoProfileType)  profile 

开启视频（随带外置渲染器）。

参数
delegatePanoRtcRenderDelegate 协议对象。
profilePanoVideoProfileType 枚举类型，视频发送的设定档。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
开启视频前请先加入一个频道，否则将返回失败。

◆ startVideoWithView:config:

- (PanoResult) startVideoWithView: (PanoView *_Nullable)  view
config: (PanoRtcVideoConfig *_Nullable)  config 

开启视频（随带渲染视图）。

参数
viewPanoView 对象。
configPanoRtcVideoConfig 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
开启视频前请先加入一个频道，否则将返回失败。view为空则不渲染视图。 必须从主线程调用。

◆ stopAudio

- (PanoResult) stopAudio

停止音频。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopAudioDeviceTest

- (PanoResult) stopAudioDeviceTest

停止音频设备测试。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopAudioDump

- (PanoResult) stopAudioDump

停止音频转储。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopAudioMixingTask:

- (PanoResult) stopAudioMixingTask: (SInt64)  taskId

结束混音任务。

参数
taskId任务标识。
返回
  • OK: 成功
  • 其他: 失败

◆ stopAudioPlayback

- (PanoResult) stopAudioPlayback

关闭音频设备播放(建议配合外部采集播放时的一些特殊需求使用)

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

◆ stopAudioRecording

- (PanoResult) stopAudioRecording

关闭音频设备录音(建议配合外部采集播放时的一些特殊需求使用)

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

◆ stopNetworkTest

- (PanoResult) stopNetworkTest

停止网络测试。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopPlayoutDeviceTest

- (PanoResult) stopPlayoutDeviceTest

停止音频播放设备测试。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopPreview

- (PanoResult) stopPreview

停止当前摄像头预览。（仅限iOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopPreview:

- (PanoResult) stopPreview: (NSString *_Nonnull)  deviceId

停止摄像头预览。（仅限macOS）

参数
deviceId设备唯一标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopRecordDeviceTest

- (PanoResult) stopRecordDeviceTest

停止音频采集设备测试。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopScreen

- (PanoResult) stopScreen

停止屏幕共享。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopSoundCardMonitor

- (PanoResult) stopSoundCardMonitor

停止声卡数据监控器。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopSoundCardShare

- (PanoResult) stopSoundCardShare

停止声卡音频共享。（仅限macOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopVideo

- (PanoResult) stopVideo

停止视频。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ subscribeAudio:

- (PanoResult) subscribeAudio: (UInt64)  userId

订阅用户的音频。

参数
userId客户定义的用户标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
订阅用户的音频前，请确保用户已开启音频。

◆ subscribeScreen:withDelegate:

- (PanoResult) subscribeScreen: (UInt64)  userId
withDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate 

订阅用户的屏幕共享（随带外置渲染器）。

参数
userId客户定义的用户标识。
delegatePanoRtcRenderDelegate 协议对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
订阅用户的屏幕共享前，请确保用户已开启屏幕共享。

◆ subscribeScreen:withView:

- (PanoResult) subscribeScreen: (UInt64)  userId
withView: (PanoView *_Nonnull)  view 

订阅用户的屏幕共享（随带渲染视图）。

参数
userId客户定义的用户标识。
viewPanoView 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
订阅用户的屏幕共享前，请确保用户已开启屏幕共享。 必须从主线程调用。

◆ subscribeVideo:withDelegate:profile:

- (PanoResult) subscribeVideo: (UInt64)  userId
withDelegate: (id< PanoRtcRenderDelegate > _Nonnull)  delegate
profile: (PanoVideoProfileType)  profile 

订阅用户的视频（随带外置渲染器）。

参数
userId客户定义的用户标识。
delegatePanoRtcRenderDelegate 协议对象。
profilePanoVideoProfileType 枚举对象，视频订阅的设定档。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
订阅用户的视频前，请确保用户已开启视频。

◆ subscribeVideo:withView:config:

- (PanoResult) subscribeVideo: (UInt64)  userId
withView: (PanoView *_Nullable)  view
config: (PanoRtcVideoConfig *_Nullable)  config 

订阅用户的视频（随带渲染视图）。

参数
userId客户定义的用户标识。
viewPanoView 对象。
configPanoRtcVideoConfig 对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
订阅用户的视频前，请确保用户已开启视频。 必须从主线程调用。

◆ switchCamera

- (PanoResult) switchCamera

切换前后置摄像头。（仅限iOS）

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ switchWhiteboardEngine:

- (PanoResult) switchWhiteboardEngine: (NSString *_Nonnull)  whiteboardId

切换白板控制对象

参数
whiteboardId白板Id。最大长度128字节，UTF8String。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
  • 此接口用于多白板用例场景。
  • PanoRtcEngineKit会自动创建白板Id为"default"的白板
  • RtcEngine会保留前缀为"pano-"的白板Id，请不要使用
  • 当传入的whiteboardId之前没被设置过，PanoRtcEngineKit会生成新的白板
  • 切换后需要调用whiteboardEngine获得当前的白板控制对象。

◆ unmuteAudio

- (PanoResult) unmuteAudio

取消静音。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
取消静音前请先开启音频，否则操作将无效。

◆ unmuteScreen

- (PanoResult) unmuteScreen

恢复屏幕共享。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
恢复屏幕共享前请先开启屏幕共享，否则操作将无效。

◆ unmuteVideo

- (PanoResult) unmuteVideo

恢复视频。

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
恢复视频前请先开启视频，否则操作将无效。

◆ unsubscribeAudio:

- (PanoResult) unsubscribeAudio: (UInt64)  userId

取消订阅用户的音频。

参数
userId客户定义的用户标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
当用户停止音频或者离开频道的时候，用户的音频将会被自动取消订阅。

◆ unsubscribeScreen:

- (PanoResult) unsubscribeScreen: (UInt64)  userId

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

参数
userId客户定义的用户标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
当用户停止屏幕共享或者离开频道的时候，用户的屏幕共享将会被自动取消订阅。

◆ unsubscribeVideo:

- (PanoResult) unsubscribeVideo: (UInt64)  userId

取消订阅用户的视频。

参数
userId客户定义的用户标识。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
当用户停止视频或者离开频道的时候，用户的视频将会被自动取消订阅。

◆ updateAudioMixingTask:withConfig:

- (PanoResult) updateAudioMixingTask: (SInt64)  taskId
withConfig: (PanoRtcAudioMixingConfig *_Nonnull)  config 

更新混音任务配置参数。

参数
taskId任务标识。
config配置参数。
返回
  • OK: 成功
  • 其他: 失败

◆ updateConfig:

- (PanoResult) updateConfig: (PanoRtcEngineConfig *_Nonnull)  config

更新 PanoRtcEngineKit 对象配置。

参数
configPanoRtcEngineConfig 对象.
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
请在加入频道之前更新配置，否则将返回失败。

◆ updateScreenMoving:withDistance:

- (PanoResult) updateScreenMoving: (UInt64)  userId
withDistance: (CGPoint)  distance 

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

参数
userId客户定义的用户标识。
distance屏幕焦点移动距离。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解

◆ updateScreenScaling:withRatio:

- (PanoResult) updateScreenScaling: (UInt64)  userId
withRatio: (PanoScreenScalingRatio)  ratio 

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

参数
userId客户定义的用户标识。
ratio屏幕缩放比例类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
默认焦点是视图的中心点。

◆ updateScreenScaling:withRatio:focus:

- (PanoResult) updateScreenScaling: (UInt64)  userId
withRatio: (CGFloat)  ratio
focus: (CGPoint)  focus 

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

参数
userId客户定义的用户标识。
ratio屏幕缩放比例值。
focus屏幕焦点坐标值。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解

◆ whiteboardEngine

- (PanoRtcWhiteboard *_Nonnull) whiteboardEngine

获取白板控制对象。

返回
PanoRtcWhiteboard 对象。

属性说明

◆ annotationManager

- (PanoRtcAnnotationManager*) annotationManager
readnonatomicassign

获取标注管理器对象。

返回
PanoRtcAnnotationManager 对象。

◆ groupManager

- (PanoRtcGroupManager*) groupManager
readnonatomicassign

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

返回
PanoRtcGroupManager 对象。

◆ messageService

- (PanoRtcMessage*) messageService
readnonatomicassign

获取消息服务的接口指针

返回
PanoRtcMessage 对象。

◆ recordingService

- (PanoRtcRecording*) recordingService
readnonatomicassign

获取录制服务接口

返回
PanoRtcRecording 对象。

◆ remoteController

- (PanoRtcRemoteController*) remoteController
readnonatomicassign

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

返回
PanoRtcRemoteController 对象。

◆ videoRenderManager

- (PanoRtcVideoRenderManager*) videoRenderManager
readnonatomicassign

获取视频渲染管理器

返回
PanoRtcVideoRenderManager 对象。

◆ videoStreamManager

- (PanoRtcVideoStreamManager*) videoStreamManager
readnonatomicassign

获取视频流管理器对象。

返回
PanoRtcVideoStreamManager 对象。
注解
如果应用各端都不会同时发送多路视频流，则无需使用视频流管理器。
该类的文档由以下文件生成:
制作者 doxygen 1.9.2