PanoRtcEngineKit.h

浏览该文件的文档.

 
//
//  PanoRtcEngineKit.h
//  PanoRtc
//
//  Copyright © 2019 Pano. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "PanoEnumerates.h"
#import "PanoExternalObjects.h"
#import "PanoObjects.h"
#import "PanoRtcAnnotation.h"
#import "PanoRtcWhiteboard.h"
#import "PanoRtcGroupManager.h"
#import "PanoRtcRenderManager.h"
#import "PanoRtcRecording.h"
 
NS_ASSUME_NONNULL_BEGIN
 
#pragma mark - PanoRtcEngineDelegate
 
@protocol PanoRtcEngineDelegate <NSObject>
@optional
 
#pragma mark Delegate Methods
 
#pragma mark Core Delegate Methods
 
- (void)onChannelJoinConfirm:(PanoResult)result;
- (void)onChannelLeaveIndication:(PanoResult)result;
- (void)onChannelFailover:(PanoFailoverState)state;
- (void)onChannelCountDown:(UInt32)remain;
 
- (void)onUserJoinIndication:(UInt64)userId
                    withName:(NSString * _Nullable)userName;
- (void)onUserLeaveIndication:(UInt64)userId
                   withReason:(PanoUserLeaveReason)reason;
 
- (void)onUserAudioStart:(UInt64)userId;
- (void)onUserAudioStop:(UInt64)userId;
 
- (void)onUserVideoStart:(UInt64)userId
          withMaxProfile:(PanoVideoProfileType)maxProfile;
- (void)onUserVideoStop:(UInt64)userId;
 
- (void)onUserScreenStart:(UInt64)userId;
- (void)onUserScreenStop:(UInt64)userId;
 
- (void)onUserAudioSubscribe:(UInt64)userId
                  withResult:(PanoSubscribeResult)result;
 
- (void)onUserVideoSubscribe:(UInt64)userId
                  withResult:(PanoSubscribeResult)result;
 
- (void)onUserScreenSubscribe:(UInt64)userId
                   withResult:(PanoSubscribeResult)result;
 
- (void)onUserAudioMute:(UInt64)userId;
- (void)onUserAudioUnmute:(UInt64)userId;
 
- (void)onUserVideoMute:(UInt64)userId;
- (void)onUserVideoUnmute:(UInt64)userId;
 
- (void)onUserScreenMute:(UInt64)userId;
- (void)onUserScreenUnmute:(UInt64)userId;
 
- (void)onActiveSpeakerListUpdated:(NSArray<NSNumber *> * _Nullable)userIds;
 
#pragma mark User Audio Control Message
- (void)onUserAudioControlMessageReceived:(UInt64)userId
                                     data:(NSData *)data;
 
#pragma mark Observer Delegate Methods
 
- (void)onFirstAudioDataReceived:(UInt64)userId;
 
- (void)onFirstVideoDataReceived:(UInt64)userId;
 
- (void)onFirstScreenDataReceived:(UInt64)userId;
 
- (void)onFirstVideoFrameRendered:(UInt64)userId;
 
- (void)onFirstScreenFrameRendered:(UInt64)userId;
 
#pragma mark Statistics Delegate Methods
 
- (void)onAudioSendStats:(PanoRtcAudioSendStats * _Nonnull)stats;
- (void)onAudioRecvStats:(PanoRtcAudioRecvStats * _Nonnull)stats;
 
- (void)onVideoSendStats:(PanoRtcVideoSendStats * _Nonnull)stats;
- (void)onVideoRecvStats:(PanoRtcVideoRecvStats * _Nonnull)stats;
 
- (void)onScreenSendStats:(PanoRtcScreenSendStats * _Nonnull)stats;
- (void)onScreenRecvStats:(PanoRtcScreenRecvStats * _Nonnull)stats;
 
- (void)onVideoSendBweStats:(PanoRtcVideoSendBweStats * _Nonnull)stats;
- (void)onVideoRecvBweStats:(PanoRtcVideoRecvBweStats * _Nonnull)stats;
 
- (void)onSystemStats:(PanoRtcSystemStats * _Nonnull)stats;
 
