zoom-video-sdk-demo/Sample/sdk/mac/ZoomVideoSDK/ZMVideoSDK.framework/Versions/A/Headers/ZMVideoSDKAudioHelper.h

#import <Foundation/Foundation.h>
#import "ZMVideoSDKUserHelper.h"

NS_ASSUME_NONNULL_BEGIN

/**
 @brief Audio raw data interface.
 */
@interface ZMVideoSDKAudioRawData : NSObject

/**
 @brief Buffer data.
 */
@property (nonatomic, assign, readonly) char* buffer;

/**
 @brief Buffer length of this data.
 */
@property (nonatomic, assign, readonly) unsigned int bufferLen;

/**
 @brief Sample rate of this data.
 */
@property (nonatomic, assign, readonly) unsigned int sampleRate;

/**
 @brief Channel number of this data.
 */
@property (nonatomic, assign, readonly) unsigned int channelNum;

/**
 @brief Determine if the reference count for the interface pointer can be increased.
 @note If you call addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef to release it.
 @return If can add reference, it will return YES, otherwise NO.
 */
-(BOOL)canAddRef;

/**
 @brief Add one to the reference count.
 @return If the function succeeds, it will return YES, otherwise NO.
 */
-(BOOL)addRef;

/**
 @brief Subtract one from the reference count.
 @return If the function succeeds, it will return reference count of this object.
 */
-(int)releaseRef;

@end


/**
 @brief Speaker device interface.
 */
@interface ZMVideoSDKSpeakerDevice : NSObject
    
/**
 @brief Device id.
 */
@property (nonatomic, copy, readonly) NSString *deviceId;
    
/**
 @brief Device name.
 */
@property (nonatomic, copy, readonly) NSString *deviceName;
    
/**
 @brief Determine if the device is selected.
 */
@property (nonatomic, assign, readonly) BOOL isSelectedDevice;
@end


/**
 @brief Mic device interface.
 */
@interface ZMVideoSDKMicDevice : NSObject
    
/**
 @brief Device id.
 */
@property (nonatomic, copy, readonly) NSString *deviceId;
    
/**
 @brief Device name.
 */
@property (nonatomic, copy, readonly) NSString *deviceName;
    
/**
 @brief Determine if the device is selected.
 */
@property (nonatomic, assign, readonly) BOOL isSelectedDevice;
@end

/**
 @brief Audio helper interface.
 */
@interface ZMVideoSDKAudioHelper : NSObject
    
/**
 @brief Start audio with voip.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)startAudio;
    
/**
 @brief Stop audio.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)stopAudio;
    
/**
 @brief Mute user's voip audio. 0 means current user (myself).
 @param user The pointer of user object.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)muteAudio:(ZMVideoSDKUser*)user;
    
/**
 @brief UnMute user's voip audio.
 @param user The pointer of user object.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)unMuteAudio:(ZMVideoSDKUser*)user;
    
/**
 @brief Get speaker device list.
 @return If the function succeeds, the return value is speaker device list, otherwise returns nil.
 */
-(NSArray<ZMVideoSDKSpeakerDevice *>*)getSpeakerList;
    
/**
 @brief Get mic device list.
 @return If the function succeeds, the return value is mic device list, otherwise returns nil.
 */
-(NSArray<ZMVideoSDKMicDevice *>*)getMicList;
    
/**
 @brief Select one speaker device as default device.
 @param deviceId Device id.
 @param name Device name.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)selectSpeaker:(NSString *)deviceId deviceName:(NSString *)name;
    
/**
 @brief Select one mic device as default device.
 @param deviceId Device id.
 @param name Device name.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)selectMic:(NSString *)deviceId deviceName:(NSString *)name;
    
/**
 @brief Subscribe audio raw data.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)subscribe;
    
/**
 @brief UnSubscribe audio raw data.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
-(ZMVideoSDKErrors)unSubscribe;
@end

NS_ASSUME_NONNULL_END