ZMVideoSDKShareHelper.h

Go to the documentation of this file.

 
 
#import <Foundation/Foundation.h>
#import <CoreGraphics/CoreGraphics.h>
#import <ZMVideoSDK/ZMVideoSDKAnnotationHelper.h>
#import <ZMVideoSDK/ZMVideoSDKRemoteControlHelper.h>
#import <ZMVideoSDK/ZMVideoSDKWhiteboardHelper.h>
NS_ASSUME_NONNULL_BEGIN
@interface ZMVideoSDKSharePreprocessParam : NSObject
@property(nonatomic,assign)ZMVideoSDKSharePreprocessType type;
@property(nonatomic,assign)CGDirectDisplayID monitorID;
@property(nonatomic,assign)CGWindowID windowID;
@property(nonatomic,assign)pid_t processID;
@end
 

@interface ZMVideoSDKSharePreprocessSender : NSObject
- (ZMVideoSDKErrors)sendPreprocessedData:(ZMVideoSDKYUVRawDataI420*)rawdata;
@end
 

@protocol ZMVideoSDKSharePreprocessor <NSObject>
- (void)onCapturedRawDataReceived:(ZMVideoSDKYUVRawDataI420*)rawdata sharePreprocessSender:(ZMVideoSDKSharePreprocessSender * _Nonnull)sender;

- (void)onShareStopped;
@end
 

@interface ZMVideoSDKShareAction : NSObject
@property (nonatomic, assign, readonly) unsigned int                  shareSourceId;
@property (nonatomic, assign, readonly) ZMVideoSDKShareStatus         shareStatus;
@property (nonatomic, assign, readonly) ZMVideoSDKShareType           shareType;
@property (nonatomic, assign, readonly) ZMVideoSDKShareCapturePauseReason shareCapturePauseReason;

@property (nonatomic, assign, readonly) ZMVideoSDKSubscribeFailReason subscribeFailReason;
@property (nonatomic, assign, readonly) BOOL                          isAnnotationPrivilegeEnabled;

- (NSSize)getShareSourceContentSize;

- (ZMVideoSDKRawDataPipe* _Nullable)getSharePipe;

- (ZMVideoSDKVideoCanvas* _Nullable)getShareCanvas;

- (ZMVideoSDKRemoteControlHelper* _Nullable)getRemoteControlHelper;

- (NSArray<ZMVideoSDKUser *>* _Nullable)getRemoteControlApprovedUserList;

- (ZMVideoSDKErrors)revokeRemoteControl;

- (ZMVideoSDKUser * _Nullable)getCurrentRemoteController;
 
@end
 
 

@interface ZMVideoSDKShareSender : NSObject

- (ZMVideoSDKErrors)sendShareFrame:(char* _Nullable)frameBuffer width:(int)width height:(int)height frameLength:(int)frameLength format:(ZMVideoSDKFrameDataFormat)format;
@end
 

@protocol ZMVideoSDKShareSource <NSObject>
- (void)onShareSendStarted:(ZMVideoSDKShareSender* _Nonnull)sender;
- (void)onShareSendStopped;
@end
 

@interface ZMVideoSDKShareAudioSender : NSObject
- (ZMVideoSDKErrors)sendShareAudio:(char * _Nullable)data dataLength:(unsigned int)length sampleRate:(int)rate audioChannel:(ZMVideoSDKAudioChannel)channel;
@end
 

@protocol ZMVideoSDKShareAudioSource <NSObject>

- (void)onStartSendAudio:(ZMVideoSDKShareAudioSender * _Nonnull)sender;

- (void)onStopSendAudio;
@end
 

@interface ZMVideoSDKShareOption : NSObject
@property (nonatomic, assign, readwrite) BOOL isWithDeviceAudio;

@property (nonatomic, assign, readwrite) BOOL isOptimizeForSharedVideo;
 
@end
 

@interface ZMVideoSDKShareHelper : NSObject

- (ZMVideoSDKErrors)startShareView:(CGWindowID)windowID shareOption:(ZMVideoSDKShareOption* _Nullable)option;

- (ZMVideoSDKErrors)startShareApplication:(pid_t)processID shareOption:(ZMVideoSDKShareOption* _Nullable)option;

- (BOOL)isShareViewValid:(CGWindowID)windowID;