#pragma mark Network Delegate Methods
 
- (void)onNetworkQuality:(PanoQualityRating)quality
                withUser:(UInt64)userId;
 
#pragma mark User Audio indication Methods
 
- (void)onUserAudioLevel:(PanoRtcAudioLevel * _Nonnull)level;
 
- (void)onEchoDelayChanged:(UInt32) newDelay;
 
#if TARGET_OS_OSX
 
#pragma mark Device Delegate Methods (macOS)
 
- (void)onDeviceStateChange:(PanoDeviceState)state
                 withDevice:(NSString * _Nonnull)deviceId
                       type:(PanoDeviceType)type;
 
- (void)onDefaultDeviceChange:(NSString * _Nonnull)deviceId
                     withType:(PanoDeviceType)type;
 
#endif
 
#pragma mark Video Capture Delegate Methods
 
 - (void)onVideoCaptureStateChange:(PanoVideoCaptureState)state
                        withDevice:(NSString * _Nonnull)deviceId;
 
#pragma mark Whiteboard Delegate Methods
 
- (void)onWhiteboardAvailable;
- (void)onWhiteboardUnavailable;
 
- (void)onWhiteboardStart;
- (void)onWhiteboardStop;
- (void)onWhiteboardStart:(NSString * _Nonnull)whiteboardId;
- (void)onWhiteboardStop:(NSString * _Nonnull)whiteboardId;
 
#pragma mark - Audio Mixing Delegate Methods
 
- (void)onAudioMixingStateChanged:(SInt64)taskId
                        withState:(PanoAudioMixingState)state;
 
#pragma mark - Video Snapshot Delegate Methods
 
- (void)onVideoSnapshotCompleted:(BOOL)succeed
                          userId:(UInt64)userId
                        filename:(NSString * _Nonnull)filename;
 
- (void)onAudioStartResult:(PanoResult)result;
 
- (void)onVideoStartResult:(PanoResult)result;
 
- (void)onScreenStartResult:(PanoResult)result;
- (void)onScreenCaptureStateChanged:(PanoScreenCaptureState)state reason:(PanoResult)reason;
- (void)onSoundCardShareStartResult:(PanoResult)result;
- (void)onSoundCardMonitorStartResult:(PanoResult)result;
- (void)onUserAudioCallTypeChanged:(uint64_t)userId type:(PanoAudioCallType)type;
- (void)onCalloutResult:(NSString * _Nonnull)phoneNo result:(PanoResult)result;
 
@end
 
 
#pragma mark - PanoRtcRenderDelegate
 
@protocol PanoRtcRenderDelegate <NSObject>
@optional
 
#pragma mark Delegate Methods
 
- (PanoResult)onRenderVideoData:(void * _Nonnull)buffer
                     withLength:(SInt32)length
                         format:(PanoRtcVideoFormat * _Nonnull)format
                      timestamp:(UInt64)timestamp;
 
- (PanoResult)onRenderAudioData:(void * _Nonnull)buffer
                     withLength:(SInt32)length
                         format:(PanoRtcAudioFormat * _Nonnull)format
                      timestamp:(UInt64)timestamp;
@end
 
 
#pragma mark - PanoRtcVideoFilterDelegate
 
@protocol PanoRtcVideoFilterDelegate <NSObject>
@optional
 
#pragma mark Delegate Methods
 
- (void)onNativeVideoFrame:(CVPixelBufferRef _Nonnull)frame
              withRotation:(PanoVideoRotation)rotation;
 
- (void)onVideoFrame:(void * _Nonnull)buffer
          withLength:(SInt32)length
          withFormat:(PanoRtcVideoFormat * _Nonnull)format;
 
@end
 
 
#pragma mark - PanoRtcAudioDataExProcessorDelegate
 
@protocol PanoRtcAudioDataExProcessorDelegate <NSObject>
@optional
 
#pragma mark Delegate Methods
 
- (void)onAudioFrame:(void * _Nonnull)buffer
          withLength:(SInt32)length
       withMaxLength:(SInt32)maxBufferByteLens
          withFormat:(PanoRtcAudioFormat * _Nonnull)format;
 
