Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingAudioController.h
Go to the documentation of this file.
1//
2// ZoomSDKSettingAudioController.h
3// ZoomSDK
4//
5
6
7#import <Foundation/Foundation.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9NS_ASSUME_NONNULL_BEGIN
10
15@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
16@optional
21- (void)onMicLevelChanged:(unsigned int)level;
26- (void)onSpeakerLevelChanged:(unsigned int)level;
31- (void)onMicTestStatusChanged:(ZoomSDKTestMicStatus)status;
36- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
37@end
38
43@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
44@optional
49- (void)onMicDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
54- (void)onSpeakerDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
63@end
64
65
71{
72 id<ZoomSDKSettingTestAudioDelegate> _delegate;
74 NSString* _speakerID;
75}
79@property (nonatomic, readwrite, assign)BOOL isSpeakerInTesting;
80
84@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
85
91- (ZoomSDKError)SpeakerStartPlaying:(NSString*)deviceID;
97@end
98
104{
105 id<ZoomSDKSettingTestAudioDelegate> _delegate;
107 NSString* _microphoneID;
108}
112@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
118- (ZoomSDKError)startRecordingMic:(NSString*)deviceID;
139@end
140
141
146@interface ZoomSDKAudioSetting: NSObject
147{
150 id<ZoomSDKSettingAudioDeviceDelegate> _delegate;
151}
155@property(nonatomic, assign, nullable)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
171- (NSArray*_Nullable)getAudioDeviceList:(BOOL)mic;
172
178- (float)getAudioDeviceVolume:(BOOL)mic;
179
186- (ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(float)volume;
187
195- (ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
196
202- (ZoomSDKError)enableStero:(BOOL)enable;
203
209- (ZoomSDKError)enableAutoJoinVoip:(BOOL)enable;
210
216- (ZoomSDKError)enableMuteMicJoinVoip:(BOOL)enable;
222- (ZoomSDKError)enablePushToTalk:(BOOL)enable;
223
229- (ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
230
236
242
248- (ZoomSDKError)enableAutoAdjustMic:(BOOL)enable;
249
265
276
277
283- (ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
284
290
296
302- (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
313- (ZoomSDKError)enableEchoCancellation:(BOOL)enable;
314
320
326
332
338- (ZoomSDKError)setSuppressBackgroundNoise:(ZoomSDKSuppressBackgroundNoiseLevel)level;
339
345
351- (ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
352
357- (NSArray *_Nullable)getRingSpkDeviceList;
358
364
370- (ZoomSDKError)setRingSpkVolume:(float)value;
371
377- (ZoomSDKError)setRingSpkDevice:(NSString*)deviceId;
378
384- (ZoomSDKError)setSyncHeadsetButtonStatus:(BOOL)enable;
385
391
397- (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
398
404
410- (ZoomSDKError)selectSameAudioDeviceAsSystem:(BOOL)mic;
411@end
412NS_ASSUME_NONNULL_END
ZoomSDKSuppressBackgroundNoiseLevel
Enumeration of background noise suppression levels. For more information, please visit https://suppor...
ZoomSDKDeviceStatus
Enumeration of device status.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKTestMicStatus
Enumeration of microphone test types.
ZoomSDKAudioEchoCancellationLevel
Enumeration of echo cancellation. For more information, please visit https://support....
Provides APIs to manage audio devices, audio volumes, and audio-related meeting features.
id< ZoomSDKSettingAudioDeviceDelegate > delegate
Delegate to receive audio device status changes.
id< ZoomSDKSettingAudioDeviceDelegate > _delegate
BOOL isSyncHeadsetButtonStatus()
Determines if sync buttons on headset option on or off.
ZoomSDKAudioEchoCancellationLevel getEchoCancellationLevel()
Gets echo cancellation level.
BOOL isEnableStereoOn()
Determines if stereophonic sound is enabled.
BOOL isSupportShowOriginalSoundOptionInMeetingUI()
Determines if the meeting supports show original sound option in meeting UI.
BOOL isEchoCancellationOn()
Determines if echo cancellation is enabled or not.
BOOL isTemporarilyUnmuteOn()
Sets whether to enable the feature that attendee can speak by pressing the Spacebar when he is muted.
ZoomSDKSettingTestSpeakerDeviceHelper * _speakerTestHelper
BOOL isAutoAdjustMicOn()
Determines if auto-adjust microphone is enabled or not.
BOOL isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable()
Determines if the dialog pops up when user joins meeting with third party audio.
float getRingSpkVolume()
Gets the volume of audio device.
ZoomSDKSettingTestSpeakerDeviceHelper *_Nullable getSettingSpeakerTestHelper()
Gets the object of ZoomSDKSettingTestSpeakerDeviceHelper.
ZoomSDKSuppressBackgroundNoiseLevel getSuppressBackgroundNoiseLevel()
Gets the level of suppressed background noise.
BOOL isJoinAudioWhenJoinMeetingOn()
Determines if user joins meeting with audio on.
BOOL isAlwaysUseSeparateRingSpkOn()
Determines if used separate audio device to play ringtone simultaneously.
BOOL isMuteMicWhenJoinMeetingOn()
Determines if user joins meeting with microphone muted.
ZoomSDKSettingTestMicrophoneDeviceHelper *_Nullable getSettingMicrophoneTestHelper()
Gets the object of ZoomSDKSettingTestMicrophoneDeviceHelper.
NSArray *_Nullable getRingSpkDeviceList()
Gets use separate audio device to play ringtone simultaneously devices.
BOOL isHighFideMusicMode()
Determines if use high fidelity music model.
BOOL isShowOriginalSoundOptionInMeetingUIOn()
Determines if show original sound option in meeting UI is enabled or not.
BOOL isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio()
Determines if the meeting supports to pop up the dialog when user joins meeting with third party audi...
ZoomSDKSettingTestMicrophoneDeviceHelper * _micTestHelper
BOOL isSupportEchoCancellation()
Determines if the meeting supports echo cancellation.
Helper class for testing microphone devices.
ZoomSDKError stopRecrodingMic()
Stops recording when testing microphone.
id< ZoomSDKSettingTestAudioDelegate > delegate
Delegate to receive audio testing events.
id< ZoomSDKSettingTestAudioDelegate > _delegate
ZoomSDKError stopPlayRecordedMic()
Stops playing recorded sounds when testing microphone.
ZoomSDKTestMicStatus getTestMicStatus()
Gets the status when testing microphone.
ZoomSDKError playRecordedMic()
Plays recorded sounds when testing microphone.
Helper class to test speaker devices.
id< ZoomSDKSettingTestAudioDelegate > delegate
Delegate to receive audio testing events.
BOOL isSpeakerInTesting
Indicates whether speaker testing is in progress.
ZoomSDKError SpeakerStopPlaying()
Stops playing when testing speaker.
id< ZoomSDKSettingTestAudioDelegate > _delegate
void onSelectedSpeakerDeviceChanged()
Notification that the selected speaker device is changed.
void onSelectedMicDeviceChanged()
Notification that the selected microphone device is changed.