- (ZMVideoSDKErrors)startShareScreen:(CGDirectDisplayID)monitorID shareOption:(ZMVideoSDKShareOption* _Nullable)option;

- (ZMVideoSDKErrors)startShareMultiScreen:(NSArray <NSNumber *>*)monitorIDs shareOption:(ZMVideoSDKShareOption* _Nullable)option;
 
- (ZMVideoSDKErrors)startShareComputerAudio;

- (ZMVideoSDKErrors)stopShare;
  
- (ZMVideoSDKErrors)pauseShare;

- (ZMVideoSDKErrors)resumeShare;

- (BOOL)isSharingOut;
    
- (BOOL)isScreenSharingOut;
    
- (BOOL)isOtherSharing;
    
- (ZMVideoSDKErrors)lockShare:(BOOL)lock;
    
- (BOOL)isShareLocked;

- (ZMVideoSDKErrors)enableMultiShare:(BOOL)enable;

- (BOOL)isMultiShareEnabled;

- (ZMVideoSDKErrors)enableShareDeviceAudio:(BOOL)enable;

- (BOOL)isShareDeviceAudioEnabled;

- (ZMVideoSDKErrors)enableOptimizeForSharedVideo:(BOOL)enable;

- (BOOL)isOptimizeForSharedVideoEnabled;

- (ZMVideoSDKErrors)startShare2ndCamera:(NSString* _Nullable)cameraID;

- (ZMVideoSDKErrors)subscribeMyShareCamera:(id<ZMVideoSDKRawDataPipeDelegate> _Nonnull)dataHandler DEPRECATED_MSG_ATTRIBUTE("Use [ZMVideoSDKRawDataPipe subscribe: listener:] instead");

- (ZMVideoSDKErrors)unSubscribeMyShareCamera DEPRECATED_MSG_ATTRIBUTE("Use [ZMVideoSDKRawDataPipe: unSubscribe:] instead");

- (ZMVideoSDKErrors)startSharingExternalSource:(id<ZMVideoSDKShareSource> _Nonnull)shareSource audioSource:(id<ZMVideoSDKShareAudioSource> _Nullable)audioSource DEPRECATED_MSG_ATTRIBUTE("Use -startSharingExternalSource: audioSource: isPlaying: instead");

- (ZMVideoSDKErrors)startSharingExternalSource:(id<ZMVideoSDKShareSource> _Nonnull)shareSource audioSource:(id<ZMVideoSDKShareAudioSource> _Nullable)audioSource isPlaying:(BOOL)isPlaying;
- (ZMVideoSDKErrors)startSharePureAudioSource:(id<ZMVideoSDKShareAudioSource> _Nonnull)audioSource DEPRECATED_MSG_ATTRIBUTE("Use -startSharePureAudioSource: isPlaying: instead");

- (ZMVideoSDKErrors)startSharePureAudioSource:(id<ZMVideoSDKShareAudioSource> _Nonnull)audioSource isPlaying:(BOOL)isPlaying;

- (BOOL)isAnnotationFeatureSupport;

- (ZMVideoSDKErrors)disableViewerAnnotation:(BOOL)disable;

- (BOOL)isViewerAnnotationDisabled;

- (ZMVideoSDKAnnotationHelper* _Nullable)createAnnotationHelper:(NSView* _Nullable)view;

- (ZMVideoSDKErrors)destroyAnnotationHelper:(ZMVideoSDKAnnotationHelper* _Nonnull)helper;

- (ZMVideoSDKErrors)setAnnotationVanishingToolTime:(unsigned int)displayTime vanishingTime:(unsigned int)vanishingTime;

- (ZMVideoSDKErrors)getAnnotationVanishingToolTime:(unsigned int*)displayTime vanishingTime:(unsigned int*)vanishingTime;

- (ZMVideoSDKErrors)enablePlaySharingAudioRawdata:(BOOL)bPlay;

- (ZMVideoSDKErrors)startShareWithPreprocessing:(ZMVideoSDKSharePreprocessParam* _Nonnull)param sharePreprocessor:(id<ZMVideoSDKSharePreprocessor> _Nonnull)preprocessor;

- (ZMVideoSDKWhiteboardHelper* _Nullable)getWhiteboardHelper;
@end
NS_ASSUME_NONNULL_END