@end
 
 
#pragma mark - PanoRtcNetworkTestDelegate
 
@protocol PanoRtcNetworkTestDelegate <NSObject>
@optional
 
#pragma mark Delegate Methods
 
- (void)onNetworkTestComplete:(PanoRtcNetworkQuality * _Nonnull)quality;
 
@end
 
 
#pragma mark - PanoRtcExternalAudioRecorder
 
typedef PanoExternalAudioRecorder PanoRtcExternalAudioRecorder;
 
 
#pragma mark - PanoRtcExternalAudioPlayer
 
typedef PanoExternalAudioPlayer PanoRtcExternalAudioPlayer;
 
 
#pragma mark - PanoRtcEngineKit
 
@class PanoRtcVideoStreamManager;
@class PanoRtcMessage;
@class PanoRtcRemoteController;
@class PanoRtcCameraController;
 
__attribute__((visibility("default"))) @interface PanoRtcEngineKit : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
@property (readonly, nonatomic) PanoRtcVideoStreamManager *videoStreamManager;
@property (readonly, nonatomic) PanoRtcAnnotationManager *annotationManager;
@property (readonly, nonatomic) PanoRtcMessage *messageService;
@property (readonly, nonatomic) PanoRtcRemoteController *remoteController;
@property (readonly, nonatomic) PanoRtcGroupManager *groupManager;
@property (readonly, nonatomic) PanoRtcVideoRenderManager *videoRenderManager;
@property (readonly, nonatomic) PanoRtcRecording *recordingService;
 
#pragma mark Core Service
 
+ (instancetype _Nonnull)engineWithConfig:(PanoRtcEngineConfig * _Nonnull)config
                                 delegate:(id<PanoRtcEngineDelegate> _Nonnull)delegate;
 
- (PanoResult)updateConfig:(PanoRtcEngineConfig * _Nonnull)config;
 
- (void)destroy;
 
- (PanoResult)joinChannelWithToken:(NSString * _Nonnull)token
                         channelId:(NSString * _Nonnull)channelId
                            userId:(UInt64)userId
                            config:(PanoRtcChannelConfig * _Nullable)config;
- (void)leaveChannel;
 
- (PanoResult)startAudio;
- (PanoResult)stopAudio;
 
- (PanoResult)startSoundCardShare;
- (PanoResult)stopSoundCardShare;
 
- (PanoResult)startSoundCardMonitor:(id<PanoRtcRenderDelegate> _Nonnull)delegate;
- (PanoResult)stopSoundCardMonitor;
 
- (PanoResult)startVideoWithView:(PanoView * _Nullable)view
                          config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)startVideoWithDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                             profile:(PanoVideoProfileType)profile;
 
- (PanoResult)startVideoWithDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                              config:(PanoRtcVideoSourceConfig * _Nullable)config;
 
- (PanoResult)stopVideo;
 
#if TARGET_OS_OSX
 
- (PanoResult)startScreen;
 
#endif
 
#if TARGET_OS_IPHONE
 
- (PanoResult)startScreenWithAppGroupId:(NSString *)appGroupId API_AVAILABLE(ios(11.0));
 
#endif
- (PanoResult)stopScreen;
 
- (PanoResult)subscribeAudio:(UInt64)userId;
- (PanoResult)unsubscribeAudio:(UInt64)userId;
 
- (PanoResult)subscribeVideo:(UInt64)userId
                    withView:(PanoView * _Nullable)view
                      config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)subscribeVideo:(UInt64)userId
                withDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                     profile:(PanoVideoProfileType)profile;
- (PanoResult)unsubscribeVideo:(UInt64)userId;
 
- (PanoResult)subscribeScreen:(UInt64)userId
                     withView:(PanoView * _Nonnull)view;
- (PanoResult)subscribeScreen:(UInt64)userId
                 withDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate;
- (PanoResult)unsubscribeScreen:(UInt64)userId;
 
- (PanoResult)callout:(NSString * _Nonnull)phoneNo bindToUser:(BOOL)bindToUser;
- (PanoResult)dropCall:(NSString *)phoneNo;
 
