Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDK.h
Go to the documentation of this file.
1
8
9#import <Foundation/Foundation.h>
10#import <ZMVideoSDK/ZMVideoSDKDelegate.h>
11#import <ZMVideoSDK/ZMVideoSDKAudioHelper.h>
12#import <ZMVideoSDK/ZMVideoSDKVideoHelper.h>
13#import <ZMVideoSDK/ZMVideoSDKUserHelper.h>
14#import <ZMVideoSDK/ZMVideoSDKShareHelper.h>
15#import <ZMVideoSDK/ZMVideoSDKLiveStreamHelper.h>
16#import <ZMVideoSDK/ZMVideoSDKChatHelper.h>
17#import <ZMVideoSDK/ZMVideoSDKSession.h>
18#import <ZMVideoSDK/ZMVideoSDKVideoSourceHelper.h>
19#import <ZMVideoSDK/ZMVideoSDKAudioSendRawdata.h>
20#import <ZMVideoSDK/ZMVideoSDKChatMessage.h>
21#import <ZMVideoSDK/ZMVideoSDKPasswordHandler.h>
22#import <ZMVideoSDK/ZMVideoSDKRecordingHelper.h>
23#import <ZMVideoSDK/ZMVideoSDKPhoneHelper.h>
24#import <ZMVideoSDK/ZMVideoSDKCmdChannel.h>
25#import <ZMVideoSDK/ZMVideoSDKAudioSettingHelper.h>
26#import <ZMVideoSDK/ZMVideoSDKNetworkConnectionHelper.h>
27#import <ZMVideoSDK/ZMVideoSDKRecordingConsentHandler.h>
28#import <ZMVideoSDK/ZMVideoSDKVideoSettingHelper.h>
29#import <ZMVideoSDK/ZMVideoSDKShareSettingHelper.h>
30#import <ZMVideoSDK/ZMVideoSDKVideoCanvas.h>
31#import <ZMVideoSDK/ZMVideoSDKCRCHelper.h>
32#import <ZMVideoSDK/ZMVideoSDKAnnotationHelper.h>
33#import <ZMVideoSDK/ZMVideoSDKLiveTranscriptionHelper.h>
34#import <ZMVideoSDK/ZMVideoSDKVoiceInterpretationHelper.h>
35#import <ZMVideoSDK/ZMVideoSDKSubSessionHelper.h>
36#import <ZMVideoSDK/ZMVideoSDKBroadcastStreamingController.h>
37#import <ZMVideoSDK/ZMVideoSDKBroadcastStreamingViewer.h>
38#import <ZMVideoSDK/ZMVideoSDKEmojiReactionHelper.h>
39#import <ZMVideoSDK/ZMVideoSDKOnHoldHelper.h>
40#import <ZMVideoSDK/ZMVideoSDKRTMSHelper.h>
41
42NS_ASSUME_NONNULL_BEGIN
44
49@interface ZMVideoSDKInitParams : NSObject
53@property (nonatomic, retain, readwrite, nullable) NSString* domain;
54
58@property (nonatomic, retain, readwrite, nullable) NSString* logFilePrefix;
59
63@property (nonatomic, assign, readwrite) BOOL enableLog;
64
68@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode audioRawDataMemoryMode;
69
73@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode videoRawDataMemoryMode;
74
78@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode shareRawDataMemoryMode;
79
83@property (retain, nonatomic, nullable) ZMVideoSDKExtendParams *extendParams;
84@end
85
90@interface ZMVideoSDKExtendParams : NSObject
95@property (nonatomic, copy, nullable) NSString *speakerTestFilePath;
96
100@property (nonatomic, assign, readwrite) int wrapperType;
101
105@property (nonatomic, assign, readwrite) ZMVideoSDKPreferVideoResolution preferVideoResolution;
106
110@property (nonatomic, assign, readwrite) BOOL disableKeychainAccess;
111@end
112
113
118@interface ZMVideoSDKVideoOption : NSObject
122@property (nonatomic, assign, readwrite) BOOL localVideoOn;
123@end
124
129@interface ZMVideoSDKAudioOption : NSObject
133@property (nonatomic, assign, readwrite) BOOL connect;
134
138@property (nonatomic, assign, readwrite) BOOL mute;
139
143@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
144
148@property (nonatomic, assign, readwrite) BOOL autoAdjustSpeakerVolume;
149
150@end
151
156@interface ZMVideoSDKSessionContext : NSObject
157
161@property (nonatomic, retain, readwrite, nullable) NSString* sessionName;
162
166@property (nonatomic, retain, readwrite, nullable) NSString* sessionPassword;
167
171@property (nonatomic, retain, readwrite, nullable) NSString* userName;
172
176@property (nonatomic, retain, readwrite, nullable) NSString* token;
177
181@property (nonatomic, retain, readwrite, nullable) ZMVideoSDKVideoOption* videoOption;
182
186@property (nonatomic, retain, readwrite, nullable) ZMVideoSDKAudioOption* audioOption;
187
191@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSourcePreProcessor> preProcessor;
195@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSource> externalVideoSource;
199@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioMic> virtualAudioMic;
203@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioSpeaker> virtualAudioSpeaker;
209@property (nonatomic, assign, readwrite) unsigned int sessionIdleTimeoutMins;
213@property (nonatomic, assign, readwrite) BOOL autoLoadMutliStream;
218@property (nonatomic, assign, readwrite) ZMVideoSDKFrameDataFormat externalVideoSourceDataFormat;
219@end
220
226@interface ZMVideoSDKPreJoinParam : NSObject
230@property (nonatomic, assign) NSUInteger timeoutInterval;
231@end
232
233
238@interface ZMVideoSDK : NSObject
239
245
252
260
265- (void)addListener:(id <ZMVideoSDKDelegate>)listener;
266
271- (void)removeListener:(id <ZMVideoSDKDelegate>)listener;
272
278- (ZMVideoSDKSession* _Nullable)joinSession:(ZMVideoSDKSessionContext*)params;
279
287- (ZMVideoSDKSession* _Nullable)prepareJoin:(ZMVideoSDKSessionContext*)params preJoinParam:(ZMVideoSDKPreJoinParam*)preJoinParam;
288
295
301
307- (ZMVideoSDKErrors)leaveSession:(BOOL)end;
308
314
320
325- (NSString* _Nullable)getSDKVersion;
326
331- (NSString* _Nullable)exportLog;
332
338
344
350
356
362
368
374
380
386
392
398
404
410
416
422
428
434
440
446
453
459
465
471
477
483@end
484NS_ASSUME_NONNULL_END
ZMVideoSDKRawDataMemoryMode
Enumeration of memory modes for raw data handling.
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
ZMVideoSDKFrameDataFormat
Enumeration of raw data formats. Defines the color space format and color range for video frames.
ZMVideoSDKPreferVideoResolution
Enumeration of preferred video resolution in Zoom Video SDK.
Interface for testing audio input and output devices.
Provides methods for managing audio in Zoom Video SDK sessions.
Audio configuration options for joining a session.
Definition ZMVideoSDK.h:130
BOOL autoAdjustSpeakerVolume
Whether to automatically adjust the speaker's volume or not. If YES, this automaticallies adjust the ...
Definition ZMVideoSDK.h:148
BOOL connect
Whether to connect local audio or not.
Definition ZMVideoSDK.h:133
BOOL isMyVoiceInMix
Determines whether my voice is in the mixed audio raw data or not. YES to include....
Definition ZMVideoSDK.h:143
BOOL mute
Whether to mute audio or not.
Definition ZMVideoSDK.h:138
Interface for managing audio settings in Zoom Video SDK.
Helper interface for Cloud Room Connector (CRC) features.
Chat helper interface.
The command channel allows users to send commands or data (such as plain text or a binary encoded int...
Emoji reaction helper interface for sending emoji reactions in a session.
Extended configuration parameters for Zoom Video SDK.
Definition ZMVideoSDK.h:91
ZMVideoSDKPreferVideoResolution preferVideoResolution
Prefer video resolution.
Definition ZMVideoSDK.h:105
NSString * speakerTestFilePath
Specify a file path for speaker test.
Definition ZMVideoSDK.h:95
BOOL disableKeychainAccess
Disable access keychain.
Definition ZMVideoSDK.h:110
int wrapperType
Wrapper type.
Definition ZMVideoSDK.h:100
Zoom Video SDK API manager. Main singleton object that controls the video session creation,...
Definition ZMVideoSDK.h:239
ZMVideoSDKShareSettingHelper * getShareSettingHelper()
Gets share setting helper object.
ZMVideoSDKErrors cleanUp()
Clean up the Zoom Video SDK.
ZMVideoSDKAudioDeviceTestHelper * getAudioDeviceTestHelper()
Returns an instance to manage audio device test during or before a video SDK session.
ZMVideoSDKNetworkConnectionHelper * getNetworkConnectionHelper()
Returns an instance to manage network connection during or before a video SDK session.
NSString *_Nullable getSDKVersion()
Returns Zoom SDK internal version.
ZMVideoSDKRTMSHelper *_Nullable getRealTimeMediaStreamsHelper()
Returns an instance to manage RTMS (Real-Time Media Streams) during a video SDK session.
ZMVideoSDKErrors cleanAllExportedLogs()
Cleans all exported logs.
ZMVideoSDKEmojiReactionHelper *_Nullable getEmojiReactionHelper()
Gets the emoji reaction helper object.
ZMVideoSDKCRCHelper * getCRCHelper()
Gets crc helper object.
BOOL isInSession()
Checks if there is an active session between participants.
ZMVideoSDKUserHelper * getUserHelper()
Returns an instance to manage users present in a video SDK session.
ZMVideoSDKVideoSettingHelper * getVideoSettingHelper()
Gets video setting helper object.
ZMVideoSDKChatHelper * getChatHelper()
Returns an instance to send and receive chat messages within video SDK session participants.
ZMVideoSDKSession *_Nullable getSessionInfo()
Returns the current session information.
NSString *_Nullable exportLog()
Exports a log file to local disk.
ZMVideoSDKLiveTranscriptionHelper * getLiveTranscriptionHelper()
Gets live transcription helper object.
ZMVideoSDKSubSessionHelper *_Nullable getSubSessionHelper()
Gets the subsession helper object.
ZMVideoSDKBroadcastStreamingViewer *_Nullable getBroadcastStreamingViewer()
Gets the broadcast streaming viewer object.
ZMVideoSDKOnHoldHelper *_Nullable getOnHoldHelper()
Gets the OnHold helper.
ZMVideoSDK * sharedVideoSDK()
Returns ZMVideoSDK instance.
ZMVideoSDKAudioSettingHelper * getAudioSettingHelper()
Returns an instance to manage audio setting during or before a video SDK session.
ZMVideoSDKRecordingHelper * getRecordingHelper()
Returns an instance to manage cloud recordings during a video SDK session.
ZMVideoSDKVideoHelper * getVideoHelper()
Returns an instance to manage cameras and video during a video SDK session.
ZMVideoSDKPhoneHelper * getPhoneHelper()
Returns an instance to manage phone invitations during a video SDK session.
ZMVideoSDKVoiceInterpretationHelper * getVoiceInterpretationHelper()
Gets voice interpretation helper object.
ZMVideoSDKErrors commitJoin()
Confirms the join after prepareJoin:preJoinParam:. Valid in the two-step join flow.
ZMVideoSDKShareHelper * getShareHelper()
Returns an instance to manage screen sharing during a video SDK session.
ZMVideoSDKAudioHelper * getAudioHelper()
Returns an instance to manage audio controls related to the current video SDK session.
ZMVideoSDKIncomingLiveStreamHelper * getIncomingLiveStreamHelper()
Gets incoming live stream helper object.
ZMVideoSDKLiveStreamHelper * getLiveStreamHelper()
Returns an instance to manage live streaming during a video SDK session.
ZMVideoSDKBroadcastStreamingController *_Nullable getBroadcastStreamingController()
Gets the broadcast streaming controller object.
ZMVideoSDKCmdChannel * getCmdChannel()
Returns an instance to use command channel features during a video SDK session.
ZMVideoSDKErrors cancelPrepareJoin()
Cancels the prepare join. Valid in the two-step join flow.
Interface for managing incoming live streams.
Initialization parameters for Zoom Video SDK.
Definition ZMVideoSDK.h:50
ZMVideoSDKExtendParams * extendParams
Extended parameters.
Definition ZMVideoSDK.h:83
NSString * logFilePrefix
Prefix of log file name.
Definition ZMVideoSDK.h:58
ZMVideoSDKRawDataMemoryMode shareRawDataMemoryMode
Sets share raw data memory mode.
Definition ZMVideoSDK.h:78
BOOL enableLog
Sets whether to enable default log of which the capacity is less than 5M.
Definition ZMVideoSDK.h:63
ZMVideoSDKRawDataMemoryMode audioRawDataMemoryMode
Sets audio raw data memory mode.
Definition ZMVideoSDK.h:68
ZMVideoSDKRawDataMemoryMode videoRawDataMemoryMode
Sets video raw data memory mode.
Definition ZMVideoSDK.h:73
NSString * domain
Sets client domain of ZOOM Video SDK.
Definition ZMVideoSDK.h:53
Helper class for managing outgoing live stream.
Provides methods for controlling and interacting with live transcription.
A helper class for configuring proxy settings for SDK network connections.
Provides methods for managing phone-related session features such as dial-in and phone invites.
Pre-join parameters for the two-step join flow.
Definition ZMVideoSDK.h:227
NSUInteger timeoutInterval
The prepare join wait time in seconds. 0 uses the SDK default.
Definition ZMVideoSDK.h:230
Helper class for managing real-time media streams.
Helper class for using cloud recording in the session.
Session context information for a Zoom Video SDK session.
Definition ZMVideoSDK.h:157
id< ZMVideoSDKVideoSourcePreProcessor > preProcessor
Sets delegate. (optional).
Definition ZMVideoSDK.h:191
ZMVideoSDKVideoOption * videoOption
Video option.
Definition ZMVideoSDK.h:181
id< ZMVideoSDKVirtualAudioMic > virtualAudioMic
Sets virtual audio delegate (optional).
Definition ZMVideoSDK.h:199
NSString * userName
User name(required).
Definition ZMVideoSDK.h:171
NSString * sessionName
Session name.
Definition ZMVideoSDK.h:161
id< ZMVideoSDKVideoSource > externalVideoSource
Sets delegate (optional).
Definition ZMVideoSDK.h:195
NSString * sessionPassword
Session password (optional).
Definition ZMVideoSDK.h:166
NSString * token
JWT token to join session.
Definition ZMVideoSDK.h:176
ZMVideoSDKFrameDataFormat externalVideoSourceDataFormat
[Optional] The frame data format used for external video source initialization.
Definition ZMVideoSDK.h:218
unsigned int sessionIdleTimeoutMins
[Optional] The amount of time in minutes after which an idle session ends.
Definition ZMVideoSDK.h:209
id< ZMVideoSDKVirtualAudioSpeaker > virtualAudioSpeaker
Sets virtual audio speaker delegate (optional).
Definition ZMVideoSDK.h:203
ZMVideoSDKAudioOption * audioOption
Audio option.
Definition ZMVideoSDK.h:186
BOOL autoLoadMutliStream
Whether to automatically load multi streams when entering a session, default value is YES,...
Definition ZMVideoSDK.h:213
Provides access to session-level information and operations.
Main helper class managing sharing.
Helper class to manage share-related settings.
Helper class for managing subsessions.
User control interface.
An interface to control video and manage cameras during a video session.
Video configuration options for joining a session.
Definition ZMVideoSDK.h:119
BOOL localVideoOn
Sets local video on or off.
Definition ZMVideoSDK.h:122
Provides settings-related functions to configure video enhancement options.
Provides methods for controlling and interacting with voice interpretation.