Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKAudioHelper.h
Go to the documentation of this file.
1
7#import <Foundation/Foundation.h>
8#import <ZMVideoSDK/ZMVideoSDKUserHelper.h>
9
10NS_ASSUME_NONNULL_BEGIN
11
16@interface ZMVideoSDKAudioRawData : NSObject
17
21@property (nonatomic, assign, readonly, nullable) char* buffer;
22
26@property (nonatomic, assign, readonly) unsigned int bufferLen;
27
31@property (nonatomic, assign, readonly) unsigned int sampleRate;
32
36@property (nonatomic, assign, readonly) unsigned int channelNum;
40@property (nonatomic, assign, readonly) long long timeStamp;
46- (BOOL)canAddRef;
47
52- (BOOL)addRef;
53
58- (int)releaseRef;
59
60@end
61
62
67@interface ZMVideoSDKSpeakerDevice : NSObject
68
72@property (nonatomic, copy, readonly) NSString *deviceId;
73
77@property (nonatomic, copy, readonly) NSString *deviceName;
78
82@property (nonatomic, assign, readonly) BOOL isSelectedDevice;
83@end
84
85
90@interface ZMVideoSDKMicDevice : NSObject
91
95@property (nonatomic, copy, readonly) NSString *deviceId;
96
100@property (nonatomic, copy, readonly) NSString *deviceName;
101
105@property (nonatomic, assign, readonly) BOOL isSelectedDevice;
106@end
107
112@interface ZMVideoSDKAudioHelper : NSObject
113
118- (ZMVideoSDKErrors)startAudio;
119
124- (ZMVideoSDKErrors)stopAudio;
125
131- (ZMVideoSDKErrors)muteAudio:(ZMVideoSDKUser*)user;
132
138- (ZMVideoSDKErrors)unMuteAudio:(ZMVideoSDKUser*)user;
139
145- (ZMVideoSDKErrors)allowAudioUnmutedBySelf:(BOOL)allowUnmute;
146
152- (ZMVideoSDKErrors)muteAllAudio:(BOOL)allowUnmute;
153
158- (ZMVideoSDKErrors)unmuteAllAudio;
159
164- (NSArray<ZMVideoSDKSpeakerDevice *>* _Nullable)getSpeakerList;
165
170- (NSArray<ZMVideoSDKMicDevice *>* _Nullable)getMicList;
171
178- (ZMVideoSDKErrors)selectSpeaker:(NSString *)deviceId deviceName:(NSString *)name;
179
186- (ZMVideoSDKErrors)selectMic:(NSString *)deviceId deviceName:(NSString *)name;
187
192- (ZMVideoSDKErrors)subscribe;
193
198- (ZMVideoSDKErrors)unSubscribe;
199@end
200
201NS_ASSUME_NONNULL_END
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
Provides methods for managing audio in Zoom Video SDK sessions.
Represents raw audio data received from the SDK.
long long timeStamp
Millisecond timestamp.
unsigned int channelNum
Channel number of this data.
BOOL canAddRef()
Determine if the reference count for the interface pointer can be increased.
int releaseRef()
Subtract one from the reference count.
unsigned int sampleRate
Sample rate of this data.
BOOL addRef()
Add one to the reference count.
unsigned int bufferLen
Buffer length of this data.
Represents a microphone device available to the SDK.
Zoom Video SDK user information.