- (PanoResult)updateScreenScaling:(UInt64)userId
                        withRatio:(PanoScreenScalingRatio)ratio;
- (PanoResult)updateScreenScaling:(UInt64)userId
                        withRatio:(CGFloat)ratio
                            focus:(CGPoint)focus;
- (PanoResult)updateScreenMoving:(UInt64)userId
                    withDistance:(CGPoint)distance;
 
- (PanoResult)muteAudio;
- (PanoResult)unmuteAudio;
 
- (PanoResult)muteVideo;
- (PanoResult)unmuteVideo;
 
- (PanoResult)muteScreen;
- (PanoResult)unmuteScreen;
- (PanoResult)setAudioIndication:(BOOL)enable
                      intervalMs:(UInt32)intervalMs;
 
 
#pragma mark Device Manager
 
- (PanoResult)setMicrophoneMuteStatus:(BOOL)muted;
 
- (PanoResult)setAudioDeviceVolume:(UInt32)volume
                          withType:(PanoDeviceType)type;
- (UInt32)getAudioDeviceVolume:(PanoDeviceType)type;
 
- (SInt16)getRecordingLevel;
 
- (SInt16)getPlayoutLevel;
 
- (PanoRtcCameraController *)getCameraController:(NSString * _Nonnull)deviceId;
 
- (PanoResult) startAudioRecording;
- (PanoResult) stopAudioRecording;
- (PanoResult) startAudioPlayback;
- (PanoResult) stopAudioPlayback;
- (PanoResult) setPlayoutDataMuteStatus:(BOOL)muted;
 
#if TARGET_OS_IPHONE
 
#pragma mark Device Manager (iOS)
 
- (PanoResult)setLoudspeakerStatus:(BOOL)enable;
- (BOOL)isEnabledLoudspeaker;
 
- (PanoResult)switchCamera;
- (BOOL)isFrontCamera;
 
- (NSString * _Nullable)getCameraDeviceId:(BOOL)frontCamera;
 
- (PanoResult)startPreviewWithView:(PanoView * _Nonnull)view
                            config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)startPreviewWithDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                               profile:(PanoVideoProfileType)profile;
- (PanoResult)stopPreview;
 
- (BOOL)isMultiCameraCaptureSupported;
 
#endif
 
#if TARGET_OS_OSX
 
#pragma mark Device Manager (macOS)
 
- (NSArray<PanoRtcDeviceInfo *> * _Nullable)enumerateDevices:(PanoDeviceType)type;
 
- (PanoResult)setDevice:(NSString * _Nonnull)deviceId
               withType:(PanoDeviceType)type;
- (PanoResult)setDefaultDeviceWithType:(PanoDeviceType)type;
- (BOOL)isDefaultDeviceWithType:(PanoDeviceType)type;
- (NSString * _Nullable)getDevice:(PanoDeviceType)type;
 
- (PanoResult)startPreview:(NSString * _Nonnull)deviceId
                  withView:(PanoView * _Nonnull)view
                    config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)startPreview:(NSString * _Nonnull)deviceId
              withDelegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                   profile:(PanoVideoProfileType)profile;
- (PanoResult)stopPreview:(NSString * _Nonnull)deviceId;
 
- (PanoResult)startAudioDeviceTestWithRecord:(NSString * _Nonnull)recordDeviceId
                                     playout:(NSString * _Nonnull)playoutDeviceId;
 
- (PanoResult)stopAudioDeviceTest;
 
- (PanoResult)startRecordDeviceTest:(NSString * _Nonnull)recordDeviceId;
 
- (PanoResult)stopRecordDeviceTest;
 
- (PanoResult)startPlayoutDeviceTest:(NSString * _Nonnull)playoutDeviceId
                            filename:(NSString * _Nonnull)filename;
 
- (PanoResult)stopPlayoutDeviceTest;
 
- (SInt16)getTestRecordingLevel;
 
- (SInt16)getTestPlayoutLevel;
 
#pragma mark Screen Source Manager (macOS)
 
