zdk.objc
ZDKAudioEndpointControl.h
1//
2// ZDKAudioEndpointControl.h
3// ZDK
4//
5
6#ifndef ZDKAudioEndpointControl_h
7#define ZDKAudioEndpointControl_h
8
9#import <Foundation/Foundation.h>
10#import "ZDKAudioRoutingEndpoint.h"
11#import "ZDKEchoCancellationType.h"
12#import "ZDKAudioSourcePresetType.h"
13#import "ZDKAudioDevice.h"
14#import "ZDKAutomaticGainControlType.h"
15#import "ZDKHostAPI.h"
16#import "ZDKAudioResampler.h"
17#import "ZDKAudioFileFormat.h"
18#import "ZDKSound.h"
19#import "ZDKAudioOutputDeviceType.h"
20#import "ZDKAudioEventsHandler.h"
21#import "ZDKResult.h"
22#import "ZDKZHandle.h"
23#import "ZDKAudioDevice.h"
24@protocol ZDKAudioDevice;
25#import "ZDKSound.h"
26@protocol ZDKSound;
27#import "ZDKAudioEventsHandler.h"
28@protocol ZDKAudioEventsHandler;
29#import "ZDKResult.h"
30@protocol ZDKResult;
31
32NS_ASSUME_NONNULL_BEGIN
33
39
48@property(nonatomic) ZDKAudioRoutingEndpoint audioEndpoint;
49
58@property(nonatomic) double micLevel;
59
71@property(nonatomic) double outputLevel;
72
84@property(nonatomic) double ringLevel;
85
94@property(nonatomic) ZDKEchoCancellationType echoCancellation;
95
105@property(nonatomic) BOOL highPassFilter;
106
119@property(nonatomic) float preAmplifier;
120
130@property(nonatomic) BOOL noiseSuppression;
131
140@property(nonatomic) ZDKAudioSourcePresetType audioSourcePreset;
141
148@property(nonatomic, readonly) NSArray<id<ZDKAudioDevice>>* audioDevices;
149
159@property(nonatomic) BOOL micBoost;
160
177@property(nonatomic) BOOL enableFixedSpeakerGain;
178
209@property(nonatomic) double fixedSpeakerGain;
210
224-(ZDKAutomaticGainControlType)getAutomaticGainControlMode;
252-(id<ZDKResult>)setAutomaticGainControlMode:(ZDKAutomaticGainControlType)type gain:(float)gain ;
261-(id<ZDKResult>)hostApi:(ZDKHostAPI)value ;
277-(id<ZDKResult>)resampler:(ZDKAudioResampler)value ;
286-(id<ZDKAudioDevice> _Nullable)getDeviceByName:(NSString*)name ;
301-(id<ZDKResult>)setCurrentInputDevice:(id<ZDKAudioDevice>)device ;
316-(id<ZDKResult>)setCurrentOutputDevice:(id<ZDKAudioDevice>)device ;
331-(id<ZDKResult>)setCurrentRingDevice:(id<ZDKAudioDevice>)device ;
350-(id<ZDKSound> _Nullable)addSoundFromMemory:(unsigned char*)data length:(int)length sampleLen:(int)sampleLen frequency:(int)frequency repeat:(BOOL)repeat pauseMs:(int)pauseMs ;
370-(id<ZDKSound> _Nullable)addSoundFromFile:(NSString*)filePath fileFormat:(ZDKAudioFileFormat)fileFormat repeat:(BOOL)repeat pauseMs:(int)pauseMs ;
384-(id<ZDKResult>)startSound:(id<ZDKSound>)sound outputType:(ZDKAudioOutputDeviceType)outputType ;
396-(id<ZDKResult>)stopSound:(id<ZDKSound>)sound outputType:(ZDKAudioOutputDeviceType)outputType ;
411-(id<ZDKResult>)startPlayback:(id<ZDKSound>)sound monitorDevice:(ZDKAudioOutputDeviceType)monitorDevice ;
437-(id<ZDKResult>)setCallRecordingNotifySound:(id<ZDKSound>)sound monitorDevice:(ZDKAudioOutputDeviceType)monitorDevice ;
448-(id<ZDKResult>)muteInput:(BOOL)value ;
459-(id<ZDKResult>)muteOutput:(BOOL)value ;
466-(void)addStatusListener:(id<ZDKAudioEventsHandler>)value ;
473-(void)dropStatusListener:(id<ZDKAudioEventsHandler>)value ;
474-(NSString*)handlesDescription;
475
476@end
477
478NS_ASSUME_NONNULL_END
479
480#endif
Audio device description.
Definition: ZDKAudioDevice.h:17
Audio endpoint's main entry point.
Definition: ZDKAudioEndpointControl.h:38
id< ZDKAudioDevice > _Nullable getCurrentRingDevice()
Gets the selected ringing audio device.
BOOL noiseSuppression
Controls the Noise Suppression filter.
Definition: ZDKAudioEndpointControl.h:130
ZDKAudioRoutingEndpoint audioEndpoint
Configures the audio routing endpoint to be used.
Definition: ZDKAudioEndpointControl.h:48
float getAutomaticGainControlGain()
Gets the configured Automatic Gain Control (AGC) fixed gain.
BOOL micBoost
Controls the microphone boost option.
Definition: ZDKAudioEndpointControl.h:159
float preAmplifier
Controls the Pre Amplifier.
Definition: ZDKAudioEndpointControl.h:119
double outputLevel
Configures the audio output level.
Definition: ZDKAudioEndpointControl.h:71
id< ZDKResult > stopPlayback()
Stops any playback.
id< ZDKAudioDevice > _Nullable getCurrentOutputDevice()
Gets the selected output audio device.
BOOL enableFixedSpeakerGain
Enables or disables the fixed gain on the audio output.
Definition: ZDKAudioEndpointControl.h:177
ZDKAutomaticGainControlType getAutomaticGainControlMode()
Gets the configured Automatic Gain Control (AGC) filter working mode.
BOOL highPassFilter
Controls the High Pass filter.
Definition: ZDKAudioEndpointControl.h:105
double ringLevel
Configures the audio ringing level.
Definition: ZDKAudioEndpointControl.h:84
NSArray< id< ZDKAudioDevice > > * audioDevices
Gets a list with all available audio devices.
Definition: ZDKAudioEndpointControl.h:148
double fixedSpeakerGain
Configures the fixed gain on the audio output.
Definition: ZDKAudioEndpointControl.h:209
id< ZDKAudioDevice > _Nullable getCurrentInputDevice()
Gets the selected input audio device.
ZDKAudioSourcePresetType audioSourcePreset
Configures the Audio Source Recorder Preset.
Definition: ZDKAudioEndpointControl.h:140
ZDKEchoCancellationType echoCancellation
Configures the acoustic echo cancellation working mode.
Definition: ZDKAudioEndpointControl.h:94
double micLevel
Configures the audio input/microphone level.
Definition: ZDKAudioEndpointControl.h:58
Definition: ZDKAudioEventsHandler.h:18
API invocation status result.
Definition: ZDKResult.h:19
ZDK Sound description.
Definition: ZDKSound.h:16
Definition: ZDKZHandle.h:13