KSYAUAudioCapture.h
3.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
//
// KSYAUAudioCapture.h
// KSYStreamer
//
//
// Created by pengbin on 10/15/15.
// Copyright © 2015 ksyun. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <AVFoundation/AVFoundation.h>
/*!
* @abstract 音效类型
*/
typedef NS_ENUM(NSUInteger, KSYAudioEffectType){
/// 初始化时状态为空闲
KSYAudioEffectType_NONE = 0,
/// 大叔
KSYAudioEffectType_MALE,
/// 萝莉
KSYAudioEffectType_FEMALE,
/// 宏大
KSYAudioEffectType_HEROIC,
/// 机器人
KSYAudioEffectType_ROBOT,
};
/** 音频采集模块
1. 基于 AudioUnit 实现的低延时音频采集模块
2. 能够对采集的语音添加混响音效 (目前提供了4种类型的混响场景)
3. 能够将采集的声音低延时播放,帮助主播选择音效 (又称"耳返")
4. 采集的声音通过回调函数提供出来
注意: 当使用本模块时, 需要禁用KSYGPUCamera中的音频采集
*/
@interface KSYAUAudioCapture : NSObject
/** Start Audio capturing
@abstract 启动音频采集, 占据麦克风资源
@return 是否启动采集成功
*/
- (BOOL)startCapture;
/** 停止音频采集, 释放麦克风资源
*/
- (void)stopCapture;
/** 暂停音频采集(仍然占用麦克风资源) 停止回调音频数据
*/
- (BOOL)pauseCapture;
/** 暂停音频采集(仍然占用麦克风资源), 回调静音音频数据
*/
- (BOOL)pauseWithMuteData;
/** 恢复正常音频采集和回调
*/
- (BOOL)resumeCapture;
/**
@abstract 是否播放采集的声音 (又称"耳返")
@warning 如果在没有插入耳机的情况下启动, 容易出现很刺耳的声音
*/
@property(nonatomic, assign) BOOL bPlayCapturedAudio;
/**
@abstract 是否使用带回声消除的采集模块(默认为NO)
@discussion 请在连麦开始时在设置此属性为YES, 连麦结束记得设置为NO
@discussion 此属性为YES时, 启动采集一定会打断其他音乐播放
*/
@property(nonatomic, assign) BOOL enableVoiceProcess;
/**
@abstract 是否强制设置AVAudioSession的类别为PlayAndRecord(默认为YES)
@discussion 此属性为YES时, 每次启动采集会将类别强制设置为AVAudioSessionCategoryPlayAndRecord
@discussion 为了避免别APP中的其他SDK将AVAudioSession的类别修改为无法录音,导致无法采集到声音
*/
@property(nonatomic, assign) BOOL bForceAudioSessionCatogary;
/**
@abstract 设置mic采集的声音音量
@discussion 调整范围 0.0~1.0
*/
@property(nonatomic, assign) Float32 micVolume;
/** 最近一次输出的音频包的时间戳*/
@property(nonatomic, readonly) CMTime outputPts;
/**
@abstract 混响类型
@discussion 目前提供了4种类型的混响场景, type和场景的对应关系如下
- 0 关闭
- 1 录音棚
- 2 ktv
- 3 小舞台
- 4 演唱会
*/
@property(nonatomic, assign) int reverbType;
/**
@abstract 音效类型
@discussion 音效类型仅在enableVoiceProcess=NO时有效
*/
@property(nonatomic, assign) KSYAudioEffectType effectType;
/**
@abstract 采集数据输出回调函数
@discussion sampleBuffer 为采集到的音频数据
*/
@property(nonatomic, copy) void(^audioProcessingCallback)(CMSampleBufferRef sampleBuffer);
/**
@abstract 用户可以自定义播放的内容，直接把数据填入ioData
@discussion ioData 目前只支持int16 的单声道数据
*/
@property(nonatomic, copy) void(^customPlayCallback)(AudioBufferList *ioData, UInt32 inumber);
/**
@abstract 是否有耳机麦克风可用
@return 是/否有耳机麦克风
*/
+ (BOOL)isHeadsetPluggedIn;
@end