- (NSArray<PanoRtcScreenSourceInfo *> * _Nullable)enumerateScreenSources:(PanoScreenSourceType)type;
 
- (PanoResult)setScreenSource:(PanoScreenSourceID)id
                     withType:(PanoScreenSourceType)type;
 
- (PanoResult)enableSreenFilterSelfApp:(BOOL)enable;
 
- (PanoResult)setScreenOptimization:(BOOL)motion;
 
// Use beginConfiguration and commitConfiguration to batch multiple configuration
// operations on a running capture engine into an atomic update.
- (PanoResult)beginScreenConfiguration:(BOOL)resetConfig;
- (PanoResult)commitScreenConfiguration;
- (PanoResult)selectSharedScreen:(PanoScreenSourceID)id;
- (PanoResult)addSharedScreenSource:(PanoScreenSourceID)id
                           withType:(PanoScreenSourceType)type;
- (PanoResult)removeSharedScreenSource:(PanoScreenSourceID)id
                              withType:(PanoScreenSourceType)type;
- (PanoResult)addUnsharedScreenSource:(PanoScreenSourceID)id
                             withType:(PanoScreenSourceType)type;
- (PanoResult)removeUnsharedScreenSource:(PanoScreenSourceID)id
                                withType:(PanoScreenSourceType)type;
 
#endif
 
#pragma mark External Device Manager
 
- (PanoRtcExternalAudioRecorder * _Nonnull)externalAudioRecorder;
 
- (PanoRtcExternalAudioPlayer * _Nonnull)externalAudioPlayer;
 
 
#pragma mark Audio Mixing Manager
 
- (PanoResult)createAudioMixingTask:(SInt64)taskId
                           filename:(NSString * _Nonnull)filename;
 
- (PanoResult)destroyAudioMixingTask:(SInt64)taskId;
 
- (PanoResult)startAudioMixingTask:(SInt64)taskId
                        withConfig:(PanoRtcAudioMixingConfig * _Nonnull)config;
 
- (PanoResult)updateAudioMixingTask:(SInt64)taskId
                         withConfig:(PanoRtcAudioMixingConfig * _Nonnull)config;
 
- (PanoResult)stopAudioMixingTask:(SInt64)taskId;
 
- (PanoResult)resumeAudioMixing:(SInt64)taskId;
 
- (PanoResult)pauseAudioMixing:(SInt64)taskId;
 
- (SInt64)getAudioMixingDuration:(SInt64)taskId;
 
- (SInt64)getAudioMixingCurrentTimestamp:(SInt64)taskId;
 
- (PanoResult)seekAudioMixing:(SInt64)taskId
                    timestamp:(SInt64)timestampMs;
 
#pragma mark Snapshot Methods
 
- (PanoResult)snapshotVideo:(NSString * _Nonnull)outputDir
                     userId:(UInt64)userId
                     option:(PanoRtcSnapshotVideoOption  * _Nullable)option;
 
#pragma mark Whiteboard Methods
 
- (PanoRtcWhiteboard * _Nonnull)whiteboardEngine;
 
- (PanoResult)switchWhiteboardEngine:(NSString * _Nonnull)whiteboardId;
 
#pragma mark Troubleshoot Methods
 
+ (void)setLogLevel:(PanoLogLevel)level;
 
+ (NSString * _Nonnull)getSdkVersion;
 
- (void * _Nullable)getNativeHandle;
 
- (PanoResult)startAudioDumpWithFilePath:(NSString * _Nonnull)filePath
                             maxFileSize:(SInt64)maxFileSize;
- (PanoResult)stopAudioDump;
 
- (PanoResult)sendFeedback:(PanoFeedbackInfo * _Nonnull)info;
 
- (PanoDeviceRating)queryDeviceRating;
 
- (PanoResult)startNetworkTestWithToken:(NSString * _Nonnull)token
                               delegate:(id<PanoRtcNetworkTestDelegate> _Nonnull)delegate;
- (PanoResult)stopNetworkTest;
 
#pragma mark Option Methods
 
- (PanoResult)setOption:(NSObject * _Nullable)option
                forType:(PanoOptionType)type;
 
- (PanoResult)setDeviceBoundOption:(NSObject * _Nullable)option
                           forType:(PanoOptionType)type
                         forDevice:(NSString * _Nonnull)deviceId;
 
#pragma mark Customized Methods
 
- (PanoResult)setParameters:(NSString * _Nonnull)param;
 
 
- (PanoResult)setMediaProcessor:(PanoMediaProcessorType)type
                      processor:(NSObject* _Nullable)processor
                          param:(void* _Nullable)param;
 
- (PanoResult)setDeviceBoundMediaProcessor:(PanoMediaProcessorType)type
                                 processor:(NSObject* _Nullable)processor
                                     param:(void* _Nullable)param
                                 forDevice:(NSString* _Nonnull)deviceId;
 
- (PanoResult)sendAudioControlMessage:(NSData *) data;
 
@end
 
 
#pragma mark - PanoRtcVideoStreamDelegate
 
@protocol PanoRtcVideoStreamDelegate <NSObject>
@optional
 
- (void)onUserVideoStart:(UInt64)userId
                  stream:(SInt32)streamId
              maxProfile:(PanoVideoProfileType)maxProfile;
- (void)onUserVideoStop:(UInt64)userId
                 stream:(SInt32)streamId;
 
- (void)onUserVideoSubscribe:(UInt64)userId
                      stream:(SInt32)streamId
                      result:(PanoSubscribeResult)result;
 
- (void)onUserVideoMute:(UInt64)userId
                 stream:(SInt32)streamId;
- (void)onUserVideoUnmute:(UInt64)userId
                   stream:(SInt32)streamId;
 
- (void)onFirstVideoDataReceived:(UInt64)userId
                          stream:(SInt32)streamId;
 
- (void)onFirstVideoFrameRendered:(UInt64)userId
                           stream:(SInt32)streamId;
 
- (void)onVideoSnapshotCompleted:(UInt64)userId
                          stream:(SInt32)streamId
                         succeed:(BOOL)succeed
                        filename:(NSString * _Nonnull)filename;
 
 - (void)onVideoCaptureStateChange:(PanoVideoCaptureState)state
                            stream:(SInt32)streamId
                            device:(NSString * _Nonnull)deviceId;
 
@end
 
 
#pragma mark - PanoRtcVideoStreamManager
 
__attribute__((visibility("default"))) @interface PanoRtcVideoStreamManager : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
#pragma mark Video Stream Methods
 
- (PanoResult)setDelegate:(id<PanoRtcVideoStreamDelegate> _Nullable)delegate;
 
- (SInt32)createVideoStream:(NSString * _Nonnull)deviceId;
- (PanoResult)destroyVideoStream:(SInt32)streamId;
 
- (PanoResult)setCaptureDevice:(NSString * _Nonnull)deviceId
                        stream:(SInt32)streamId;
- (NSString * _Nullable)getCaptureDevice:(SInt32)streamId;
 
- (PanoResult)startVideo:(SInt32)streamId
                    view:(PanoView * _Nullable)view
                  config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)startVideo:(SInt32)streamId
                delegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                 profile:(PanoVideoProfileType)profile;
- (PanoResult)startVideo:(SInt32)streamId
                delegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                  config:(PanoRtcVideoSourceConfig * _Nullable)config;
- (PanoResult)stopVideo:(SInt32)streamId;
 
- (PanoResult)subscribeVideo:(UInt64)userId
                      stream:(SInt32)streamId
                        view:(PanoView * _Nullable)view
                      config:(PanoRtcVideoConfig * _Nullable)config;
- (PanoResult)subscribeVideo:(UInt64)userId
                      stream:(SInt32)streamId
                    delegate:(id<PanoRtcRenderDelegate> _Nonnull)delegate
                     profile:(PanoVideoProfileType)profile;
- (PanoResult)unsubscribeVideo:(UInt64)userId
                        stream:(SInt32)streamId;
 
- (PanoResult)muteVideo:(SInt32)streamId;
- (PanoResult)unmuteVideo:(SInt32)streamId;
 
- (PanoResult)setVideoFilter:(id<PanoRtcVideoFilterDelegate> _Nullable)filter
                      stream:(SInt32)streamId;
 
- (PanoResult)snapshotVideo:(UInt64)userId
                     stream:(SInt32)streamId
                  outputDir:(NSString * _Nonnull)outputDir
                     option:(PanoRtcSnapshotVideoOption  * _Nullable)option;
 
@end
 
#pragma mark - PanoRtcMessageDelegate
 
@protocol PanoRtcMessageDelegate <NSObject>
@optional
 
- (void)onServiceStateChanged:(PanoMessageServiceState)state reason:(PanoResult)reason;
 
- (void)onUserMessage:(UInt64)userId data:(NSData *)data;
 
- (void)onSubscribeTopic:(NSString *)topic result:(PanoResult)result;
 
- (void)onTopicMessage:(NSString *)topic
                userId:(UInt64)userId
                  data:(NSData *)data
             timestamp:(NSTimeInterval)timestamp;
 
- (void)onTopicMessage:(NSString *)topic
                userId:(UInt64)userId
                  data:(NSData *)data;
 
- (void)onPublishTopicMessageFailed:(NSString *)topic
                             userId:(UInt64)userId
                          requestId:(UInt32)requestId
                             reason:(PanoResult)reason;
 
- (void)onPropertyChanged:(NSArray<PanoPropertyAction *> *)props;
 
@end
 
#pragma mark - PanoRtcMessage
 
__attribute__((visibility("default"))) @interface PanoRtcMessage : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
@property (weak, nonatomic) id<PanoRtcMessageDelegate> delegate;
 
- (PanoResult)sendMessageToUser:(UInt64)userId
                           data:(NSData *)data;
 
- (PanoResult)broadcastMessage:(NSData *)data
                      sendBack:(BOOL)sendBack;
 
- (PanoResult)publishTopic:(NSString *)topic
                      data:(NSData *)data
                 requestId:(UInt32)requestId;
 
- (PanoResult)subscribe:(NSString *)topic;
 
- (PanoResult)unsubscribe:(NSString *)topic;
 
- (PanoResult)setProperty:(NSString *)name
                    value:(NSData *)value;
 
@end
 
 
#pragma mark - PanoRtcRemoteControllerDelegate
 
@protocol PanoRtcRemoteControllerDelegate <NSObject>
@optional
 
- (void)onRemoteControlRequest:(UInt64)userId needElevation:(BOOL)needElevation;
 
- (void)onRemoteControlResponse:(UInt64)userId result:(PanoResult)result;
 
- (void)onRemoteControlCancelled:(UInt64)userId reason:(PanoResult)reason;
 
@end
 
#pragma mark - PanoRtcRemoteController
 
__attribute__((visibility("default"))) @interface PanoRtcRemoteController : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
@property (weak, nonatomic) id<PanoRtcRemoteControllerDelegate> delegate;
 
- (PanoResult)requestRemoteControl:(UInt64)userId needElevation:(BOOL)needElevation;
 
- (PanoResult)acceptRemoteControl:(UInt64)userId;
 
- (PanoResult)rejectRemoteControl:(UInt64)userId;
 
- (PanoResult)cancelRemoteControl:(UInt64)userId;
 
- (PanoResult)setModifierFlags:(UInt64)userId flags:(PanoModifierFlag)flags;
 
- (PanoResult)sendKeyboardEvent:(UInt64)userId event:(PanoKeyboardEvent *)event;
 
@end
 
#pragma mark - PanoRtcCameraController
 
__attribute__((visibility("default"))) @interface PanoRtcCameraController : NSObject
 
+ (instancetype)new NS_UNAVAILABLE;
 
- (instancetype)init NS_UNAVAILABLE;
 
- (BOOL)isCameraFocusSupported;
 
- (PanoResult)setCameraFocusPointInPreview:(CGPoint)point;
 
- (BOOL)isCameraExposureSupported;
 
- (PanoResult)setCameraExposurePointInPreview:(CGPoint)point;
 
@end
 
NS_ASSUME_NONNULL_END