diff --git a/docs/reference/_audio_stream_8h_source.html b/docs/reference/_audio_stream_8h_source.html deleted file mode 100644 index 458f30204..000000000 --- a/docs/reference/_audio_stream_8h_source.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - -Oboe: include/oboe/AudioStream.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
AudioStream.h
-
-
-
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_H_
18 #define OBOE_STREAM_H_
19 
20 #include <cstdint>
21 #include <ctime>
22 #include "oboe/Definitions.h"
23 #include "oboe/ResultWithValue.h"
24 #include "oboe/AudioStreamBuilder.h"
25 #include "oboe/AudioStreamBase.h"
26 
29 namespace oboe {
30 
31 constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond);
32 
36 class AudioStream : public AudioStreamBase {
37 public:
38 
39  AudioStream() {}
40  explicit AudioStream(const AudioStreamBuilder &builder);
41 
42  virtual ~AudioStream() = default;
43 
52  virtual Result open();
53 
57  virtual Result close() = 0;
58 
59  /*
60  * These are synchronous and will block until the operation is complete.
61  */
62  virtual Result start(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
63  virtual Result pause(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
64  virtual Result flush(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
65  virtual Result stop(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
66 
67  /* Asynchronous requests.
68  * Use waitForStateChange() if you need to wait for completion.
69  */
70  virtual Result requestStart() = 0;
71  virtual Result requestPause() = 0;
72  virtual Result requestFlush() = 0;
73  virtual Result requestStop() = 0;
74 
80  virtual StreamState getState() = 0;
81 
106  virtual Result waitForStateChange(StreamState inputState,
107  StreamState *nextState,
108  int64_t timeoutNanoseconds) = 0;
109 
122  virtual ResultWithValue<int32_t> setBufferSizeInFrames(int32_t requestedFrames) {
123  return Result::ErrorUnimplemented;
124  }
125 
138  virtual ResultWithValue<int32_t> getXRunCount() const {
139  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
140  }
141 
145  virtual bool isXRunCountSupported() const = 0;
146 
152  virtual int32_t getFramesPerBurst() = 0;
153 
154  bool isPlaying();
155 
156  int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); }
157 
158  int32_t getBytesPerSample() const;
159 
164  virtual int64_t getFramesWritten() { return mFramesWritten; }
165 
166  virtual int64_t getFramesRead() { return mFramesRead; }
167 
191  virtual ResultWithValue<double> calculateLatencyMillis() {
192  return ResultWithValue<double>(Result::ErrorUnimplemented);
193  }
194 
195  virtual Result getTimestamp(clockid_t clockId,
196  int64_t *framePosition,
197  int64_t *timeNanoseconds) {
198  return Result::ErrorUnimplemented;
199  }
200 
201  // ============== I/O ===========================
213  virtual ResultWithValue<int32_t> write(const void *buffer,
214  int32_t numFrames,
215  int64_t timeoutNanoseconds) {
216  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
217  }
218 
219  virtual ResultWithValue<int32_t> read(void *buffer,
220  int32_t numFrames,
221  int64_t timeoutNanoseconds) {
222  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
223  }
224 
229  virtual AudioApi getAudioApi() const = 0;
230 
234  bool usesAAudio() const {
235  return getAudioApi() == AudioApi::AAudio;
236  }
237 
246  virtual void *getUnderlyingStream() const {
247  return nullptr;
248  }
249 
250 protected:
251 
252  virtual int64_t incrementFramesWritten(int32_t frames) {
253  return mFramesWritten += frames;
254  }
255  virtual int64_t incrementFramesRead(int32_t frames) {
256  return mFramesRead += frames;
257  }
258 
265  virtual Result waitForStateTransition(StreamState startingState,
266  StreamState endingState,
267  int64_t timeoutNanoseconds);
268 
276  virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames) {
277  return DataCallbackResult::Stop;
278  }
279 
280  DataCallbackResult fireCallback(void *audioData, int numFrames);
281 
282  virtual void setNativeFormat(AudioFormat format) {
283  mNativeFormat = format;
284  }
285 
286  // TODO: make private
287  // These do not change after open.
288  AudioFormat mNativeFormat = AudioFormat::Invalid;
289 
290  // TODO these should be atomic like in AAudio
291  int64_t mFramesWritten = 0;
292  int64_t mFramesRead = 0;
293 
294 private:
295  // TODO these should be atomic like in AAudio
296  int mPreviousScheduler = -1;
297 };
298 
299 } // namespace oboe
300 
301 #endif /* OBOE_STREAM_H_ */
-
oboe::AudioStreamBuilder
Definition: AudioStreamBuilder.h:28
-
oboe::AudioStream::usesAAudio
bool usesAAudio() const
Definition: AudioStream.h:234
-
oboe::AudioStream::getXRunCount
virtual ResultWithValue< int32_t > getXRunCount() const
Definition: AudioStream.h:138
-
oboe::AudioStream::getUnderlyingStream
virtual void * getUnderlyingStream() const
Definition: AudioStream.h:246
-
oboe::AudioStream::getFramesWritten
virtual int64_t getFramesWritten()
Definition: AudioStream.h:164
-
oboe::AudioStream::close
virtual Result close()=0
-
oboe::AudioStream::setBufferSizeInFrames
virtual ResultWithValue< int32_t > setBufferSizeInFrames(int32_t requestedFrames)
Definition: AudioStream.h:122
-
oboe::AudioStream::getState
virtual StreamState getState()=0
-
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::AudioStream::waitForStateTransition
virtual Result waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
-
oboe::AudioStream::getFramesPerBurst
virtual int32_t getFramesPerBurst()=0
-
oboe::AudioStream::calculateLatencyMillis
virtual ResultWithValue< double > calculateLatencyMillis()
Definition: AudioStream.h:191
-
oboe::AudioStream::open
virtual Result open()
-
oboe::AudioStream
Definition: AudioStream.h:36
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::AudioStream::write
virtual ResultWithValue< int32_t > write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
Definition: AudioStream.h:213
-
oboe::AudioStream::onDefaultCallback
virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames)
Definition: AudioStream.h:276
-
oboe::AudioStream::getAudioApi
virtual AudioApi getAudioApi() const =0
-
oboe::AudioStream::waitForStateChange
virtual Result waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
-
oboe
Definition: AudioStream.h:29
-
oboe::AudioStream::isXRunCountSupported
virtual bool isXRunCountSupported() const =0
-
oboe::ResultWithValue
Definition: ResultWithValue.h:27
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_audio_stream_base_8h_source.html b/docs/reference/_audio_stream_base_8h_source.html deleted file mode 100644 index 6633e44bf..000000000 --- a/docs/reference/_audio_stream_base_8h_source.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - -Oboe: include/oboe/AudioStreamBase.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
AudioStreamBase.h
-
-
-
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BASE_H_
18 #define OBOE_STREAM_BASE_H_
19 
20 #include <memory>
21 #include "oboe/AudioStreamCallback.h"
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
34 class AudioStreamBase {
35 public:
36 
37  AudioStreamBase() {}
38 
39  virtual ~AudioStreamBase() = default;
40 
41  // This class only contains primitives so we can use default constructor and copy methods.
42  AudioStreamBase(const AudioStreamBase&) = default;
43 
44  AudioStreamBase& operator=(const AudioStreamBase&) = default;
45 
49  int getChannelCount() const { return mChannelCount; }
50 
54  Direction getDirection() const { return mDirection; }
55 
59  int32_t getSampleRate() const { return mSampleRate; }
60 
64  int getFramesPerCallback() const { return mFramesPerCallback; }
65 
70  AudioFormat getFormat() const { return mFormat; }
71 
78  virtual int32_t getBufferSizeInFrames() { return mBufferSizeInFrames; };
79 
83  virtual int32_t getBufferCapacityInFrames() const { return mBufferCapacityInFrames; }
84 
85  SharingMode getSharingMode() const { return mSharingMode; }
86 
87  PerformanceMode getPerformanceMode() const { return mPerformanceMode; }
88 
89  int32_t getDeviceId() const { return mDeviceId; }
90 
91  AudioStreamCallback* getCallback() const {
92  return mStreamCallback;
93  }
94 
95  Usage getUsage() const { return mUsage; }
96 
97  ContentType getContentType() const { return mContentType; }
98 
99  InputPreset getInputPreset() const { return mInputPreset; }
100 
101  SessionId getSessionId() const { return mSessionId; }
102 
103 protected:
104  AudioStreamCallback *mStreamCallback = nullptr;
105  int32_t mFramesPerCallback = kUnspecified;
106  int32_t mChannelCount = kUnspecified;
107  int32_t mSampleRate = kUnspecified;
108  int32_t mDeviceId = kUnspecified;
109  int32_t mBufferCapacityInFrames = kUnspecified;
110  int32_t mBufferSizeInFrames = kUnspecified;
111  int32_t mFramesPerBurst = kUnspecified;
112 
113  SharingMode mSharingMode = SharingMode::Shared;
114  AudioFormat mFormat = AudioFormat::Unspecified;
115  Direction mDirection = Direction::Output;
116  PerformanceMode mPerformanceMode = PerformanceMode::None;
117  // Added in API 28
118  Usage mUsage = Usage::Media;
119  ContentType mContentType = ContentType::Music;
120  InputPreset mInputPreset = InputPreset::VoiceRecognition;
121  SessionId mSessionId = SessionId::None;
122 };
123 
124 } // namespace oboe
125 
126 #endif /* OBOE_STREAM_BASE_H_ */
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
- -
oboe::AudioStreamBase::getFormat
AudioFormat getFormat() const
Definition: AudioStreamBase.h:70
-
oboe::AudioStreamBase::getSampleRate
int32_t getSampleRate() const
Definition: AudioStreamBase.h:59
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::AudioStreamBase::getBufferSizeInFrames
virtual int32_t getBufferSizeInFrames()
Definition: AudioStreamBase.h:78
-
oboe::AudioStreamBase::getChannelCount
int getChannelCount() const
Definition: AudioStreamBase.h:49
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
-
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
-
oboe::AudioStreamBase::getBufferCapacityInFrames
virtual int32_t getBufferCapacityInFrames() const
Definition: AudioStreamBase.h:83
-
oboe
Definition: AudioStream.h:29
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
-
oboe::AudioStreamBase::getDirection
Direction getDirection() const
Definition: AudioStreamBase.h:54
-
oboe::Usage
Usage
Definition: Definitions.h:174
-
oboe::AudioStreamBase::getFramesPerCallback
int getFramesPerCallback() const
Definition: AudioStreamBase.h:64
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_audio_stream_builder_8h_source.html b/docs/reference/_audio_stream_builder_8h_source.html deleted file mode 100644 index e3442449c..000000000 --- a/docs/reference/_audio_stream_builder_8h_source.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - -Oboe: include/oboe/AudioStreamBuilder.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
AudioStreamBuilder.h
-
-
-
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BUILDER_H_
18 #define OBOE_STREAM_BUILDER_H_
19 
20 #include "oboe/Definitions.h"
21 #include "oboe/AudioStreamBase.h"
22 
23 namespace oboe {
24 
28 class AudioStreamBuilder : public AudioStreamBase {
29 public:
30 
31  AudioStreamBuilder() : AudioStreamBase() {}
32 
39  AudioStreamBuilder *setChannelCount(int channelCount) {
40  mChannelCount = channelCount;
41  return this;
42  }
43 
49  AudioStreamBuilder *setDirection(Direction direction) {
50  mDirection = direction;
51  return this;
52  }
53 
65  AudioStreamBuilder *setSampleRate(int32_t sampleRate) {
66  mSampleRate = sampleRate;
67  return this;
68  }
69 
84  AudioStreamBuilder *setFramesPerCallback(int framesPerCallback) {
85  mFramesPerCallback = framesPerCallback;
86  return this;
87  }
88 
95  AudioStreamBuilder *setFormat(AudioFormat format) {
96  mFormat = format;
97  return this;
98  }
99 
109  AudioStreamBuilder *setBufferCapacityInFrames(int32_t bufferCapacityInFrames) {
110  mBufferCapacityInFrames = bufferCapacityInFrames;
111  return this;
112  }
113 
114  AudioApi getAudioApi() const { return mAudioApi; }
115 
125  AudioStreamBuilder *setAudioApi(AudioApi audioApi) {
126  mAudioApi = audioApi;
127  return this;
128  }
129 
137  static bool isAAudioSupported();
138 
146  static bool isAAudioRecommended();
147 
156  AudioStreamBuilder *setSharingMode(SharingMode sharingMode) {
157  mSharingMode = sharingMode;
158  return this;
159  }
160 
169  AudioStreamBuilder *setPerformanceMode(PerformanceMode performanceMode) {
170  mPerformanceMode = performanceMode;
171  return this;
172  }
173 
174 
187  AudioStreamBuilder *setUsage(Usage usage) {
188  mUsage = usage;
189  return this;
190  }
191 
204  AudioStreamBuilder *setContentType(ContentType contentType) {
205  mContentType = contentType;
206  return this;
207  }
208 
224  AudioStreamBuilder *setInputPreset(InputPreset inputPreset) {
225  mInputPreset = inputPreset;
226  return this;
227  }
228 
253  AudioStreamBuilder *setSessionId(SessionId sessionId) {
254  mSessionId = sessionId;
255  return this;
256  }
257 
270  AudioStreamBuilder *setDeviceId(int32_t deviceId) {
271  mDeviceId = deviceId;
272  return this;
273  }
274 
293  AudioStreamBuilder *setCallback(AudioStreamCallback *streamCallback) {
294  mStreamCallback = streamCallback;
295  return this;
296  }
297 
304  Result openStream(AudioStream **stream);
305 
306 protected:
307 
308 private:
309 
315  oboe::AudioStream *build();
316 
317  AudioApi mAudioApi = AudioApi::Unspecified;
318 };
319 
320 } // namespace oboe
321 
322 #endif /* OBOE_STREAM_BUILDER_H_ */
oboe::AudioStreamBuilder::setDeviceId
AudioStreamBuilder * setDeviceId(int32_t deviceId)
Definition: AudioStreamBuilder.h:270
-
oboe::AudioStreamBuilder
Definition: AudioStreamBuilder.h:28
-
oboe::AudioStreamBuilder::setPerformanceMode
AudioStreamBuilder * setPerformanceMode(PerformanceMode performanceMode)
Definition: AudioStreamBuilder.h:169
-
oboe::AudioStreamBuilder::isAAudioRecommended
static bool isAAudioRecommended()
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
-
oboe::AudioStreamBuilder::setSessionId
AudioStreamBuilder * setSessionId(SessionId sessionId)
Definition: AudioStreamBuilder.h:253
-
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:26
-
oboe::AudioStreamBuilder::setContentType
AudioStreamBuilder * setContentType(ContentType contentType)
Definition: AudioStreamBuilder.h:204
-
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::AudioStreamBuilder::setUsage
AudioStreamBuilder * setUsage(Usage usage)
Definition: AudioStreamBuilder.h:187
-
oboe::AudioStreamBuilder::isAAudioSupported
static bool isAAudioSupported()
-
oboe::AudioStreamBuilder::setFramesPerCallback
AudioStreamBuilder * setFramesPerCallback(int framesPerCallback)
Definition: AudioStreamBuilder.h:84
-
oboe::AudioStreamBuilder::setDirection
AudioStreamBuilder * setDirection(Direction direction)
Definition: AudioStreamBuilder.h:49
-
oboe::AudioStreamBuilder::setFormat
AudioStreamBuilder * setFormat(AudioFormat format)
Definition: AudioStreamBuilder.h:95
-
oboe::AudioStream
Definition: AudioStream.h:36
-
oboe::AudioStreamBuilder::setAudioApi
AudioStreamBuilder * setAudioApi(AudioApi audioApi)
Definition: AudioStreamBuilder.h:125
-
oboe::AudioStreamBuilder::setInputPreset
AudioStreamBuilder * setInputPreset(InputPreset inputPreset)
Definition: AudioStreamBuilder.h:224
-
oboe::AudioStreamBuilder::setSampleRate
AudioStreamBuilder * setSampleRate(int32_t sampleRate)
Definition: AudioStreamBuilder.h:65
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::AudioStreamBuilder::setBufferCapacityInFrames
AudioStreamBuilder * setBufferCapacityInFrames(int32_t bufferCapacityInFrames)
Definition: AudioStreamBuilder.h:109
-
oboe::AudioStreamBuilder::openStream
Result openStream(AudioStream **stream)
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
-
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
-
oboe::AudioStreamBuilder::setSharingMode
AudioStreamBuilder * setSharingMode(SharingMode sharingMode)
Definition: AudioStreamBuilder.h:156
-
oboe
Definition: AudioStream.h:29
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
-
oboe::AudioStreamBuilder::setChannelCount
AudioStreamBuilder * setChannelCount(int channelCount)
Definition: AudioStreamBuilder.h:39
-
oboe::AudioStreamBuilder::setCallback
AudioStreamBuilder * setCallback(AudioStreamCallback *streamCallback)
Definition: AudioStreamBuilder.h:293
-
oboe::Usage
Usage
Definition: Definitions.h:174
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_audio_stream_callback_8h_source.html b/docs/reference/_audio_stream_callback_8h_source.html deleted file mode 100644 index 919e4719f..000000000 --- a/docs/reference/_audio_stream_callback_8h_source.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - -Oboe: include/oboe/AudioStreamCallback.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
AudioStreamCallback.h
-
-
-
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_CALLBACK_H
18 #define OBOE_STREAM_CALLBACK_H
19 
20 #include "oboe/Definitions.h"
21 
22 namespace oboe {
23 
24 class AudioStream;
25 
26 class AudioStreamCallback {
27 public:
28  virtual ~AudioStreamCallback() = default;
29 
38  virtual DataCallbackResult onAudioReady(
39  AudioStream *oboeStream,
40  void *audioData,
41  int32_t numFrames) = 0;
42 
51  virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error) {}
52 
63  virtual void onErrorAfterClose(AudioStream *oboeStream, Result error) {}
64 
65 };
66 
67 } // namespace oboe
68 
69 #endif //OBOE_STREAM_CALLBACK_H
oboe::AudioStreamCallback::onErrorAfterClose
virtual void onErrorAfterClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:63
-
oboe::AudioStreamCallback::onErrorBeforeClose
virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:51
-
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:26
-
oboe::AudioStreamCallback::onAudioReady
virtual DataCallbackResult onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
-
oboe::AudioStream
Definition: AudioStream.h:36
-
oboe
Definition: AudioStream.h:29
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_definitions_8h_source.html b/docs/reference/_definitions_8h_source.html deleted file mode 100644 index 12caaed9a..000000000 --- a/docs/reference/_definitions_8h_source.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - -Oboe: include/oboe/Definitions.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Definitions.h
-
-
-
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_DEFINITIONS_H
18 #define OBOE_DEFINITIONS_H
19 
20 #include <cstdint>
21 #include <type_traits>
22 #include <aaudio/AAudio.h>
23 
24 // Ensure that all AAudio primitive data types are int32_t
25 #define ASSERT_INT32(type) static_assert(std::is_same<int32_t, type>::value, \
26 #type" must be int32_t")
27 
28 ASSERT_INT32(aaudio_stream_state_t);
29 ASSERT_INT32(aaudio_direction_t);
30 ASSERT_INT32(aaudio_format_t);
31 ASSERT_INT32(aaudio_data_callback_result_t);
32 ASSERT_INT32(aaudio_result_t);
33 ASSERT_INT32(aaudio_sharing_mode_t);
34 ASSERT_INT32(aaudio_performance_mode_t);
35 
36 namespace oboe {
37 
38  constexpr int32_t kUnspecified = 0;
39 
40  // TODO: Investigate using std::chrono
41  constexpr int64_t kNanosPerMicrosecond = 1000;
42  constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000;
43  constexpr int64_t kMillisPerSecond = 1000;
44  constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond;
45 
46  enum class StreamState : aaudio_stream_state_t {
47  Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED,
48  Unknown = AAUDIO_STREAM_STATE_UNKNOWN,
49  Open = AAUDIO_STREAM_STATE_OPEN,
50  Starting = AAUDIO_STREAM_STATE_STARTING,
51  Started = AAUDIO_STREAM_STATE_STARTED,
52  Pausing = AAUDIO_STREAM_STATE_PAUSING,
53  Paused = AAUDIO_STREAM_STATE_PAUSED,
54  Flushing = AAUDIO_STREAM_STATE_FLUSHING,
55  Flushed = AAUDIO_STREAM_STATE_FLUSHED,
56  Stopping = AAUDIO_STREAM_STATE_STOPPING,
57  Stopped = AAUDIO_STREAM_STATE_STOPPED,
58  Closing = AAUDIO_STREAM_STATE_CLOSING,
59  Closed = AAUDIO_STREAM_STATE_CLOSED,
60  Disconnected = AAUDIO_STREAM_STATE_DISCONNECTED,
61  };
62 
63  enum class Direction : aaudio_direction_t {
64  Output = AAUDIO_DIRECTION_OUTPUT,
65  Input = AAUDIO_DIRECTION_INPUT,
66  };
67 
68  enum class AudioFormat : aaudio_format_t {
69  Invalid = AAUDIO_FORMAT_INVALID,
70  Unspecified = AAUDIO_FORMAT_UNSPECIFIED,
71  I16 = AAUDIO_FORMAT_PCM_I16,
72  Float = AAUDIO_FORMAT_PCM_FLOAT,
73  };
74 
75  enum class DataCallbackResult : aaudio_data_callback_result_t {
76  Continue = AAUDIO_CALLBACK_RESULT_CONTINUE,
77  Stop = AAUDIO_CALLBACK_RESULT_STOP,
78  };
79 
80  enum class Result : aaudio_result_t {
81  OK,
82  ErrorBase = AAUDIO_ERROR_BASE,
83  ErrorDisconnected = AAUDIO_ERROR_DISCONNECTED,
84  ErrorIllegalArgument = AAUDIO_ERROR_ILLEGAL_ARGUMENT,
85  ErrorInternal = AAUDIO_ERROR_INTERNAL,
86  ErrorInvalidState = AAUDIO_ERROR_INVALID_STATE,
87  ErrorInvalidHandle = AAUDIO_ERROR_INVALID_HANDLE,
88  ErrorUnimplemented = AAUDIO_ERROR_UNIMPLEMENTED,
89  ErrorUnavailable = AAUDIO_ERROR_UNAVAILABLE,
90  ErrorNoFreeHandles = AAUDIO_ERROR_NO_FREE_HANDLES,
91  ErrorNoMemory = AAUDIO_ERROR_NO_MEMORY,
92  ErrorNull = AAUDIO_ERROR_NULL,
93  ErrorTimeout = AAUDIO_ERROR_TIMEOUT,
94  ErrorWouldBlock = AAUDIO_ERROR_WOULD_BLOCK,
95  ErrorInvalidFormat = AAUDIO_ERROR_INVALID_FORMAT,
96  ErrorOutOfRange = AAUDIO_ERROR_OUT_OF_RANGE,
97  ErrorNoService = AAUDIO_ERROR_NO_SERVICE,
98  ErrorInvalidRate = AAUDIO_ERROR_INVALID_RATE,
99  // Reserved for future AAudio result types
100  Reserved1,
101  Reserved2,
102  Reserved3,
103  Reserved4,
104  Reserved5,
105  Reserved6,
106  Reserved7,
107  Reserved8,
108  Reserved9,
109  Reserved10,
110  ErrorClosed,
111  };
112 
113  enum class SharingMode : aaudio_sharing_mode_t {
114 
120  Exclusive = AAUDIO_SHARING_MODE_EXCLUSIVE,
121 
126  Shared = AAUDIO_SHARING_MODE_SHARED,
127  };
128 
129  enum class PerformanceMode : aaudio_performance_mode_t {
130 
131  // No particular performance needs. Default.
132  None = AAUDIO_PERFORMANCE_MODE_NONE,
133 
134  // Extending battery life is most important.
135  PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING,
136 
137  // Reducing latency is most important.
138  LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY
139  };
140 
141  enum class AudioApi : int32_t {
145  Unspecified = kUnspecified,
146 
150  OpenSLES,
151 
155  AAudio
156  };
157 
158 // Hard code constants so they can be compiled with versions of the NDK before P.
159 #if __ANDROID_API_LEVEL__ >= __ANDROID_API_P__
160 #define CONSTANT_API_P(hard_constant, soft_constant) (soft_constant)
161 #else
162 #define CONSTANT_API_P(hard_constant, soft_constant) (hard_constant)
163 #endif
164 
174  enum class Usage : aaudio_usage_t {
178  Media = CONSTANT_API_P(1, AAUDIO_USAGE_MEDIA),
179 
183  VoiceCommunication = CONSTANT_API_P(2, AAUDIO_USAGE_VOICE_COMMUNICATION),
184 
188  VoiceCommunicationSignalling = CONSTANT_API_P(3,
189  AAUDIO_USAGE_VOICE_COMMUNICATION_SIGNALLING),
190 
194  Alarm = CONSTANT_API_P(4, AAUDIO_USAGE_ALARM),
195 
200  Notification = CONSTANT_API_P(5, AAUDIO_USAGE_NOTIFICATION),
201 
205  NotificationRingtone = CONSTANT_API_P(6, AAUDIO_USAGE_NOTIFICATION_RINGTONE),
206 
210  NotificationEvent = CONSTANT_API_P(10, AAUDIO_USAGE_NOTIFICATION_EVENT),
211 
215  AssistanceAccessibility = CONSTANT_API_P(11, AAUDIO_USAGE_ASSISTANCE_ACCESSIBILITY),
216 
220  AssistanceNavigationGuidance = CONSTANT_API_P(12,
221  AAUDIO_USAGE_ASSISTANCE_NAVIGATION_GUIDANCE),
222 
226  AssistanceSonification = CONSTANT_API_P(13, AAUDIO_USAGE_ASSISTANCE_SONIFICATION),
227 
231  Game = CONSTANT_API_P(14, AAUDIO_USAGE_GAME),
232 
236  Assistant = CONSTANT_API_P(16, AAUDIO_USAGE_ASSISTANT),
237  };
238 
239 
252  enum ContentType : aaudio_content_type_t {
253 
257  Speech = CONSTANT_API_P(1, AAUDIO_CONTENT_TYPE_SPEECH),
258 
262  Music = CONSTANT_API_P(2, AAUDIO_CONTENT_TYPE_MUSIC),
263 
267  Movie = CONSTANT_API_P(3, AAUDIO_CONTENT_TYPE_MOVIE),
268 
273  Sonification = CONSTANT_API_P(4, AAUDIO_CONTENT_TYPE_SONIFICATION),
274  };
275 
285  enum InputPreset : aaudio_input_preset_t {
289  Generic = CONSTANT_API_P(1, AAUDIO_INPUT_PRESET_GENERIC),
290 
294  Camcorder = CONSTANT_API_P(5, AAUDIO_INPUT_PRESET_CAMCORDER),
295 
299  VoiceRecognition = CONSTANT_API_P(6, AAUDIO_INPUT_PRESET_VOICE_RECOGNITION),
300 
304  VoiceCommunication = CONSTANT_API_P(7, AAUDIO_INPUT_PRESET_VOICE_COMMUNICATION),
305 
311  Unprocessed = CONSTANT_API_P(9, AAUDIO_INPUT_PRESET_UNPROCESSED),
312  };
313 
314  enum SessionId {
322  None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE),
323 
333  Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE),
334  };
335 
336  enum ChannelCount : int32_t {
340  Unspecified = kUnspecified,
341 
345  Mono = 1,
346 
350  Stereo = 2,
351  };
352 
353 #undef CONSTANT_API_P
354 
355  class DefaultStreamValues {
356 
357  public:
358 
377  static int32_t SampleRate;
378  static int32_t FramesPerBurst;
379  static int32_t ChannelCount;
380  };
381 
382 
383 
384 } // namespace oboe
385 
386 #endif // OBOE_DEFINITIONS_H
- - - -
oboe::Sonification
Definition: Definitions.h:273
-
oboe::Allocate
Definition: Definitions.h:333
-
oboe::None
Definition: Definitions.h:322
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
- -
oboe::Unprocessed
Definition: Definitions.h:311
- -
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::DefaultStreamValues
Definition: Definitions.h:355
- - -
oboe::Music
Definition: Definitions.h:262
-
oboe::Camcorder
Definition: Definitions.h:294
-
oboe::VoiceCommunication
Definition: Definitions.h:304
- -
oboe::Generic
Definition: Definitions.h:289
-
oboe::Stereo
Definition: Definitions.h:350
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
-
oboe::Mono
Definition: Definitions.h:345
-
oboe::ChannelCount
ChannelCount
Definition: Definitions.h:336
- - -
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
- -
oboe
Definition: AudioStream.h:29
- - -
oboe::Unspecified
Definition: Definitions.h:340
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
-
oboe::DefaultStreamValues::SampleRate
static int32_t SampleRate
Definition: Definitions.h:377
-
oboe::Usage
Usage
Definition: Definitions.h:174
- -
oboe::Speech
Definition: Definitions.h:257
-
oboe::VoiceRecognition
Definition: Definitions.h:299
-
oboe::Movie
Definition: Definitions.h:267
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_latency_tuner_8h_source.html b/docs/reference/_latency_tuner_8h_source.html deleted file mode 100644 index 66e82f898..000000000 --- a/docs/reference/_latency_tuner_8h_source.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - -Oboe: include/oboe/LatencyTuner.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
LatencyTuner.h
-
-
-
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_LATENCY_TUNER_
18 #define OBOE_LATENCY_TUNER_
19 
20 #include <atomic>
21 #include <cstdint>
22 #include "oboe/Definitions.h"
23 #include "oboe/AudioStream.h"
24 
25 namespace oboe {
26 
42 class LatencyTuner {
43 public:
44  explicit LatencyTuner(AudioStream &stream);
45 
54  Result tune();
55 
64  void requestReset();
65 
66 private:
67 
74  void reset();
75 
76  enum class State {
77  Idle,
78  Active,
79  AtMax,
80  Unsupported
81  } ;
82 
83  // arbitrary number of calls to wait before bumping up the latency
84  static constexpr int32_t kIdleCount = 8;
85 
86  AudioStream &mStream;
87  State mState = State::Idle;
88  int32_t mPreviousXRuns = 0;
89  int32_t mIdleCountDown = 0;
90  std::atomic<int32_t> mLatencyTriggerRequests{0}; // TODO user atomic requester from AAudio
91  std::atomic<int32_t> mLatencyTriggerResponses{0};
92 };
93 
94 } // namespace oboe
95 
96 #endif // OBOE_LATENCY_TUNER_
-
oboe::AudioStream
Definition: AudioStream.h:36
- -
oboe::LatencyTuner
Definition: LatencyTuner.h:42
-
oboe
Definition: AudioStream.h:29
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_oboe_8h_source.html b/docs/reference/_oboe_8h_source.html deleted file mode 100644 index 11346b96e..000000000 --- a/docs/reference/_oboe_8h_source.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - -Oboe: include/oboe/Oboe.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Oboe.h
-
-
-
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_OBOE_H
18 #define OBOE_OBOE_H
19 
20 #include "oboe/Definitions.h"
21 #include "oboe/ResultWithValue.h"
22 #include "oboe/LatencyTuner.h"
23 #include "oboe/AudioStream.h"
24 #include "oboe/AudioStreamBase.h"
25 #include "oboe/AudioStreamBuilder.h"
26 #include "oboe/Utilities.h"
27 #include "oboe/Version.h"
28 
29 #endif //OBOE_OBOE_H
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_result_with_value_8h_source.html b/docs/reference/_result_with_value_8h_source.html deleted file mode 100644 index 8eeb9332b..000000000 --- a/docs/reference/_result_with_value_8h_source.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - -Oboe: include/oboe/ResultWithValue.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
ResultWithValue.h
-
-
-
1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_RESULT_WITH_VALUE_H
18 #define OBOE_RESULT_WITH_VALUE_H
19 
20 #include "oboe/Definitions.h"
21 #include <iostream>
22 #include <sstream>
23 
24 namespace oboe {
25 
26 template <typename T>
27 class ResultWithValue {
28 public:
29  ResultWithValue(oboe::Result error)
30  : mValue{}
31  , mError(error) {}
32 
33  explicit ResultWithValue(T value)
34  : mValue(value)
35  , mError(oboe::Result::OK) {}
36 
37  oboe::Result error() const {
38  return mError;
39  }
40 
41  T value() const {
42  return mValue;
43  }
44 
48  explicit operator bool() const { return mError == oboe::Result::OK; }
49 
60  bool operator !() const { return mError != oboe::Result::OK; }
61 
70  operator Result() const {
71  return mError;
72  }
73 
81  static ResultWithValue<T> createBasedOnSign(T numericResult){
82 
83  // Ensure that the type is either an integer or float
84  static_assert(std::is_arithmetic<T>::value,
85  "createBasedOnSign can only be called for numeric types (int or float)");
86 
87  if (numericResult >= 0){
88  return ResultWithValue<T>(numericResult);
89  } else {
90  return ResultWithValue<T>(static_cast<Result>(numericResult));
91  }
92  }
93 
94 private:
95  const T mValue;
96  const oboe::Result mError;
97 };
98 
99 template <typename T>
100 std::ostream& operator<<(std::ostream &strm, const ResultWithValue<T> &result) {
101  if (!result) {
102  strm << convertToText(result.error());
103  } else {
104  strm << result.value();
105  }
106  return strm;
107 }
108 
109 } // namespace oboe
110 
111 
112 #endif //OBOE_RESULT_WITH_VALUE_H
oboe::ResultWithValue::createBasedOnSign
static ResultWithValue< T > createBasedOnSign(T numericResult)
Definition: ResultWithValue.h:81
-
oboe::convertToText
const char * convertToText(FromType)
-
oboe
Definition: AudioStream.h:29
-
oboe::ResultWithValue::operator!
bool operator!() const
Definition: ResultWithValue.h:60
-
oboe::ResultWithValue
Definition: ResultWithValue.h:27
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_utilities_8h_source.html b/docs/reference/_utilities_8h_source.html deleted file mode 100644 index 8797fcbbd..000000000 --- a/docs/reference/_utilities_8h_source.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - -Oboe: include/oboe/Utilities.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Utilities.h
-
-
-
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_UTILITIES_H
18 #define OBOE_UTILITIES_H
19 
20 #include <unistd.h>
21 #include <sys/types.h>
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
26 void convertFloatToPcm16(const float *source, int16_t *destination, int32_t numSamples);
27 void convertPcm16ToFloat(const int16_t *source, float *destination, int32_t numSamples);
28 
32 int32_t convertFormatToSizeInBytes(AudioFormat format);
33 
43 template <typename FromType>
44 const char * convertToText(FromType);
45 
54 int getSdkVersion();
55 
56 } // namespace oboe
57 
58 #endif //OBOE_UTILITIES_H
oboe::convertToText
const char * convertToText(FromType)
-
oboe::convertFormatToSizeInBytes
int32_t convertFormatToSizeInBytes(AudioFormat format)
-
oboe
Definition: AudioStream.h:29
-
oboe::getSdkVersion
int getSdkVersion()
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/_version_8h_source.html b/docs/reference/_version_8h_source.html deleted file mode 100644 index 348ac5818..000000000 --- a/docs/reference/_version_8h_source.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - -Oboe: include/oboe/Version.h Source File - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Version.h
-
-
-
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_VERSIONINFO_H
18 #define OBOE_VERSIONINFO_H
19 
31 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
32 #define OBOE_VERSION_MAJOR 0
33 
34 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
35 #define OBOE_VERSION_MINOR 12
36 
37 // Type: 16-bit unsigned int. Min value: 0 Max value: 65535. See below for description.
38 #define OBOE_VERSION_PATCH 0
39 
40 #define OBOE_STRINGIFY(x) #x
41 #define OBOE_TOSTRING(x) OBOE_STRINGIFY(x)
42 
43 // Type: String literal. See below for description.
44 #define OBOE_VERSION_TEXT \
45  OBOE_TOSTRING(OBOE_VERSION_MAJOR) "." \
46  OBOE_TOSTRING(OBOE_VERSION_MINOR) "." \
47  OBOE_TOSTRING(OBOE_VERSION_PATCH)
48 
49 // Type: 32-bit unsigned int. See below for description.
50 #define OBOE_VERSION_NUMBER ((OBOE_VERSION_MAJOR << 24) | (OBOE_VERSION_MINOR << 16) | OBOE_VERSION_PATCH)
51 
52 namespace oboe {
53 
54 struct Version {
58  static constexpr uint8_t Major = OBOE_VERSION_MAJOR;
59 
64  static constexpr uint8_t Minor = OBOE_VERSION_MINOR;
65 
70  static constexpr uint16_t Patch = OBOE_VERSION_PATCH;
71 
75  static constexpr const char * Text = OBOE_VERSION_TEXT;
76 
81  static constexpr uint32_t Number = OBOE_VERSION_NUMBER;
82 };
83 
84 } // namespace oboe
85 #endif //OBOE_VERSIONINFO_H
oboe::Version
Definition: Version.h:54
-
oboe::Version::Minor
static constexpr uint8_t Minor
Definition: Version.h:64
-
oboe::Version::Major
static constexpr uint8_t Major
Definition: Version.h:58
-
oboe::Version::Number
static constexpr uint32_t Number
Definition: Version.h:81
-
oboe::Version::Text
static constexpr const char * Text
Definition: Version.h:75
-
oboe
Definition: AudioStream.h:29
-
oboe::Version::Patch
static constexpr uint16_t Patch
Definition: Version.h:70
-
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/a00002_source.html b/docs/reference/a00002_source.html index c9ff42a2c..e22584d08 100644 --- a/docs/reference/a00002_source.html +++ b/docs/reference/a00002_source.html @@ -71,29 +71,58 @@
AudioStream.h
-
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_H_
18 #define OBOE_STREAM_H_
19 
20 #include <cstdint>
21 #include <ctime>
22 #include "oboe/Definitions.h"
23 #include "oboe/ResultWithValue.h"
24 #include "oboe/AudioStreamBuilder.h"
25 #include "oboe/AudioStreamBase.h"
26 
29 namespace oboe {
30 
31 constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond);
32 
36 class AudioStream : public AudioStreamBase {
37 public:
38 
39  AudioStream() {}
40  explicit AudioStream(const AudioStreamBuilder &builder);
41 
42  virtual ~AudioStream() = default;
43 
52  virtual Result open();
53 
57  virtual Result close() = 0;
58 
59  /*
60  * These are synchronous and will block until the operation is complete.
61  */
62  virtual Result start(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
63  virtual Result pause(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
64  virtual Result flush(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
65  virtual Result stop(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
66 
67  /* Asynchronous requests.
68  * Use waitForStateChange() if you need to wait for completion.
69  */
70  virtual Result requestStart() = 0;
71  virtual Result requestPause() = 0;
72  virtual Result requestFlush() = 0;
73  virtual Result requestStop() = 0;
74 
80  virtual StreamState getState() = 0;
81 
106  virtual Result waitForStateChange(StreamState inputState,
107  StreamState *nextState,
108  int64_t timeoutNanoseconds) = 0;
109 
122  virtual ResultWithValue<int32_t> setBufferSizeInFrames(int32_t requestedFrames) {
123  return Result::ErrorUnimplemented;
124  }
125 
138  virtual ResultWithValue<int32_t> getXRunCount() const {
139  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
140  }
141 
145  virtual bool isXRunCountSupported() const = 0;
146 
152  virtual int32_t getFramesPerBurst() = 0;
153 
154  bool isPlaying();
155 
156  int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); }
157 
158  int32_t getBytesPerSample() const;
159 
164  virtual int64_t getFramesWritten() { return mFramesWritten; }
165 
166  virtual int64_t getFramesRead() { return mFramesRead; }
167 
191  virtual ResultWithValue<double> calculateLatencyMillis() {
192  return ResultWithValue<double>(Result::ErrorUnimplemented);
193  }
194 
195  virtual Result getTimestamp(clockid_t clockId,
196  int64_t *framePosition,
197  int64_t *timeNanoseconds) {
198  return Result::ErrorUnimplemented;
199  }
200 
201  // ============== I/O ===========================
213  virtual ResultWithValue<int32_t> write(const void *buffer,
214  int32_t numFrames,
215  int64_t timeoutNanoseconds) {
216  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
217  }
218 
219  virtual ResultWithValue<int32_t> read(void *buffer,
220  int32_t numFrames,
221  int64_t timeoutNanoseconds) {
222  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
223  }
224 
229  virtual AudioApi getAudioApi() const = 0;
230 
234  bool usesAAudio() const {
235  return getAudioApi() == AudioApi::AAudio;
236  }
237 
246  virtual void *getUnderlyingStream() const {
247  return nullptr;
248  }
249 
250 protected:
251 
252  virtual int64_t incrementFramesWritten(int32_t frames) {
253  return mFramesWritten += frames;
254  }
255  virtual int64_t incrementFramesRead(int32_t frames) {
256  return mFramesRead += frames;
257  }
258 
265  virtual Result waitForStateTransition(StreamState startingState,
266  StreamState endingState,
267  int64_t timeoutNanoseconds);
268 
276  virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames) {
277  return DataCallbackResult::Stop;
278  }
279 
280  DataCallbackResult fireCallback(void *audioData, int numFrames);
281 
282  virtual void setNativeFormat(AudioFormat format) {
283  mNativeFormat = format;
284  }
285 
286  // TODO: make private
287  // These do not change after open.
288  AudioFormat mNativeFormat = AudioFormat::Invalid;
289 
290  // TODO these should be atomic like in AAudio
291  int64_t mFramesWritten = 0;
292  int64_t mFramesRead = 0;
293 
294 private:
295  // TODO these should be atomic like in AAudio
296  int mPreviousScheduler = -1;
297 };
298 
299 } // namespace oboe
300 
301 #endif /* OBOE_STREAM_H_ */
oboe::AudioStream::getState
virtual StreamState getState()=0
+
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_H_
18 #define OBOE_STREAM_H_
19 
20 #include <cstdint>
21 #include <ctime>
22 #include "oboe/Definitions.h"
23 #include "oboe/ResultWithValue.h"
24 #include "oboe/AudioStreamBuilder.h"
25 #include "oboe/AudioStreamBase.h"
26 
29 namespace oboe {
30 
37 constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond);
38 
42 class AudioStream : public AudioStreamBase {
43 public:
44 
45  AudioStream() {}
46 
52  explicit AudioStream(const AudioStreamBuilder &builder);
53 
54  virtual ~AudioStream() = default;
55 
64  virtual Result open();
65 
69  virtual Result close() = 0;
70 
75  virtual Result start(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
76 
81  virtual Result pause(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
82 
87  virtual Result flush(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
88 
93  virtual Result stop(int64_t timeoutNanoseconds = kDefaultTimeoutNanos);
94 
95  /* Asynchronous requests.
96  * Use waitForStateChange() if you need to wait for completion.
97  */
98 
103  virtual Result requestStart() = 0;
104 
109  virtual Result requestPause() = 0;
110 
115  virtual Result requestFlush() = 0;
116 
121  virtual Result requestStop() = 0;
122 
128  virtual StreamState getState() = 0;
129 
154  virtual Result waitForStateChange(StreamState inputState,
155  StreamState *nextState,
156  int64_t timeoutNanoseconds) = 0;
157 
170  virtual ResultWithValue<int32_t> setBufferSizeInFrames(int32_t requestedFrames) {
171  return Result::ErrorUnimplemented;
172  }
173 
186  virtual ResultWithValue<int32_t> getXRunCount() const {
187  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
188  }
189 
193  virtual bool isXRunCountSupported() const = 0;
194 
200  virtual int32_t getFramesPerBurst() = 0;
201 
207  bool isPlaying();
208 
216  int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); }
217 
224  int32_t getBytesPerSample() const;
225 
232  virtual int64_t getFramesWritten() { return mFramesWritten; }
233 
240  virtual int64_t getFramesRead() { return mFramesRead; }
241 
265  virtual ResultWithValue<double> calculateLatencyMillis() {
266  return ResultWithValue<double>(Result::ErrorUnimplemented);
267  }
268 
278  virtual Result getTimestamp(clockid_t clockId,
279  int64_t *framePosition,
280  int64_t *timeNanoseconds) {
281  return Result::ErrorUnimplemented;
282  }
283 
284  // ============== I/O ===========================
297  virtual ResultWithValue<int32_t> write(const void *buffer,
298  int32_t numFrames,
299  int64_t timeoutNanoseconds) {
300  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
301  }
302 
315  virtual ResultWithValue<int32_t> read(void *buffer,
316  int32_t numFrames,
317  int64_t timeoutNanoseconds) {
318  return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
319  }
320 
326  virtual AudioApi getAudioApi() const = 0;
327 
333  bool usesAAudio() const {
334  return getAudioApi() == AudioApi::AAudio;
335  }
336 
345  virtual void *getUnderlyingStream() const {
346  return nullptr;
347  }
348 
349 protected:
350 
357  virtual int64_t incrementFramesWritten(int32_t frames) {
358  return mFramesWritten += frames;
359  }
360 
367  virtual int64_t incrementFramesRead(int32_t frames) {
368  return mFramesRead += frames;
369  }
370 
377  virtual Result waitForStateTransition(StreamState startingState,
378  StreamState endingState,
379  int64_t timeoutNanoseconds);
380 
388  virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames) {
389  return DataCallbackResult::Stop;
390  }
391 
400  DataCallbackResult fireCallback(void *audioData, int numFrames);
401 
405  virtual void setNativeFormat(AudioFormat format) {
406  mNativeFormat = format;
407  }
408 
415  AudioFormat mNativeFormat = AudioFormat::Invalid;
416 
422  int64_t mFramesWritten = 0;
423 
429  int64_t mFramesRead = 0;
430 
431 private:
432  int mPreviousScheduler = -1;
433 };
434 
435 } // namespace oboe
436 
437 #endif /* OBOE_STREAM_H_ */
oboe::AudioStream::requestStart
virtual Result requestStart()=0
+
oboe::AudioStream::requestStop
virtual Result requestStop()=0
+
oboe::kNanosPerMillisecond
constexpr int64_t kNanosPerMillisecond
Definition: Definitions.h:52
+ +
oboe::AudioStream::getState
virtual StreamState getState()=0
oboe::AudioStreamBuilder
Definition: AudioStreamBuilder.h:28
oboe::AudioStream::close
virtual Result close()=0
+
oboe::AudioStream::mFramesWritten
int64_t mFramesWritten
Definition: AudioStream.h:422
+
oboe::AudioStream::stop
virtual Result stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
+
oboe::AudioStream::getBytesPerFrame
int32_t getBytesPerFrame() const
Definition: AudioStream.h:216
+
oboe::AudioStream::getBytesPerSample
int32_t getBytesPerSample() const
+
oboe::AudioStream::mNativeFormat
AudioFormat mNativeFormat
Definition: AudioStream.h:415
+
oboe::AudioStream::getTimestamp
virtual Result getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds)
Definition: AudioStream.h:278
oboe::AudioStream::waitForStateTransition
virtual Result waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
+
oboe::AudioStreamBase::mChannelCount
int32_t mChannelCount
Definition: AudioStreamBase.h:135
oboe::AudioStream::getFramesPerBurst
virtual int32_t getFramesPerBurst()=0
-
oboe::AudioStream::getUnderlyingStream
virtual void * getUnderlyingStream() const
Definition: AudioStream.h:246
+
oboe::kDefaultTimeoutNanos
constexpr int64_t kDefaultTimeoutNanos
Definition: AudioStream.h:37
+
oboe::AudioStream::start
virtual Result start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
+
oboe::AudioStream::fireCallback
DataCallbackResult fireCallback(void *audioData, int numFrames)
+
oboe::AudioStream::getUnderlyingStream
virtual void * getUnderlyingStream() const
Definition: AudioStream.h:345
oboe::AudioStream::isXRunCountSupported
virtual bool isXRunCountSupported() const =0
-
oboe::AudioStream::write
virtual ResultWithValue< int32_t > write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
Definition: AudioStream.h:213
-
oboe::AudioStream::getXRunCount
virtual ResultWithValue< int32_t > getXRunCount() const
Definition: AudioStream.h:138
+
oboe::AudioStream::write
virtual ResultWithValue< int32_t > write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
Definition: AudioStream.h:297
+
oboe::AudioStream::getXRunCount
virtual ResultWithValue< int32_t > getXRunCount() const
Definition: AudioStream.h:186
oboe::AudioStream::getAudioApi
virtual AudioApi getAudioApi() const =0
+
oboe::AudioStream::incrementFramesRead
virtual int64_t incrementFramesRead(int32_t frames)
Definition: AudioStream.h:367
+
oboe::AudioStream::mFramesRead
int64_t mFramesRead
Definition: AudioStream.h:429
+
oboe::AudioStream::flush
virtual Result flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
+
oboe::AudioStream::requestPause
virtual Result requestPause()=0
oboe
Definition: AudioStream.h:29
-
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::AudioStream::onDefaultCallback
virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames)
Definition: AudioStream.h:276
-
oboe::AudioStream::setBufferSizeInFrames
virtual ResultWithValue< int32_t > setBufferSizeInFrames(int32_t requestedFrames)
Definition: AudioStream.h:122
-
oboe::AudioStream::calculateLatencyMillis
virtual ResultWithValue< double > calculateLatencyMillis()
Definition: AudioStream.h:191
-
oboe::AudioStream::usesAAudio
bool usesAAudio() const
Definition: AudioStream.h:234
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::ResultWithValue
Definition: ResultWithValue.h:27
+
oboe::AudioStream::getFramesRead
virtual int64_t getFramesRead()
Definition: AudioStream.h:240
+
oboe::AudioApi
AudioApi
Definition: Definitions.h:216
+
oboe::AudioStream::onDefaultCallback
virtual DataCallbackResult onDefaultCallback(void *audioData, int numFrames)
Definition: AudioStream.h:388
+
oboe::AudioStream::read
virtual ResultWithValue< int32_t > read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
Definition: AudioStream.h:315
+
oboe::AudioStream::setBufferSizeInFrames
virtual ResultWithValue< int32_t > setBufferSizeInFrames(int32_t requestedFrames)
Definition: AudioStream.h:170
+
oboe::AudioStream::calculateLatencyMillis
virtual ResultWithValue< double > calculateLatencyMillis()
Definition: AudioStream.h:265
+
oboe::Result
Result
Definition: Definitions.h:140
+
oboe::AudioStream::usesAAudio
bool usesAAudio() const
Definition: AudioStream.h:333
+
oboe::AudioStreamBase
Definition: AudioStreamBase.h:29
+
oboe::AudioStream::pause
virtual Result pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
+
oboe::AudioFormat
AudioFormat
Definition: Definitions.h:103
+
oboe::ResultWithValue
Definition: ResultWithValue.h:47
oboe::AudioStream::waitForStateChange
virtual Result waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
+
oboe::DataCallbackResult
DataCallbackResult
Definition: Definitions.h:128
+
oboe::AudioStream::incrementFramesWritten
virtual int64_t incrementFramesWritten(int32_t frames)
Definition: AudioStream.h:357
+
oboe::AudioStream::open
virtual Result open()
-
oboe::AudioStream::getFramesWritten
virtual int64_t getFramesWritten()
Definition: AudioStream.h:164
-
oboe::AudioStream
Definition: AudioStream.h:36
+
oboe::AudioStream::setNativeFormat
virtual void setNativeFormat(AudioFormat format)
Definition: AudioStream.h:405
+
oboe::StreamState
StreamState
Definition: Definitions.h:67
+
oboe::AudioStream::requestFlush
virtual Result requestFlush()=0
+
oboe::AudioStream::getFramesWritten
virtual int64_t getFramesWritten()
Definition: AudioStream.h:232
+
oboe::AudioStream
Definition: AudioStream.h:42
diff --git a/docs/reference/a00005_source.html b/docs/reference/a00005_source.html index f2f15941c..167090c26 100644 --- a/docs/reference/a00005_source.html +++ b/docs/reference/a00005_source.html @@ -71,22 +71,53 @@
AudioStreamBase.h
-
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BASE_H_
18 #define OBOE_STREAM_BASE_H_
19 
20 #include <memory>
21 #include "oboe/AudioStreamCallback.h"
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
34 class AudioStreamBase {
35 public:
36 
37  AudioStreamBase() {}
38 
39  virtual ~AudioStreamBase() = default;
40 
41  // This class only contains primitives so we can use default constructor and copy methods.
42  AudioStreamBase(const AudioStreamBase&) = default;
43 
44  AudioStreamBase& operator=(const AudioStreamBase&) = default;
45 
49  int getChannelCount() const { return mChannelCount; }
50 
54  Direction getDirection() const { return mDirection; }
55 
59  int32_t getSampleRate() const { return mSampleRate; }
60 
64  int getFramesPerCallback() const { return mFramesPerCallback; }
65 
70  AudioFormat getFormat() const { return mFormat; }
71 
78  virtual int32_t getBufferSizeInFrames() { return mBufferSizeInFrames; };
79 
83  virtual int32_t getBufferCapacityInFrames() const { return mBufferCapacityInFrames; }
84 
85  SharingMode getSharingMode() const { return mSharingMode; }
86 
87  PerformanceMode getPerformanceMode() const { return mPerformanceMode; }
88 
89  int32_t getDeviceId() const { return mDeviceId; }
90 
91  AudioStreamCallback* getCallback() const {
92  return mStreamCallback;
93  }
94 
95  Usage getUsage() const { return mUsage; }
96 
97  ContentType getContentType() const { return mContentType; }
98 
99  InputPreset getInputPreset() const { return mInputPreset; }
100 
101  SessionId getSessionId() const { return mSessionId; }
102 
103 protected:
104  AudioStreamCallback *mStreamCallback = nullptr;
105  int32_t mFramesPerCallback = kUnspecified;
106  int32_t mChannelCount = kUnspecified;
107  int32_t mSampleRate = kUnspecified;
108  int32_t mDeviceId = kUnspecified;
109  int32_t mBufferCapacityInFrames = kUnspecified;
110  int32_t mBufferSizeInFrames = kUnspecified;
111  int32_t mFramesPerBurst = kUnspecified;
112 
113  SharingMode mSharingMode = SharingMode::Shared;
114  AudioFormat mFormat = AudioFormat::Unspecified;
115  Direction mDirection = Direction::Output;
116  PerformanceMode mPerformanceMode = PerformanceMode::None;
117  // Added in API 28
118  Usage mUsage = Usage::Media;
119  ContentType mContentType = ContentType::Music;
120  InputPreset mInputPreset = InputPreset::VoiceRecognition;
121  SessionId mSessionId = SessionId::None;
122 };
123 
124 } // namespace oboe
125 
126 #endif /* OBOE_STREAM_BASE_H_ */
oboe::AudioStreamBase::getBufferSizeInFrames
virtual int32_t getBufferSizeInFrames()
Definition: AudioStreamBase.h:78
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
+
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BASE_H_
18 #define OBOE_STREAM_BASE_H_
19 
20 #include <memory>
21 #include "oboe/AudioStreamCallback.h"
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
29 class AudioStreamBase {
30 public:
31 
32  AudioStreamBase() {}
33 
34  virtual ~AudioStreamBase() = default;
35 
36  // This class only contains primitives so we can use default constructor and copy methods.
37 
41  AudioStreamBase(const AudioStreamBase&) = default;
42 
46  AudioStreamBase& operator=(const AudioStreamBase&) = default;
47 
51  int getChannelCount() const { return mChannelCount; }
52 
56  Direction getDirection() const { return mDirection; }
57 
61  int32_t getSampleRate() const { return mSampleRate; }
62 
66  int getFramesPerCallback() const { return mFramesPerCallback; }
67 
71  AudioFormat getFormat() const { return mFormat; }
72 
79  virtual int32_t getBufferSizeInFrames() { return mBufferSizeInFrames; };
80 
84  virtual int32_t getBufferCapacityInFrames() const { return mBufferCapacityInFrames; }
85 
89  SharingMode getSharingMode() const { return mSharingMode; }
90 
94  PerformanceMode getPerformanceMode() const { return mPerformanceMode; }
95 
99  int32_t getDeviceId() const { return mDeviceId; }
100 
104  AudioStreamCallback* getCallback() const {
105  return mStreamCallback;
106  }
107 
111  Usage getUsage() const { return mUsage; }
112 
116  ContentType getContentType() const { return mContentType; }
117 
121  InputPreset getInputPreset() const { return mInputPreset; }
122 
126  SessionId getSessionId() const { return mSessionId; }
127 
128 protected:
129 
131  AudioStreamCallback *mStreamCallback = nullptr;
133  int32_t mFramesPerCallback = kUnspecified;
135  int32_t mChannelCount = kUnspecified;
137  int32_t mSampleRate = kUnspecified;
139  int32_t mDeviceId = kUnspecified;
141  int32_t mBufferCapacityInFrames = kUnspecified;
143  int32_t mBufferSizeInFrames = kUnspecified;
148  int32_t mFramesPerBurst = kUnspecified;
149 
151  SharingMode mSharingMode = SharingMode::Shared;
153  AudioFormat mFormat = AudioFormat::Unspecified;
155  Direction mDirection = Direction::Output;
157  PerformanceMode mPerformanceMode = PerformanceMode::None;
158 
160  Usage mUsage = Usage::Media;
162  ContentType mContentType = ContentType::Music;
164  InputPreset mInputPreset = InputPreset::VoiceRecognition;
166  SessionId mSessionId = SessionId::None;
167 };
168 
169 } // namespace oboe
170 
171 #endif /* OBOE_STREAM_BASE_H_ */
oboe::AudioStreamBase::getInputPreset
InputPreset getInputPreset() const
Definition: AudioStreamBase.h:121
+
oboe::AudioStreamBase::mSampleRate
int32_t mSampleRate
Definition: AudioStreamBase.h:137
+
oboe::AudioStreamBase::getBufferSizeInFrames
virtual int32_t getBufferSizeInFrames()
Definition: AudioStreamBase.h:79
+
oboe::AudioStreamBase::mSessionId
SessionId mSessionId
Definition: AudioStreamBase.h:166
+
oboe::AudioStreamBase::mInputPreset
InputPreset mInputPreset
Definition: AudioStreamBase.h:164
+
oboe::AudioStreamBase::mFramesPerBurst
int32_t mFramesPerBurst
Definition: AudioStreamBase.h:148
+
oboe::AudioStreamBase::mContentType
ContentType mContentType
Definition: AudioStreamBase.h:162
+
oboe::AudioStreamBase::getPerformanceMode
PerformanceMode getPerformanceMode() const
Definition: AudioStreamBase.h:94
+
oboe::AudioStreamBase::mPerformanceMode
PerformanceMode mPerformanceMode
Definition: AudioStreamBase.h:157
+ +
oboe::AudioStreamBase::operator=
AudioStreamBase & operator=(const AudioStreamBase &)=default
+
oboe::AudioStreamBase::mChannelCount
int32_t mChannelCount
Definition: AudioStreamBase.h:135
+
oboe::AudioStreamBase::getSharingMode
SharingMode getSharingMode() const
Definition: AudioStreamBase.h:89
+
oboe::AudioStreamBase::mBufferSizeInFrames
int32_t mBufferSizeInFrames
Definition: AudioStreamBase.h:143
+
oboe::AudioStreamBase::mBufferCapacityInFrames
int32_t mBufferCapacityInFrames
Definition: AudioStreamBase.h:141
+
oboe::AudioStreamBase::getContentType
ContentType getContentType() const
Definition: AudioStreamBase.h:116
+
oboe::AudioStreamBase::mSharingMode
SharingMode mSharingMode
Definition: AudioStreamBase.h:151
+
oboe::AudioStreamBase::getSessionId
SessionId getSessionId() const
Definition: AudioStreamBase.h:126
+
oboe::SessionId
SessionId
Definition: Definitions.h:394
-
oboe::AudioStreamBase::getDirection
Direction getDirection() const
Definition: AudioStreamBase.h:54
-
oboe::AudioStreamBase::getChannelCount
int getChannelCount() const
Definition: AudioStreamBase.h:49
-
oboe::AudioStreamBase::getFormat
AudioFormat getFormat() const
Definition: AudioStreamBase.h:70
+
oboe::AudioStreamBase::mDeviceId
int32_t mDeviceId
Definition: AudioStreamBase.h:139
+
oboe::AudioStreamBase::mUsage
Usage mUsage
Definition: AudioStreamBase.h:160
+
oboe::AudioStreamBase::getDirection
Direction getDirection() const
Definition: AudioStreamBase.h:56
+
oboe::AudioStreamBase::mFramesPerCallback
int32_t mFramesPerCallback
Definition: AudioStreamBase.h:133
+
oboe::AudioStreamBase::getDeviceId
int32_t getDeviceId() const
Definition: AudioStreamBase.h:99
+
oboe::AudioStreamBase::getChannelCount
int getChannelCount() const
Definition: AudioStreamBase.h:51
+
oboe::AudioStreamBase::getFormat
AudioFormat getFormat() const
Definition: AudioStreamBase.h:71
oboe
Definition: AudioStream.h:29
-
oboe::AudioStreamBase::getBufferCapacityInFrames
virtual int32_t getBufferCapacityInFrames() const
Definition: AudioStreamBase.h:83
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
-
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::AudioStreamBase::getSampleRate
int32_t getSampleRate() const
Definition: AudioStreamBase.h:59
+
oboe::AudioStreamBase::getBufferCapacityInFrames
virtual int32_t getBufferCapacityInFrames() const
Definition: AudioStreamBase.h:84
+
oboe::AudioStreamBase::getCallback
AudioStreamCallback * getCallback() const
Definition: AudioStreamBase.h:104
+
oboe::Direction
Direction
Definition: Definitions.h:87
+
oboe::ContentType
ContentType
Definition: Definitions.h:327
+
oboe::AudioStreamBase::mDirection
Direction mDirection
Definition: AudioStreamBase.h:155
+
oboe::SharingMode
SharingMode
Definition: Definitions.h:176
+
oboe::AudioStreamBase
Definition: AudioStreamBase.h:29
+
oboe::AudioStreamBase::mStreamCallback
AudioStreamCallback * mStreamCallback
Definition: AudioStreamBase.h:131
+
oboe::AudioFormat
AudioFormat
Definition: Definitions.h:103
+
oboe::AudioStreamBase::getSampleRate
int32_t getSampleRate() const
Definition: AudioStreamBase.h:61
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
-
oboe::AudioStreamBase::getFramesPerCallback
int getFramesPerCallback() const
Definition: AudioStreamBase.h:64
-
oboe::Usage
Usage
Definition: Definitions.h:174
+
oboe::AudioStreamBase::getUsage
Usage getUsage() const
Definition: AudioStreamBase.h:111
+
oboe::AudioStreamBase::mFormat
AudioFormat mFormat
Definition: AudioStreamBase.h:153
+
oboe::InputPreset
InputPreset
Definition: Definitions.h:360
+
oboe::AudioStreamBase::getFramesPerCallback
int getFramesPerCallback() const
Definition: AudioStreamBase.h:66
+
oboe::kUnspecified
constexpr int32_t kUnspecified
Definition: Definitions.h:41
+
oboe::PerformanceMode
PerformanceMode
Definition: Definitions.h:195
+
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:33
+
oboe::Usage
Usage
Definition: Definitions.h:249
diff --git a/docs/reference/a00008_source.html b/docs/reference/a00008_source.html index 0ebd4b361..2f096893c 100644 --- a/docs/reference/a00008_source.html +++ b/docs/reference/a00008_source.html @@ -71,35 +71,54 @@
AudioStreamBuilder.h
-
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BUILDER_H_
18 #define OBOE_STREAM_BUILDER_H_
19 
20 #include "oboe/Definitions.h"
21 #include "oboe/AudioStreamBase.h"
22 
23 namespace oboe {
24 
28 class AudioStreamBuilder : public AudioStreamBase {
29 public:
30 
31  AudioStreamBuilder() : AudioStreamBase() {}
32 
39  AudioStreamBuilder *setChannelCount(int channelCount) {
40  mChannelCount = channelCount;
41  return this;
42  }
43 
49  AudioStreamBuilder *setDirection(Direction direction) {
50  mDirection = direction;
51  return this;
52  }
53 
65  AudioStreamBuilder *setSampleRate(int32_t sampleRate) {
66  mSampleRate = sampleRate;
67  return this;
68  }
69 
84  AudioStreamBuilder *setFramesPerCallback(int framesPerCallback) {
85  mFramesPerCallback = framesPerCallback;
86  return this;
87  }
88 
95  AudioStreamBuilder *setFormat(AudioFormat format) {
96  mFormat = format;
97  return this;
98  }
99 
109  AudioStreamBuilder *setBufferCapacityInFrames(int32_t bufferCapacityInFrames) {
110  mBufferCapacityInFrames = bufferCapacityInFrames;
111  return this;
112  }
113 
114  AudioApi getAudioApi() const { return mAudioApi; }
115 
125  AudioStreamBuilder *setAudioApi(AudioApi audioApi) {
126  mAudioApi = audioApi;
127  return this;
128  }
129 
137  static bool isAAudioSupported();
138 
146  static bool isAAudioRecommended();
147 
156  AudioStreamBuilder *setSharingMode(SharingMode sharingMode) {
157  mSharingMode = sharingMode;
158  return this;
159  }
160 
169  AudioStreamBuilder *setPerformanceMode(PerformanceMode performanceMode) {
170  mPerformanceMode = performanceMode;
171  return this;
172  }
173 
174 
187  AudioStreamBuilder *setUsage(Usage usage) {
188  mUsage = usage;
189  return this;
190  }
191 
204  AudioStreamBuilder *setContentType(ContentType contentType) {
205  mContentType = contentType;
206  return this;
207  }
208 
224  AudioStreamBuilder *setInputPreset(InputPreset inputPreset) {
225  mInputPreset = inputPreset;
226  return this;
227  }
228 
253  AudioStreamBuilder *setSessionId(SessionId sessionId) {
254  mSessionId = sessionId;
255  return this;
256  }
257 
270  AudioStreamBuilder *setDeviceId(int32_t deviceId) {
271  mDeviceId = deviceId;
272  return this;
273  }
274 
293  AudioStreamBuilder *setCallback(AudioStreamCallback *streamCallback) {
294  mStreamCallback = streamCallback;
295  return this;
296  }
297 
304  Result openStream(AudioStream **stream);
305 
306 protected:
307 
308 private:
309 
315  oboe::AudioStream *build();
316 
317  AudioApi mAudioApi = AudioApi::Unspecified;
318 };
319 
320 } // namespace oboe
321 
322 #endif /* OBOE_STREAM_BUILDER_H_ */
oboe::AudioStreamBuilder
Definition: AudioStreamBuilder.h:28
+
1 /*
2  * Copyright 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_BUILDER_H_
18 #define OBOE_STREAM_BUILDER_H_
19 
20 #include "oboe/Definitions.h"
21 #include "oboe/AudioStreamBase.h"
22 
23 namespace oboe {
24 
28 class AudioStreamBuilder : public AudioStreamBase {
29 public:
30 
31  AudioStreamBuilder() : AudioStreamBase() {}
32 
39  AudioStreamBuilder *setChannelCount(int channelCount) {
40  mChannelCount = channelCount;
41  return this;
42  }
43 
49  AudioStreamBuilder *setDirection(Direction direction) {
50  mDirection = direction;
51  return this;
52  }
53 
65  AudioStreamBuilder *setSampleRate(int32_t sampleRate) {
66  mSampleRate = sampleRate;
67  return this;
68  }
69 
84  AudioStreamBuilder *setFramesPerCallback(int framesPerCallback) {
85  mFramesPerCallback = framesPerCallback;
86  return this;
87  }
88 
95  AudioStreamBuilder *setFormat(AudioFormat format) {
96  mFormat = format;
97  return this;
98  }
99 
109  AudioStreamBuilder *setBufferCapacityInFrames(int32_t bufferCapacityInFrames) {
110  mBufferCapacityInFrames = bufferCapacityInFrames;
111  return this;
112  }
113 
121  AudioApi getAudioApi() const { return mAudioApi; }
122 
132  AudioStreamBuilder *setAudioApi(AudioApi audioApi) {
133  mAudioApi = audioApi;
134  return this;
135  }
136 
144  static bool isAAudioSupported();
145 
153  static bool isAAudioRecommended();
154 
163  AudioStreamBuilder *setSharingMode(SharingMode sharingMode) {
164  mSharingMode = sharingMode;
165  return this;
166  }
167 
176  AudioStreamBuilder *setPerformanceMode(PerformanceMode performanceMode) {
177  mPerformanceMode = performanceMode;
178  return this;
179  }
180 
181 
194  AudioStreamBuilder *setUsage(Usage usage) {
195  mUsage = usage;
196  return this;
197  }
198 
211  AudioStreamBuilder *setContentType(ContentType contentType) {
212  mContentType = contentType;
213  return this;
214  }
215 
231  AudioStreamBuilder *setInputPreset(InputPreset inputPreset) {
232  mInputPreset = inputPreset;
233  return this;
234  }
235 
260  AudioStreamBuilder *setSessionId(SessionId sessionId) {
261  mSessionId = sessionId;
262  return this;
263  }
264 
277  AudioStreamBuilder *setDeviceId(int32_t deviceId) {
278  mDeviceId = deviceId;
279  return this;
280  }
281 
300  AudioStreamBuilder *setCallback(AudioStreamCallback *streamCallback) {
301  mStreamCallback = streamCallback;
302  return this;
303  }
304 
311  Result openStream(AudioStream **stream);
312 
313 protected:
314 
315 private:
316 
322  oboe::AudioStream *build();
323 
324  AudioApi mAudioApi = AudioApi::Unspecified;
325 };
326 
327 } // namespace oboe
328 
329 #endif /* OBOE_STREAM_BUILDER_H_ */
oboe::AudioStreamBase::mSampleRate
int32_t mSampleRate
Definition: AudioStreamBase.h:137
+
oboe::AudioStreamBuilder
Definition: AudioStreamBuilder.h:28
+
oboe::AudioStreamBase::mSessionId
SessionId mSessionId
Definition: AudioStreamBase.h:166
oboe::AudioStreamBuilder::isAAudioRecommended
static bool isAAudioRecommended()
-
oboe::AudioStreamBuilder::setUsage
AudioStreamBuilder * setUsage(Usage usage)
Definition: AudioStreamBuilder.h:187
-
oboe::AudioStreamBuilder::setContentType
AudioStreamBuilder * setContentType(ContentType contentType)
Definition: AudioStreamBuilder.h:204
+
oboe::AudioStreamBase::mInputPreset
InputPreset mInputPreset
Definition: AudioStreamBase.h:164
+
oboe::AudioStreamBase::mContentType
ContentType mContentType
Definition: AudioStreamBase.h:162
+
oboe::AudioStreamBase::mPerformanceMode
PerformanceMode mPerformanceMode
Definition: AudioStreamBase.h:157
+
oboe::AudioStreamBase::mChannelCount
int32_t mChannelCount
Definition: AudioStreamBase.h:135
+
oboe::AudioStreamBuilder::setUsage
AudioStreamBuilder * setUsage(Usage usage)
Definition: AudioStreamBuilder.h:194
+
oboe::AudioStreamBuilder::setContentType
AudioStreamBuilder * setContentType(ContentType contentType)
Definition: AudioStreamBuilder.h:211
oboe::AudioStreamBuilder::setDirection
AudioStreamBuilder * setDirection(Direction direction)
Definition: AudioStreamBuilder.h:49
-
oboe::AudioStreamBuilder::setDeviceId
AudioStreamBuilder * setDeviceId(int32_t deviceId)
Definition: AudioStreamBuilder.h:270
-
oboe::AudioStreamBuilder::setInputPreset
AudioStreamBuilder * setInputPreset(InputPreset inputPreset)
Definition: AudioStreamBuilder.h:224
+
oboe::AudioStreamBuilder::setDeviceId
AudioStreamBuilder * setDeviceId(int32_t deviceId)
Definition: AudioStreamBuilder.h:277
+
oboe::AudioStreamBuilder::setInputPreset
AudioStreamBuilder * setInputPreset(InputPreset inputPreset)
Definition: AudioStreamBuilder.h:231
oboe::AudioStreamBuilder::openStream
Result openStream(AudioStream **stream)
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
+
oboe::AudioStreamBase::mBufferCapacityInFrames
int32_t mBufferCapacityInFrames
Definition: AudioStreamBase.h:141
+
oboe::AudioStreamBase::mSharingMode
SharingMode mSharingMode
Definition: AudioStreamBase.h:151
+
oboe::SessionId
SessionId
Definition: Definitions.h:394
+
oboe::AudioStreamBase::mDeviceId
int32_t mDeviceId
Definition: AudioStreamBase.h:139
oboe::AudioStreamBuilder::setBufferCapacityInFrames
AudioStreamBuilder * setBufferCapacityInFrames(int32_t bufferCapacityInFrames)
Definition: AudioStreamBuilder.h:109
-
oboe::AudioStreamBuilder::setAudioApi
AudioStreamBuilder * setAudioApi(AudioApi audioApi)
Definition: AudioStreamBuilder.h:125
+
oboe::AudioStreamBuilder::setAudioApi
AudioStreamBuilder * setAudioApi(AudioApi audioApi)
Definition: AudioStreamBuilder.h:132
+
oboe::AudioStreamBase::mUsage
Usage mUsage
Definition: AudioStreamBase.h:160
oboe::AudioStreamBuilder::setFramesPerCallback
AudioStreamBuilder * setFramesPerCallback(int framesPerCallback)
Definition: AudioStreamBuilder.h:84
oboe::AudioStreamBuilder::setFormat
AudioStreamBuilder * setFormat(AudioFormat format)
Definition: AudioStreamBuilder.h:95
-
oboe::AudioStreamBuilder::setSessionId
AudioStreamBuilder * setSessionId(SessionId sessionId)
Definition: AudioStreamBuilder.h:253
-
oboe::AudioStreamBuilder::setCallback
AudioStreamBuilder * setCallback(AudioStreamCallback *streamCallback)
Definition: AudioStreamBuilder.h:293
+
oboe::AudioStreamBuilder::setSessionId
AudioStreamBuilder * setSessionId(SessionId sessionId)
Definition: AudioStreamBuilder.h:260
+
oboe::AudioStreamBase::mFramesPerCallback
int32_t mFramesPerCallback
Definition: AudioStreamBase.h:133
+
oboe::AudioStreamBuilder::setCallback
AudioStreamBuilder * setCallback(AudioStreamCallback *streamCallback)
Definition: AudioStreamBuilder.h:300
oboe
Definition: AudioStream.h:29
oboe::AudioStreamBuilder::setSampleRate
AudioStreamBuilder * setSampleRate(int32_t sampleRate)
Definition: AudioStreamBuilder.h:65
-
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
+
oboe::Direction
Direction
Definition: Definitions.h:87
+
oboe::AudioApi
AudioApi
Definition: Definitions.h:216
+
oboe::ContentType
ContentType
Definition: Definitions.h:327
+
oboe::AudioStreamBase::mDirection
Direction mDirection
Definition: AudioStreamBase.h:155
oboe::AudioStreamBuilder::isAAudioSupported
static bool isAAudioSupported()
-
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
-
oboe::AudioStreamBase
Definition: AudioStreamBase.h:34
-
oboe::AudioStreamBuilder::setSharingMode
AudioStreamBuilder * setSharingMode(SharingMode sharingMode)
Definition: AudioStreamBuilder.h:156
+
oboe::AudioStreamBuilder::getAudioApi
AudioApi getAudioApi() const
Definition: AudioStreamBuilder.h:121
+
oboe::Result
Result
Definition: Definitions.h:140
+
oboe::SharingMode
SharingMode
Definition: Definitions.h:176
+
oboe::AudioStreamBase
Definition: AudioStreamBase.h:29
+
oboe::AudioStreamBase::mStreamCallback
AudioStreamCallback * mStreamCallback
Definition: AudioStreamBase.h:131
+
oboe::AudioFormat
AudioFormat
Definition: Definitions.h:103
+
oboe::AudioStreamBase::mFormat
AudioFormat mFormat
Definition: AudioStreamBase.h:153
+
oboe::AudioStreamBuilder::setSharingMode
AudioStreamBuilder * setSharingMode(SharingMode sharingMode)
Definition: AudioStreamBuilder.h:163
oboe::AudioStreamBuilder::setChannelCount
AudioStreamBuilder * setChannelCount(int channelCount)
Definition: AudioStreamBuilder.h:39
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
-
oboe::AudioStreamBuilder::setPerformanceMode
AudioStreamBuilder * setPerformanceMode(PerformanceMode performanceMode)
Definition: AudioStreamBuilder.h:169
-
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:26
-
oboe::AudioStream
Definition: AudioStream.h:36
-
oboe::Usage
Usage
Definition: Definitions.h:174
+
oboe::InputPreset
InputPreset
Definition: Definitions.h:360
+
oboe::PerformanceMode
PerformanceMode
Definition: Definitions.h:195
+
oboe::AudioStreamBuilder::setPerformanceMode
AudioStreamBuilder * setPerformanceMode(PerformanceMode performanceMode)
Definition: AudioStreamBuilder.h:176
+
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:33
+
oboe::AudioStream
Definition: AudioStream.h:42
+
oboe::Usage
Usage
Definition: Definitions.h:249
diff --git a/docs/reference/a00011_source.html b/docs/reference/a00011_source.html index 3c2af5c9e..79c719fb9 100644 --- a/docs/reference/a00011_source.html +++ b/docs/reference/a00011_source.html @@ -71,12 +71,14 @@
AudioStreamCallback.h
-
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_CALLBACK_H
18 #define OBOE_STREAM_CALLBACK_H
19 
20 #include "oboe/Definitions.h"
21 
22 namespace oboe {
23 
24 class AudioStream;
25 
26 class AudioStreamCallback {
27 public:
28  virtual ~AudioStreamCallback() = default;
29 
38  virtual DataCallbackResult onAudioReady(
39  AudioStream *oboeStream,
40  void *audioData,
41  int32_t numFrames) = 0;
42 
51  virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error) {}
52 
63  virtual void onErrorAfterClose(AudioStream *oboeStream, Result error) {}
64 
65 };
66 
67 } // namespace oboe
68 
69 #endif //OBOE_STREAM_CALLBACK_H
oboe::AudioStreamCallback::onAudioReady
virtual DataCallbackResult onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
-
oboe::AudioStreamCallback::onErrorBeforeClose
virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:51
+
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_STREAM_CALLBACK_H
18 #define OBOE_STREAM_CALLBACK_H
19 
20 #include "oboe/Definitions.h"
21 
22 namespace oboe {
23 
24 class AudioStream;
25 
33 class AudioStreamCallback {
34 public:
35  virtual ~AudioStreamCallback() = default;
36 
45  virtual DataCallbackResult onAudioReady(
46  AudioStream *oboeStream,
47  void *audioData,
48  int32_t numFrames) = 0;
49 
58  virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error) {}
59 
70  virtual void onErrorAfterClose(AudioStream *oboeStream, Result error) {}
71 
72 };
73 
74 } // namespace oboe
75 
76 #endif //OBOE_STREAM_CALLBACK_H
oboe::AudioStreamCallback::onAudioReady
virtual DataCallbackResult onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
+
oboe::AudioStreamCallback::onErrorBeforeClose
virtual void onErrorBeforeClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:58
oboe
Definition: AudioStream.h:29
-
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:26
-
oboe::AudioStreamCallback::onErrorAfterClose
virtual void onErrorAfterClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:63
-
oboe::AudioStream
Definition: AudioStream.h:36
+
oboe::Result
Result
Definition: Definitions.h:140
+
oboe::DataCallbackResult
DataCallbackResult
Definition: Definitions.h:128
+
oboe::AudioStreamCallback
Definition: AudioStreamCallback.h:33
+
oboe::AudioStreamCallback::onErrorAfterClose
virtual void onErrorAfterClose(AudioStream *oboeStream, Result error)
Definition: AudioStreamCallback.h:70
+
oboe::AudioStream
Definition: AudioStream.h:42
diff --git a/docs/reference/a00014_source.html b/docs/reference/a00014_source.html index c2fc1d50d..6985f7d8c 100644 --- a/docs/reference/a00014_source.html +++ b/docs/reference/a00014_source.html @@ -71,45 +71,65 @@
Definitions.h
-
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_DEFINITIONS_H
18 #define OBOE_DEFINITIONS_H
19 
20 #include <cstdint>
21 #include <type_traits>
22 #include <aaudio/AAudio.h>
23 
24 // Ensure that all AAudio primitive data types are int32_t
25 #define ASSERT_INT32(type) static_assert(std::is_same<int32_t, type>::value, \
26 #type" must be int32_t")
27 
28 ASSERT_INT32(aaudio_stream_state_t);
29 ASSERT_INT32(aaudio_direction_t);
30 ASSERT_INT32(aaudio_format_t);
31 ASSERT_INT32(aaudio_data_callback_result_t);
32 ASSERT_INT32(aaudio_result_t);
33 ASSERT_INT32(aaudio_sharing_mode_t);
34 ASSERT_INT32(aaudio_performance_mode_t);
35 
36 namespace oboe {
37 
38  constexpr int32_t kUnspecified = 0;
39 
40  // TODO: Investigate using std::chrono
41  constexpr int64_t kNanosPerMicrosecond = 1000;
42  constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000;
43  constexpr int64_t kMillisPerSecond = 1000;
44  constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond;
45 
46  enum class StreamState : aaudio_stream_state_t {
47  Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED,
48  Unknown = AAUDIO_STREAM_STATE_UNKNOWN,
49  Open = AAUDIO_STREAM_STATE_OPEN,
50  Starting = AAUDIO_STREAM_STATE_STARTING,
51  Started = AAUDIO_STREAM_STATE_STARTED,
52  Pausing = AAUDIO_STREAM_STATE_PAUSING,
53  Paused = AAUDIO_STREAM_STATE_PAUSED,
54  Flushing = AAUDIO_STREAM_STATE_FLUSHING,
55  Flushed = AAUDIO_STREAM_STATE_FLUSHED,
56  Stopping = AAUDIO_STREAM_STATE_STOPPING,
57  Stopped = AAUDIO_STREAM_STATE_STOPPED,
58  Closing = AAUDIO_STREAM_STATE_CLOSING,
59  Closed = AAUDIO_STREAM_STATE_CLOSED,
60  Disconnected = AAUDIO_STREAM_STATE_DISCONNECTED,
61  };
62 
63  enum class Direction : aaudio_direction_t {
64  Output = AAUDIO_DIRECTION_OUTPUT,
65  Input = AAUDIO_DIRECTION_INPUT,
66  };
67 
68  enum class AudioFormat : aaudio_format_t {
69  Invalid = AAUDIO_FORMAT_INVALID,
70  Unspecified = AAUDIO_FORMAT_UNSPECIFIED,
71  I16 = AAUDIO_FORMAT_PCM_I16,
72  Float = AAUDIO_FORMAT_PCM_FLOAT,
73  };
74 
75  enum class DataCallbackResult : aaudio_data_callback_result_t {
76  Continue = AAUDIO_CALLBACK_RESULT_CONTINUE,
77  Stop = AAUDIO_CALLBACK_RESULT_STOP,
78  };
79 
80  enum class Result : aaudio_result_t {
81  OK,
82  ErrorBase = AAUDIO_ERROR_BASE,
83  ErrorDisconnected = AAUDIO_ERROR_DISCONNECTED,
84  ErrorIllegalArgument = AAUDIO_ERROR_ILLEGAL_ARGUMENT,
85  ErrorInternal = AAUDIO_ERROR_INTERNAL,
86  ErrorInvalidState = AAUDIO_ERROR_INVALID_STATE,
87  ErrorInvalidHandle = AAUDIO_ERROR_INVALID_HANDLE,
88  ErrorUnimplemented = AAUDIO_ERROR_UNIMPLEMENTED,
89  ErrorUnavailable = AAUDIO_ERROR_UNAVAILABLE,
90  ErrorNoFreeHandles = AAUDIO_ERROR_NO_FREE_HANDLES,
91  ErrorNoMemory = AAUDIO_ERROR_NO_MEMORY,
92  ErrorNull = AAUDIO_ERROR_NULL,
93  ErrorTimeout = AAUDIO_ERROR_TIMEOUT,
94  ErrorWouldBlock = AAUDIO_ERROR_WOULD_BLOCK,
95  ErrorInvalidFormat = AAUDIO_ERROR_INVALID_FORMAT,
96  ErrorOutOfRange = AAUDIO_ERROR_OUT_OF_RANGE,
97  ErrorNoService = AAUDIO_ERROR_NO_SERVICE,
98  ErrorInvalidRate = AAUDIO_ERROR_INVALID_RATE,
99  // Reserved for future AAudio result types
100  Reserved1,
101  Reserved2,
102  Reserved3,
103  Reserved4,
104  Reserved5,
105  Reserved6,
106  Reserved7,
107  Reserved8,
108  Reserved9,
109  Reserved10,
110  ErrorClosed,
111  };
112 
113  enum class SharingMode : aaudio_sharing_mode_t {
114 
120  Exclusive = AAUDIO_SHARING_MODE_EXCLUSIVE,
121 
126  Shared = AAUDIO_SHARING_MODE_SHARED,
127  };
128 
129  enum class PerformanceMode : aaudio_performance_mode_t {
130 
131  // No particular performance needs. Default.
132  None = AAUDIO_PERFORMANCE_MODE_NONE,
133 
134  // Extending battery life is most important.
135  PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING,
136 
137  // Reducing latency is most important.
138  LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY
139  };
140 
141  enum class AudioApi : int32_t {
145  Unspecified = kUnspecified,
146 
150  OpenSLES,
151 
155  AAudio
156  };
157 
158 // Hard code constants so they can be compiled with versions of the NDK before P.
159 #if __ANDROID_API_LEVEL__ >= __ANDROID_API_P__
160 #define CONSTANT_API_P(hard_constant, soft_constant) (soft_constant)
161 #else
162 #define CONSTANT_API_P(hard_constant, soft_constant) (hard_constant)
163 #endif
164 
174  enum class Usage : aaudio_usage_t {
178  Media = CONSTANT_API_P(1, AAUDIO_USAGE_MEDIA),
179 
183  VoiceCommunication = CONSTANT_API_P(2, AAUDIO_USAGE_VOICE_COMMUNICATION),
184 
188  VoiceCommunicationSignalling = CONSTANT_API_P(3,
189  AAUDIO_USAGE_VOICE_COMMUNICATION_SIGNALLING),
190 
194  Alarm = CONSTANT_API_P(4, AAUDIO_USAGE_ALARM),
195 
200  Notification = CONSTANT_API_P(5, AAUDIO_USAGE_NOTIFICATION),
201 
205  NotificationRingtone = CONSTANT_API_P(6, AAUDIO_USAGE_NOTIFICATION_RINGTONE),
206 
210  NotificationEvent = CONSTANT_API_P(10, AAUDIO_USAGE_NOTIFICATION_EVENT),
211 
215  AssistanceAccessibility = CONSTANT_API_P(11, AAUDIO_USAGE_ASSISTANCE_ACCESSIBILITY),
216 
220  AssistanceNavigationGuidance = CONSTANT_API_P(12,
221  AAUDIO_USAGE_ASSISTANCE_NAVIGATION_GUIDANCE),
222 
226  AssistanceSonification = CONSTANT_API_P(13, AAUDIO_USAGE_ASSISTANCE_SONIFICATION),
227 
231  Game = CONSTANT_API_P(14, AAUDIO_USAGE_GAME),
232 
236  Assistant = CONSTANT_API_P(16, AAUDIO_USAGE_ASSISTANT),
237  };
238 
239 
252  enum ContentType : aaudio_content_type_t {
253 
257  Speech = CONSTANT_API_P(1, AAUDIO_CONTENT_TYPE_SPEECH),
258 
262  Music = CONSTANT_API_P(2, AAUDIO_CONTENT_TYPE_MUSIC),
263 
267  Movie = CONSTANT_API_P(3, AAUDIO_CONTENT_TYPE_MOVIE),
268 
273  Sonification = CONSTANT_API_P(4, AAUDIO_CONTENT_TYPE_SONIFICATION),
274  };
275 
285  enum InputPreset : aaudio_input_preset_t {
289  Generic = CONSTANT_API_P(1, AAUDIO_INPUT_PRESET_GENERIC),
290 
294  Camcorder = CONSTANT_API_P(5, AAUDIO_INPUT_PRESET_CAMCORDER),
295 
299  VoiceRecognition = CONSTANT_API_P(6, AAUDIO_INPUT_PRESET_VOICE_RECOGNITION),
300 
304  VoiceCommunication = CONSTANT_API_P(7, AAUDIO_INPUT_PRESET_VOICE_COMMUNICATION),
305 
311  Unprocessed = CONSTANT_API_P(9, AAUDIO_INPUT_PRESET_UNPROCESSED),
312  };
313 
314  enum SessionId {
322  None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE),
323 
333  Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE),
334  };
335 
336  enum ChannelCount : int32_t {
340  Unspecified = kUnspecified,
341 
345  Mono = 1,
346 
350  Stereo = 2,
351  };
352 
353 #undef CONSTANT_API_P
354 
355  class DefaultStreamValues {
356 
357  public:
358 
377  static int32_t SampleRate;
378  static int32_t FramesPerBurst;
379  static int32_t ChannelCount;
380  };
381 
382 
383 
384 } // namespace oboe
385 
386 #endif // OBOE_DEFINITIONS_H
oboe::Allocate
Definition: Definitions.h:333
-
oboe::VoiceRecognition
Definition: Definitions.h:299
-
oboe::Speech
Definition: Definitions.h:257
-
oboe::ChannelCount
ChannelCount
Definition: Definitions.h:336
+
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_DEFINITIONS_H
18 #define OBOE_DEFINITIONS_H
19 
20 #include <cstdint>
21 #include <type_traits>
22 #include <aaudio/AAudio.h>
23 
24 // Ensure that all AAudio primitive data types are int32_t
25 #define ASSERT_INT32(type) static_assert(std::is_same<int32_t, type>::value, \
26 #type" must be int32_t")
27 
28 ASSERT_INT32(aaudio_stream_state_t);
29 ASSERT_INT32(aaudio_direction_t);
30 ASSERT_INT32(aaudio_format_t);
31 ASSERT_INT32(aaudio_data_callback_result_t);
32 ASSERT_INT32(aaudio_result_t);
33 ASSERT_INT32(aaudio_sharing_mode_t);
34 ASSERT_INT32(aaudio_performance_mode_t);
35 
36 namespace oboe {
37 
41  constexpr int32_t kUnspecified = 0;
42 
43  // TODO: Investigate using std::chrono
47  constexpr int64_t kNanosPerMicrosecond = 1000;
48 
52  constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000;
53 
57  constexpr int64_t kMillisPerSecond = 1000;
58 
62  constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond;
63 
67  enum class StreamState : aaudio_stream_state_t {
68  Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED,
69  Unknown = AAUDIO_STREAM_STATE_UNKNOWN,
70  Open = AAUDIO_STREAM_STATE_OPEN,
71  Starting = AAUDIO_STREAM_STATE_STARTING,
72  Started = AAUDIO_STREAM_STATE_STARTED,
73  Pausing = AAUDIO_STREAM_STATE_PAUSING,
74  Paused = AAUDIO_STREAM_STATE_PAUSED,
75  Flushing = AAUDIO_STREAM_STATE_FLUSHING,
76  Flushed = AAUDIO_STREAM_STATE_FLUSHED,
77  Stopping = AAUDIO_STREAM_STATE_STOPPING,
78  Stopped = AAUDIO_STREAM_STATE_STOPPED,
79  Closing = AAUDIO_STREAM_STATE_CLOSING,
80  Closed = AAUDIO_STREAM_STATE_CLOSED,
81  Disconnected = AAUDIO_STREAM_STATE_DISCONNECTED,
82  };
83 
87  enum class Direction : aaudio_direction_t {
88 
92  Output = AAUDIO_DIRECTION_OUTPUT,
93 
97  Input = AAUDIO_DIRECTION_INPUT,
98  };
99 
103  enum class AudioFormat : aaudio_format_t {
107  Invalid = AAUDIO_FORMAT_INVALID,
108 
112  Unspecified = AAUDIO_FORMAT_UNSPECIFIED,
113 
117  I16 = AAUDIO_FORMAT_PCM_I16,
118 
122  Float = AAUDIO_FORMAT_PCM_FLOAT,
123  };
124 
128  enum class DataCallbackResult : aaudio_data_callback_result_t {
129  // Indicates to the caller that the callbacks should continue.
130  Continue = AAUDIO_CALLBACK_RESULT_CONTINUE,
131 
132  // Indicates to the caller that the callbacks should stop immediately.
133  Stop = AAUDIO_CALLBACK_RESULT_STOP,
134  };
135 
140  enum class Result : aaudio_result_t {
141  OK,
142  ErrorBase = AAUDIO_ERROR_BASE,
143  ErrorDisconnected = AAUDIO_ERROR_DISCONNECTED,
144  ErrorIllegalArgument = AAUDIO_ERROR_ILLEGAL_ARGUMENT,
145  ErrorInternal = AAUDIO_ERROR_INTERNAL,
146  ErrorInvalidState = AAUDIO_ERROR_INVALID_STATE,
147  ErrorInvalidHandle = AAUDIO_ERROR_INVALID_HANDLE,
148  ErrorUnimplemented = AAUDIO_ERROR_UNIMPLEMENTED,
149  ErrorUnavailable = AAUDIO_ERROR_UNAVAILABLE,
150  ErrorNoFreeHandles = AAUDIO_ERROR_NO_FREE_HANDLES,
151  ErrorNoMemory = AAUDIO_ERROR_NO_MEMORY,
152  ErrorNull = AAUDIO_ERROR_NULL,
153  ErrorTimeout = AAUDIO_ERROR_TIMEOUT,
154  ErrorWouldBlock = AAUDIO_ERROR_WOULD_BLOCK,
155  ErrorInvalidFormat = AAUDIO_ERROR_INVALID_FORMAT,
156  ErrorOutOfRange = AAUDIO_ERROR_OUT_OF_RANGE,
157  ErrorNoService = AAUDIO_ERROR_NO_SERVICE,
158  ErrorInvalidRate = AAUDIO_ERROR_INVALID_RATE,
159  // Reserved for future AAudio result types
160  Reserved1,
161  Reserved2,
162  Reserved3,
163  Reserved4,
164  Reserved5,
165  Reserved6,
166  Reserved7,
167  Reserved8,
168  Reserved9,
169  Reserved10,
170  ErrorClosed,
171  };
172 
176  enum class SharingMode : aaudio_sharing_mode_t {
177 
183  Exclusive = AAUDIO_SHARING_MODE_EXCLUSIVE,
184 
189  Shared = AAUDIO_SHARING_MODE_SHARED,
190  };
191 
195  enum class PerformanceMode : aaudio_performance_mode_t {
196 
200  None = AAUDIO_PERFORMANCE_MODE_NONE,
201 
205  PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING,
206 
210  LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY
211  };
212 
216  enum class AudioApi : int32_t {
220  Unspecified = kUnspecified,
221 
225  OpenSLES,
226 
230  AAudio
231  };
232 
233 // Hard code constants so they can be compiled with versions of the NDK before P.
234 #if __ANDROID_API_LEVEL__ >= __ANDROID_API_P__
235 #define CONSTANT_API_P(hard_constant, soft_constant) (soft_constant)
236 #else
237 #define CONSTANT_API_P(hard_constant, soft_constant) (hard_constant)
238 #endif
239 
249  enum class Usage : aaudio_usage_t {
253  Media = CONSTANT_API_P(1, AAUDIO_USAGE_MEDIA),
254 
258  VoiceCommunication = CONSTANT_API_P(2, AAUDIO_USAGE_VOICE_COMMUNICATION),
259 
263  VoiceCommunicationSignalling = CONSTANT_API_P(3,
264  AAUDIO_USAGE_VOICE_COMMUNICATION_SIGNALLING),
265 
269  Alarm = CONSTANT_API_P(4, AAUDIO_USAGE_ALARM),
270 
275  Notification = CONSTANT_API_P(5, AAUDIO_USAGE_NOTIFICATION),
276 
280  NotificationRingtone = CONSTANT_API_P(6, AAUDIO_USAGE_NOTIFICATION_RINGTONE),
281 
285  NotificationEvent = CONSTANT_API_P(10, AAUDIO_USAGE_NOTIFICATION_EVENT),
286 
290  AssistanceAccessibility = CONSTANT_API_P(11, AAUDIO_USAGE_ASSISTANCE_ACCESSIBILITY),
291 
295  AssistanceNavigationGuidance = CONSTANT_API_P(12,
296  AAUDIO_USAGE_ASSISTANCE_NAVIGATION_GUIDANCE),
297 
301  AssistanceSonification = CONSTANT_API_P(13, AAUDIO_USAGE_ASSISTANCE_SONIFICATION),
302 
306  Game = CONSTANT_API_P(14, AAUDIO_USAGE_GAME),
307 
311  Assistant = CONSTANT_API_P(16, AAUDIO_USAGE_ASSISTANT),
312  };
313 
314 
327  enum ContentType : aaudio_content_type_t {
328 
332  Speech = CONSTANT_API_P(1, AAUDIO_CONTENT_TYPE_SPEECH),
333 
337  Music = CONSTANT_API_P(2, AAUDIO_CONTENT_TYPE_MUSIC),
338 
342  Movie = CONSTANT_API_P(3, AAUDIO_CONTENT_TYPE_MOVIE),
343 
348  Sonification = CONSTANT_API_P(4, AAUDIO_CONTENT_TYPE_SONIFICATION),
349  };
350 
360  enum InputPreset : aaudio_input_preset_t {
364  Generic = CONSTANT_API_P(1, AAUDIO_INPUT_PRESET_GENERIC),
365 
369  Camcorder = CONSTANT_API_P(5, AAUDIO_INPUT_PRESET_CAMCORDER),
370 
374  VoiceRecognition = CONSTANT_API_P(6, AAUDIO_INPUT_PRESET_VOICE_RECOGNITION),
375 
379  VoiceCommunication = CONSTANT_API_P(7, AAUDIO_INPUT_PRESET_VOICE_COMMUNICATION),
380 
386  Unprocessed = CONSTANT_API_P(9, AAUDIO_INPUT_PRESET_UNPROCESSED),
387  };
388 
394  enum SessionId {
400  None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE),
401 
409  Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE),
410  };
411 
422  enum ChannelCount : int32_t {
426  Unspecified = kUnspecified,
427 
431  Mono = 1,
432 
436  Stereo = 2,
437  };
438 
439 #undef CONSTANT_API_P
440 
459  class DefaultStreamValues {
460 
461  public:
462 
464  static int32_t SampleRate;
466  static int32_t FramesPerBurst;
468  static int32_t ChannelCount;
469 
470  };
471 
472 
473 
474 } // namespace oboe
475 
476 #endif // OBOE_DEFINITIONS_H
oboe::Allocate
Definition: Definitions.h:409
+
oboe::VoiceRecognition
Definition: Definitions.h:374
+
oboe::kNanosPerMillisecond
constexpr int64_t kNanosPerMillisecond
Definition: Definitions.h:52
+
oboe::Speech
Definition: Definitions.h:332
+
oboe::ChannelCount
ChannelCount
Definition: Definitions.h:422
+ +
oboe::DefaultStreamValues::FramesPerBurst
static int32_t FramesPerBurst
Definition: Definitions.h:466
+
oboe::DefaultStreamValues::ChannelCount
static int32_t ChannelCount
Definition: Definitions.h:468
-
oboe::VoiceCommunication
Definition: Definitions.h:304
-
oboe::SessionId
SessionId
Definition: Definitions.h:314
-
oboe::DefaultStreamValues::SampleRate
static int32_t SampleRate
Definition: Definitions.h:377
+ +
oboe::VoiceCommunication
Definition: Definitions.h:379
+
oboe::kNanosPerMicrosecond
constexpr int64_t kNanosPerMicrosecond
Definition: Definitions.h:47
+ +
oboe::SessionId
SessionId
Definition: Definitions.h:394
+
oboe::DefaultStreamValues::SampleRate
static int32_t SampleRate
Definition: Definitions.h:464
-
oboe::None
Definition: Definitions.h:322
-
oboe::Unspecified
Definition: Definitions.h:340
-
oboe::Unprocessed
Definition: Definitions.h:311
-
oboe::Movie
Definition: Definitions.h:267
+
oboe::None
Definition: Definitions.h:400
+
oboe::Unspecified
Definition: Definitions.h:426
+
oboe::Unprocessed
Definition: Definitions.h:386
+
oboe::Movie
Definition: Definitions.h:342
-
oboe::Stereo
Definition: Definitions.h:350
-
oboe::Music
Definition: Definitions.h:262
+ +
oboe::Stereo
Definition: Definitions.h:436
+
oboe::Music
Definition: Definitions.h:337
+
oboe::kNanosPerSecond
constexpr int64_t kNanosPerSecond
Definition: Definitions.h:62
-
oboe::Generic
Definition: Definitions.h:289
+
oboe::Generic
Definition: Definitions.h:364
oboe
Definition: AudioStream.h:29
+
oboe::Direction
Direction
Definition: Definitions.h:87
-
oboe::AudioApi
AudioApi
Definition: Definitions.h:141
-
oboe::ContentType
ContentType
Definition: Definitions.h:252
-
oboe::DefaultStreamValues
Definition: Definitions.h:355
-
oboe::SharingMode
SharingMode
Definition: Definitions.h:113
-
oboe::Camcorder
Definition: Definitions.h:294
-
oboe::Mono
Definition: Definitions.h:345
+
oboe::AudioApi
AudioApi
Definition: Definitions.h:216
+
oboe::ContentType
ContentType
Definition: Definitions.h:327
+ +
oboe::DefaultStreamValues
Definition: Definitions.h:459
+
oboe::Result
Result
Definition: Definitions.h:140
+
oboe::SharingMode
SharingMode
Definition: Definitions.h:176
+
oboe::Camcorder
Definition: Definitions.h:369
+
oboe::AudioFormat
AudioFormat
Definition: Definitions.h:103
+
oboe::kMillisPerSecond
constexpr int64_t kMillisPerSecond
Definition: Definitions.h:57
+
oboe::Mono
Definition: Definitions.h:431
+
oboe::DataCallbackResult
DataCallbackResult
Definition: Definitions.h:128
-
oboe::InputPreset
InputPreset
Definition: Definitions.h:285
+
oboe::InputPreset
InputPreset
Definition: Definitions.h:360
+ +
oboe::kUnspecified
constexpr int32_t kUnspecified
Definition: Definitions.h:41
+
oboe::PerformanceMode
PerformanceMode
Definition: Definitions.h:195
+ -
oboe::Sonification
Definition: Definitions.h:273
+
oboe::Sonification
Definition: Definitions.h:348
+
oboe::StreamState
StreamState
Definition: Definitions.h:67
-
oboe::Usage
Usage
Definition: Definitions.h:174
+
oboe::Usage
Usage
Definition: Definitions.h:249
diff --git a/docs/reference/a00017_source.html b/docs/reference/a00017_source.html index e4ed0f402..0ea1a32bb 100644 --- a/docs/reference/a00017_source.html +++ b/docs/reference/a00017_source.html @@ -71,11 +71,13 @@
LatencyTuner.h
-
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_LATENCY_TUNER_
18 #define OBOE_LATENCY_TUNER_
19 
20 #include <atomic>
21 #include <cstdint>
22 #include "oboe/Definitions.h"
23 #include "oboe/AudioStream.h"
24 
25 namespace oboe {
26 
42 class LatencyTuner {
43 public:
44  explicit LatencyTuner(AudioStream &stream);
45 
54  Result tune();
55 
64  void requestReset();
65 
66 private:
67 
74  void reset();
75 
76  enum class State {
77  Idle,
78  Active,
79  AtMax,
80  Unsupported
81  } ;
82 
83  // arbitrary number of calls to wait before bumping up the latency
84  static constexpr int32_t kIdleCount = 8;
85 
86  AudioStream &mStream;
87  State mState = State::Idle;
88  int32_t mPreviousXRuns = 0;
89  int32_t mIdleCountDown = 0;
90  std::atomic<int32_t> mLatencyTriggerRequests{0}; // TODO user atomic requester from AAudio
91  std::atomic<int32_t> mLatencyTriggerResponses{0};
92 };
93 
94 } // namespace oboe
95 
96 #endif // OBOE_LATENCY_TUNER_
oboe::LatencyTuner
Definition: LatencyTuner.h:42
+
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_LATENCY_TUNER_
18 #define OBOE_LATENCY_TUNER_
19 
20 #include <atomic>
21 #include <cstdint>
22 #include "oboe/Definitions.h"
23 #include "oboe/AudioStream.h"
24 
25 namespace oboe {
26 
41 class LatencyTuner {
42 public:
43 
49  explicit LatencyTuner(AudioStream &stream);
50 
59  Result tune();
60 
69  void requestReset();
70 
71 private:
72 
79  void reset();
80 
81  enum class State {
82  Idle,
83  Active,
84  AtMax,
85  Unsupported
86  } ;
87 
88  // arbitrary number of calls to wait before bumping up the latency
89  static constexpr int32_t kIdleCount = 8;
90 
91  AudioStream &mStream;
92  State mState = State::Idle;
93  int32_t mPreviousXRuns = 0;
94  int32_t mIdleCountDown = 0;
95  std::atomic<int32_t> mLatencyTriggerRequests{0}; // TODO user atomic requester from AAudio
96  std::atomic<int32_t> mLatencyTriggerResponses{0};
97 };
98 
99 } // namespace oboe
100 
101 #endif // OBOE_LATENCY_TUNER_
oboe::LatencyTuner
Definition: LatencyTuner.h:41
+
oboe::LatencyTuner::LatencyTuner
LatencyTuner(AudioStream &stream)
oboe
Definition: AudioStream.h:29
+
oboe::Result
Result
Definition: Definitions.h:140
-
oboe::AudioStream
Definition: AudioStream.h:36
+
oboe::AudioStream
Definition: AudioStream.h:42
diff --git a/docs/reference/a00023_source.html b/docs/reference/a00023_source.html index e24f9e2a0..3d1bc9356 100644 --- a/docs/reference/a00023_source.html +++ b/docs/reference/a00023_source.html @@ -71,11 +71,16 @@
ResultWithValue.h
-
1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_RESULT_WITH_VALUE_H
18 #define OBOE_RESULT_WITH_VALUE_H
19 
20 #include "oboe/Definitions.h"
21 #include <iostream>
22 #include <sstream>
23 
24 namespace oboe {
25 
26 template <typename T>
27 class ResultWithValue {
28 public:
29  ResultWithValue(oboe::Result error)
30  : mValue{}
31  , mError(error) {}
32 
33  explicit ResultWithValue(T value)
34  : mValue(value)
35  , mError(oboe::Result::OK) {}
36 
37  oboe::Result error() const {
38  return mError;
39  }
40 
41  T value() const {
42  return mValue;
43  }
44 
48  explicit operator bool() const { return mError == oboe::Result::OK; }
49 
60  bool operator !() const { return mError != oboe::Result::OK; }
61 
70  operator Result() const {
71  return mError;
72  }
73 
81  static ResultWithValue<T> createBasedOnSign(T numericResult){
82 
83  // Ensure that the type is either an integer or float
84  static_assert(std::is_arithmetic<T>::value,
85  "createBasedOnSign can only be called for numeric types (int or float)");
86 
87  if (numericResult >= 0){
88  return ResultWithValue<T>(numericResult);
89  } else {
90  return ResultWithValue<T>(static_cast<Result>(numericResult));
91  }
92  }
93 
94 private:
95  const T mValue;
96  const oboe::Result mError;
97 };
98 
99 template <typename T>
100 std::ostream& operator<<(std::ostream &strm, const ResultWithValue<T> &result) {
101  if (!result) {
102  strm << convertToText(result.error());
103  } else {
104  strm << result.value();
105  }
106  return strm;
107 }
108 
109 } // namespace oboe
110 
111 
112 #endif //OBOE_RESULT_WITH_VALUE_H
oboe::convertToText
const char * convertToText(FromType)
-
oboe::ResultWithValue::createBasedOnSign
static ResultWithValue< T > createBasedOnSign(T numericResult)
Definition: ResultWithValue.h:81
-
oboe::ResultWithValue::operator!
bool operator!() const
Definition: ResultWithValue.h:60
+
1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_RESULT_WITH_VALUE_H
18 #define OBOE_RESULT_WITH_VALUE_H
19 
20 #include "oboe/Definitions.h"
21 #include <iostream>
22 #include <sstream>
23 
24 namespace oboe {
25 
46 template <typename T>
47 class ResultWithValue {
48 public:
49 
55  ResultWithValue(oboe::Result error)
56  : mValue{}
57  , mError(error) {}
58 
64  explicit ResultWithValue(T value)
65  : mValue(value)
66  , mError(oboe::Result::OK) {}
67 
73  oboe::Result error() const {
74  return mError;
75  }
76 
81  T value() const {
82  return mValue;
83  }
84 
88  explicit operator bool() const { return mError == oboe::Result::OK; }
89 
100  bool operator !() const { return mError != oboe::Result::OK; }
101 
110  operator Result() const {
111  return mError;
112  }
113 
121  static ResultWithValue<T> createBasedOnSign(T numericResult){
122 
123  // Ensure that the type is either an integer or float
124  static_assert(std::is_arithmetic<T>::value,
125  "createBasedOnSign can only be called for numeric types (int or float)");
126 
127  if (numericResult >= 0){
128  return ResultWithValue<T>(numericResult);
129  } else {
130  return ResultWithValue<T>(static_cast<Result>(numericResult));
131  }
132  }
133 
134 private:
135  const T mValue;
136  const oboe::Result mError;
137 };
138 
142 template <typename T>
143 std::ostream& operator<<(std::ostream &strm, const ResultWithValue<T> &result) {
144  if (!result) {
145  strm << convertToText(result.error());
146  } else {
147  strm << result.value();
148  }
149  return strm;
150 }
151 
152 } // namespace oboe
153 
154 
155 #endif //OBOE_RESULT_WITH_VALUE_H
oboe::ResultWithValue::ResultWithValue
ResultWithValue(oboe::Result error)
Definition: ResultWithValue.h:55
+
oboe::convertToText
const char * convertToText(FromType input)
+
oboe::ResultWithValue::ResultWithValue
ResultWithValue(T value)
Definition: ResultWithValue.h:64
+
oboe::ResultWithValue::error
oboe::Result error() const
Definition: ResultWithValue.h:73
+
oboe::ResultWithValue::value
T value() const
Definition: ResultWithValue.h:81
+
oboe::ResultWithValue::createBasedOnSign
static ResultWithValue< T > createBasedOnSign(T numericResult)
Definition: ResultWithValue.h:121
+
oboe::ResultWithValue::operator!
bool operator!() const
Definition: ResultWithValue.h:100
oboe
Definition: AudioStream.h:29
-
oboe::ResultWithValue
Definition: ResultWithValue.h:27
+
oboe::Result
Result
Definition: Definitions.h:140
+
oboe::ResultWithValue
Definition: ResultWithValue.h:47
diff --git a/docs/reference/a00026_source.html b/docs/reference/a00026_source.html index 2200dd40d..fac5d500f 100644 --- a/docs/reference/a00026_source.html +++ b/docs/reference/a00026_source.html @@ -71,10 +71,13 @@
Utilities.h
-
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_UTILITIES_H
18 #define OBOE_UTILITIES_H
19 
20 #include <unistd.h>
21 #include <sys/types.h>
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
26 void convertFloatToPcm16(const float *source, int16_t *destination, int32_t numSamples);
27 void convertPcm16ToFloat(const int16_t *source, float *destination, int32_t numSamples);
28 
32 int32_t convertFormatToSizeInBytes(AudioFormat format);
33 
43 template <typename FromType>
44 const char * convertToText(FromType);
45 
54 int getSdkVersion();
55 
56 } // namespace oboe
57 
58 #endif //OBOE_UTILITIES_H
oboe::convertToText
const char * convertToText(FromType)
+
1 /*
2  * Copyright 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_UTILITIES_H
18 #define OBOE_UTILITIES_H
19 
20 #include <unistd.h>
21 #include <sys/types.h>
22 #include "oboe/Definitions.h"
23 
24 namespace oboe {
25 
33 void convertFloatToPcm16(const float *source, int16_t *destination, int32_t numSamples);
34 
42 void convertPcm16ToFloat(const int16_t *source, float *destination, int32_t numSamples);
43 
47 int32_t convertFormatToSizeInBytes(AudioFormat format);
48 
58 template <typename FromType>
59 const char * convertToText(FromType input);
60 
69 int getSdkVersion();
70 
71 } // namespace oboe
72 
73 #endif //OBOE_UTILITIES_H
oboe::convertToText
const char * convertToText(FromType input)
oboe::convertFormatToSizeInBytes
int32_t convertFormatToSizeInBytes(AudioFormat format)
oboe::getSdkVersion
int getSdkVersion()
+
oboe::convertFloatToPcm16
void convertFloatToPcm16(const float *source, int16_t *destination, int32_t numSamples)
oboe
Definition: AudioStream.h:29
+
oboe::convertPcm16ToFloat
void convertPcm16ToFloat(const int16_t *source, float *destination, int32_t numSamples)
+
oboe::AudioFormat
AudioFormat
Definition: Definitions.h:103
diff --git a/docs/reference/a00029_source.html b/docs/reference/a00029_source.html index 005f00d60..9341f7527 100644 --- a/docs/reference/a00029_source.html +++ b/docs/reference/a00029_source.html @@ -71,13 +71,13 @@
Version.h
-
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_VERSIONINFO_H
18 #define OBOE_VERSIONINFO_H
19 
31 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
32 #define OBOE_VERSION_MAJOR 0
33 
34 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
35 #define OBOE_VERSION_MINOR 12
36 
37 // Type: 16-bit unsigned int. Min value: 0 Max value: 65535. See below for description.
38 #define OBOE_VERSION_PATCH 0
39 
40 #define OBOE_STRINGIFY(x) #x
41 #define OBOE_TOSTRING(x) OBOE_STRINGIFY(x)
42 
43 // Type: String literal. See below for description.
44 #define OBOE_VERSION_TEXT \
45  OBOE_TOSTRING(OBOE_VERSION_MAJOR) "." \
46  OBOE_TOSTRING(OBOE_VERSION_MINOR) "." \
47  OBOE_TOSTRING(OBOE_VERSION_PATCH)
48 
49 // Type: 32-bit unsigned int. See below for description.
50 #define OBOE_VERSION_NUMBER ((OBOE_VERSION_MAJOR << 24) | (OBOE_VERSION_MINOR << 16) | OBOE_VERSION_PATCH)
51 
52 namespace oboe {
53 
54 struct Version {
58  static constexpr uint8_t Major = OBOE_VERSION_MAJOR;
59 
64  static constexpr uint8_t Minor = OBOE_VERSION_MINOR;
65 
70  static constexpr uint16_t Patch = OBOE_VERSION_PATCH;
71 
75  static constexpr const char * Text = OBOE_VERSION_TEXT;
76 
81  static constexpr uint32_t Number = OBOE_VERSION_NUMBER;
82 };
83 
84 } // namespace oboe
85 #endif //OBOE_VERSIONINFO_H
oboe::Version::Minor
static constexpr uint8_t Minor
Definition: Version.h:64
-
oboe::Version
Definition: Version.h:54
+
1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef OBOE_VERSIONINFO_H
18 #define OBOE_VERSIONINFO_H
19 
31 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
32 #define OBOE_VERSION_MAJOR 0
33 
34 // Type: 8-bit unsigned int. Min value: 0 Max value: 255. See below for description.
35 #define OBOE_VERSION_MINOR 12
36 
37 // Type: 16-bit unsigned int. Min value: 0 Max value: 65535. See below for description.
38 #define OBOE_VERSION_PATCH 0
39 
40 #define OBOE_STRINGIFY(x) #x
41 #define OBOE_TOSTRING(x) OBOE_STRINGIFY(x)
42 
43 // Type: String literal. See below for description.
44 #define OBOE_VERSION_TEXT \
45  OBOE_TOSTRING(OBOE_VERSION_MAJOR) "." \
46  OBOE_TOSTRING(OBOE_VERSION_MINOR) "." \
47  OBOE_TOSTRING(OBOE_VERSION_PATCH)
48 
49 // Type: 32-bit unsigned int. See below for description.
50 #define OBOE_VERSION_NUMBER ((OBOE_VERSION_MAJOR << 24) | (OBOE_VERSION_MINOR << 16) | OBOE_VERSION_PATCH)
51 
52 namespace oboe {
53 
57 struct Version {
61  static constexpr uint8_t Major = OBOE_VERSION_MAJOR;
62 
67  static constexpr uint8_t Minor = OBOE_VERSION_MINOR;
68 
73  static constexpr uint16_t Patch = OBOE_VERSION_PATCH;
74 
78  static constexpr const char * Text = OBOE_VERSION_TEXT;
79 
84  static constexpr uint32_t Number = OBOE_VERSION_NUMBER;
85 };
86 
87 } // namespace oboe
88 #endif //OBOE_VERSIONINFO_H
oboe::Version::Minor
static constexpr uint8_t Minor
Definition: Version.h:67
+
oboe::Version
Definition: Version.h:57
oboe
Definition: AudioStream.h:29
-
oboe::Version::Patch
static constexpr uint16_t Patch
Definition: Version.h:70
-
oboe::Version::Text
static constexpr const char * Text
Definition: Version.h:75
-
oboe::Version::Major
static constexpr uint8_t Major
Definition: Version.h:58
-
oboe::Version::Number
static constexpr uint32_t Number
Definition: Version.h:81
+
oboe::Version::Patch
static constexpr uint16_t Patch
Definition: Version.h:73
+
oboe::Version::Text
static constexpr const char * Text
Definition: Version.h:78
+
oboe::Version::Major
static constexpr uint8_t Major
Definition: Version.h:61
+
oboe::Version::Number
static constexpr uint32_t Number
Definition: Version.h:84
diff --git a/docs/reference/a00032.html b/docs/reference/a00032.html index 339fc68cc..bdf507f7b 100644 --- a/docs/reference/a00032.html +++ b/docs/reference/a00032.html @@ -94,7 +94,7 @@ - - - - - -

Enumerations

enum  StreamState : aaudio_stream_state_t {
+
enum  StreamState : aaudio_stream_state_t {
  Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED, Unknown = AAUDIO_STREAM_STATE_UNKNOWN, Open = AAUDIO_STREAM_STATE_OPEN, @@ -115,21 +115,21 @@
}
 
enum  Direction : aaudio_direction_t { Output = AAUDIO_DIRECTION_OUTPUT, -Input = AAUDIO_DIRECTION_INPUT +
enum  Direction : aaudio_direction_t { Direction::Output = AAUDIO_DIRECTION_OUTPUT, +Direction::Input = AAUDIO_DIRECTION_INPUT }
 
enum  AudioFormat : aaudio_format_t { Invalid = AAUDIO_FORMAT_INVALID, -Unspecified = AAUDIO_FORMAT_UNSPECIFIED, -I16 = AAUDIO_FORMAT_PCM_I16, -Float = AAUDIO_FORMAT_PCM_FLOAT +
enum  AudioFormat : aaudio_format_t { AudioFormat::Invalid = AAUDIO_FORMAT_INVALID, +Unspecified = AAUDIO_FORMAT_UNSPECIFIED, +AudioFormat::I16 = AAUDIO_FORMAT_PCM_I16, +AudioFormat::Float = AAUDIO_FORMAT_PCM_FLOAT }
 
enum  DataCallbackResult : aaudio_data_callback_result_t { Continue = AAUDIO_CALLBACK_RESULT_CONTINUE, +
enum  DataCallbackResult : aaudio_data_callback_result_t { Continue = AAUDIO_CALLBACK_RESULT_CONTINUE, Stop = AAUDIO_CALLBACK_RESULT_STOP }
 
enum  Result : aaudio_result_t {
+
enum  Result : aaudio_result_t {
  OK, ErrorBase = AAUDIO_ERROR_BASE, ErrorDisconnected = AAUDIO_ERROR_DISCONNECTED, @@ -173,9 +173,9 @@ SharingMode::Shared = AAUDIO_SHARING_MODE_SHARED }
 
enum  PerformanceMode : aaudio_performance_mode_t { None = AAUDIO_PERFORMANCE_MODE_NONE, -PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING, -LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY +
enum  PerformanceMode : aaudio_performance_mode_t { None = AAUDIO_PERFORMANCE_MODE_NONE, +PerformanceMode::PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING, +PerformanceMode::LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY }
 
enum  AudioApi : int32_t { Unspecified = kUnspecified, @@ -219,13 +219,13 @@ }
 
enum  SessionId { None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE), -None = AAUDIO_PERFORMANCE_MODE_NONE, +None = AAUDIO_PERFORMANCE_MODE_NONE, Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE) }
 
enum  ChannelCount : int32_t {
  Unspecified = kUnspecified, -Unspecified = AAUDIO_FORMAT_UNSPECIFIED, +Unspecified = AAUDIO_FORMAT_UNSPECIFIED, Unspecified = kUnspecified, Mono = 1,
@@ -236,43 +236,34 @@
- - + + - + - + - + - - - + + +

Functions

-template<typename T >
std::ostream & operator<< (std::ostream &strm, const ResultWithValue< T > &result)
template<typename T >
std::ostream & operator<< (std::ostream &strm, const ResultWithValue< T > &result)
 
-void convertFloatToPcm16 (const float *source, int16_t *destination, int32_t numSamples)
void convertFloatToPcm16 (const float *source, int16_t *destination, int32_t numSamples)
 
-void convertPcm16ToFloat (const int16_t *source, float *destination, int32_t numSamples)
void convertPcm16ToFloat (const int16_t *source, float *destination, int32_t numSamples)
 
int32_t convertFormatToSizeInBytes (AudioFormat format)
int32_t convertFormatToSizeInBytes (AudioFormat format)
 
template<typename FromType >
const char * convertToText (FromType)
 
template<typename FromType >
const char * convertToText (FromType input)
 
int getSdkVersion ()
 
- + - + - + - + - + - +

Variables

-constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond)
constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond)
 
-constexpr int32_t kUnspecified = 0
constexpr int32_t kUnspecified = 0
 
-constexpr int64_t kNanosPerMicrosecond = 1000
constexpr int64_t kNanosPerMicrosecond = 1000
 
-constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000
constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000
 
-constexpr int64_t kMillisPerSecond = 1000
constexpr int64_t kMillisPerSecond = 1000
 
-constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond
constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond
 

Detailed Description

@@ -297,6 +288,7 @@

+

The underlying audio API used by the audio stream.

@@ -306,6 +298,39 @@

+

◆ AudioFormat

+ +
+
+

Enumerator
Unspecified 

Try to use AAudio. If not available then use OpenSL ES.

+ + + + +
+ + + + +
enum oboe::AudioFormat : aaudio_format_t
+ 		+strong
+

+

The format of audio samples.

+ + + + + +
Enumerator
Invalid 

Invalid format.

+
Unspecified 

Unspecified format. Format will be decided by Oboe.

+
I16 

Signed 16-bit integers.

+
Float 

Single precision floating points.

+
+
@@ -319,9 +344,13 @@

+

The channel count of the audio stream. The underlying type is int32_t. Use of this enum is convenient to avoid "magic" numbers when specifying the channel count.

+

For example, you can write builder.setChannelCount(ChannelCount::Stereo) rather than builder.setChannelCount(2)

+ - + @@ -512,8 +716,51 @@

-

◆ convertToText()

+ +

◆ convertPcm16ToFloat()

+ +
+
+

Enumerator
Unspecified 

Audio channel count definition, use Mono or Stereo

Unspecified 

Unspecified format. Format will be decided by Oboe.

+
Unspecified 

Try to use AAudio. If not available then use OpenSL ES.

Mono 

Use this for mono audio

@@ -343,9 +372,9 @@

-

The CONTENT_TYPE attribute describes "what" you are playing. It expresses the general category of the content. This information is optional. But in case it is known (for instance AAUDIO_CONTENT_TYPE_MOVIE for a movie streaming service or AAUDIO_CONTENT_TYPE_SPEECH for an audio book application) this information might be used by the audio framework to enforce audio focus.

+

The ContentType attribute describes what you are playing. It expresses the general category of the content. This information is optional. But in case it is known (for instance Movie for a movie streaming service or Speech for an audio book application) this information might be used by the audio framework to enforce audio focus.

Note that these match the equivalent values in AudioAttributes in the Android Java API.

-

Added in API level 28.

+

This attribute only has an effect on Android API 28+.

@@ -357,6 +386,58 @@

+

◆ DataCallbackResult

+ +
+
+

Enumerator
Speech 

Use this for spoken voice, audio books, etcetera.

+ + + + +
+ + + + +
enum oboe::DataCallbackResult : aaudio_data_callback_result_t
+ 		+strong
+
+

The result of an audio callback.

+ +
+ + +

◆ Direction

+ +
+
+ + + + + +
+ + + + +
enum oboe::Direction : aaudio_direction_t
+ 		+strong
+
+

The direction of the stream.

+ + + +
Enumerator
Output 

Used for playback.

+
Input 

Used for recording.

+
+
@@ -372,7 +453,7 @@

Defines the audio source. An audio source defines both a default physical source of audio signal, and a recording configuration.

Note that these match the equivalent values in MediaRecorder.AudioSource in the Android Java API.

-

Added in API level 28.

+

This attribute only has an effect on Android API 28+.

@@ -388,6 +469,60 @@

+

◆ PerformanceMode

+ +
+
+

Enumerator
Generic 

Use this preset when other presets do not apply.

+ + + + +
+ + + + +
enum oboe::PerformanceMode : aaudio_performance_mode_t
+ 		+strong
+
+

The performance mode of the audio stream.

+ + + + +
Enumerator
None 

No particular performance needs. Default.

+
PowerSaving 

Extending battery life is most important.

+
LowLatency 

Reducing latency is most important.

+
+ +
+ + +

◆ Result

+ +
+
+ + + + + +
+ + + + +
enum oboe::Result : aaudio_result_t
+ 		+strong
+
+

The result of an operation. All except the OK result indicates that an error occurred. The Result can be converted into a human readable string using convertToText.

+
@@ -401,13 +536,15 @@

+

This attribute can be used to allocate a session ID to the audio stream.

+

This attribute only has an effect on Android API 28+.

- +
Enumerator
None 

Do not allocate a session ID. Effects cannot be used with this stream. Default.

-

Added in API level 28.

+
Enumerator
None 

Do not allocate a session ID. Effects cannot be used with this stream. Default.

+
None 

No particular performance needs. Default.

Allocate 

Allocate a session ID that can be used to attach and control effects using the Java AudioEffects API. Note that the use of this flag may result in higher latency.

-

Note that this matches the value of AudioManager.AUDIO_SESSION_ID_GENERATE.

-

Added in API level 28.

+

Note that this matches the value of AudioManager.AUDIO_SESSION_ID_GENERATE.

@@ -432,6 +569,7 @@

+

The sharing mode of the audio stream.

@@ -439,6 +577,29 @@

+

◆ StreamState

+ +
+
+

Enumerator
Exclusive 

This will be the only stream using a particular source or sink. This mode will provide the lowest possible latency. You should close EXCLUSIVE streams immediately when you are not using them.

+ + + + +
+ + + + +
enum oboe::StreamState : aaudio_stream_state_t
+ 		+strong
+
+

The state of the audio stream.

+
@@ -460,9 +621,9 @@

-

The Usage attribute expresses "why" you are playing a sound, what is this sound used for. This information is used by certain platforms or routing policies to make more refined volume or routing decisions.

+

The Usage attribute expresses why you are playing a sound, what is this sound used for. This information is used by certain platforms or routing policies to make more refined volume or routing decisions.

Note that these match the equivalent values in AudioAttributes in the Android Java API.

-

Added in API level 28.

+

This attribute only has an effect on Android API 28+.

@@ -493,6 +654,49 @@

Function Documentation

+ +

◆ convertFloatToPcm16()

+ +
+
+
Enumerator
Media 

Use this for streaming media, music performance, video, podcasts, etcetera.

+ + + + + + + + + + + + + + + + + + + + + + + +
void oboe::convertFloatToPcm16 (const float * source,
int16_t * destination,
int32_t numSamples 
)
+
+

Convert an array of floats to an array of 16-bit integers.

+
Parameters
+ + + + +
sourcethe input array.
destinationthe output array.
numSamplesthe number of values to convert.
+
+
+ +
+

◆ convertFormatToSizeInBytes()

@@ -502,7 +706,7 @@

int32_t oboe::convertFormatToSizeInBytes

(AudioFormat AudioFormat  format)
+ + + + + + + + + + + + + + + + + + + + + + + +
void oboe::convertPcm16ToFloat (const int16_t * source,
float * destination,
int32_t numSamples 
)
+
+

Convert an array of 16-bit integers to an array of floats.

+
Parameters
+ + + + +
sourcethe input array.
destinationthe output array.
numSamplesthe number of values to convert.
+
+
+ +
+ + +

◆ convertToText()

@@ -524,7 +771,7 @@

const char* oboe::convertToText ( FromType  - ) + input) @@ -532,7 +779,7 @@

Parameters
- +
enumvalue
inputobject to convert from.
@@ -559,6 +806,129 @@

Returns
version number or -1
+

+
+ +

◆ operator<<()

+ +
+
+
+template<typename T >
+ + + + + + + + + + + + + + + + + + +
std::ostream& oboe::operator<< (std::ostream & strm,
const ResultWithValue< T > & result 
)
+
+

If the result is OK then return the value, otherwise return a human-readable error message.

+ +
+
+

Variable Documentation

+ +

◆ kDefaultTimeoutNanos

+ +
+
+ + + + +
constexpr int64_t oboe::kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond)
+
+

The default number of nanoseconds to wait for when performing state change operations on the stream, such as start and stop.

+
See also
oboe::AudioStream::start
+ +
+
+ +

◆ kMillisPerSecond

+ +
+
+ + + + +
constexpr int64_t oboe::kMillisPerSecond = 1000
+
+

The number of milliseconds in a second. 1,000.

+ +
+
+ +

◆ kNanosPerMicrosecond

+ +
+
+ + + + +
constexpr int64_t oboe::kNanosPerMicrosecond = 1000
+
+

The number of nanoseconds in a microsecond. 1,000.

+ +
+
+ +

◆ kNanosPerMillisecond

+ +
+
+ + + + +
constexpr int64_t oboe::kNanosPerMillisecond = kNanosPerMicrosecond * 1000
+
+

The number of nanoseconds in a millisecond. 1,000,000.

+ +
+
+ +

◆ kNanosPerSecond

+ +
+
+ + + + +
constexpr int64_t oboe::kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond
+
+

The number of nanoseconds in a second. 1,000,000,000.

+ +
+
+ +

◆ kUnspecified

+ +
+
+ + + + +
constexpr int32_t oboe::kUnspecified = 0
+
+

Represents any attribute, property or value which hasn't been specified.

+
diff --git a/docs/reference/a00033.html b/docs/reference/a00033.html index ed9e94e37..281e3ac4d 100644 --- a/docs/reference/a00033.html +++ b/docs/reference/a00033.html @@ -75,74 +75,74 @@

This is the complete list of members for oboe::AudioStream, including all inherited members.

- + - + - - + + - - - + + + - - + + - + - - + + - - + + - + - + - - - + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + - - - + + + diff --git a/docs/reference/a00034.html b/docs/reference/a00034.html new file mode 100644 index 000000000..46afc3664 --- /dev/null +++ b/docs/reference/a00034.html @@ -0,0 +1,160 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+
AudioStream() (defined in oboe::AudioStream)oboe::AudioStreaminline
AudioStream(const AudioStreamBuilder &builder) (defined in oboe::AudioStream)oboe::AudioStreamexplicit
AudioStream(const AudioStreamBuilder &builder)oboe::AudioStreamexplicit
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
AudioStreamBase(const AudioStreamBase &)=defaultoboe::AudioStreamBase
calculateLatencyMillis()oboe::AudioStreaminlinevirtual
close()=0oboe::AudioStreampure virtual
fireCallback(void *audioData, int numFrames) (defined in oboe::AudioStream)oboe::AudioStreamprotected
flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
fireCallback(void *audioData, int numFrames)oboe::AudioStreamprotected
flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
getAudioApi() const =0oboe::AudioStreampure virtual
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getBytesPerFrame() const (defined in oboe::AudioStream)oboe::AudioStreaminline
getBytesPerSample() const (defined in oboe::AudioStream)oboe::AudioStream
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getBytesPerFrame() constoboe::AudioStreaminline
getBytesPerSample() constoboe::AudioStream
getCallback() constoboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getContentType() constoboe::AudioStreamBaseinline
getDeviceId() constoboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerBurst()=0oboe::AudioStreampure virtual
getFramesPerCallback() constoboe::AudioStreamBaseinline
getFramesRead() (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getFramesRead()oboe::AudioStreaminlinevirtual
getFramesWritten()oboe::AudioStreaminlinevirtual
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getInputPreset() constoboe::AudioStreamBaseinline
getPerformanceMode() constoboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSessionId() constoboe::AudioStreamBaseinline
getSharingMode() constoboe::AudioStreamBaseinline
getState()=0oboe::AudioStreampure virtual
getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds)oboe::AudioStreaminlinevirtual
getUnderlyingStream() constoboe::AudioStreaminlinevirtual
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getUsage() constoboe::AudioStreamBaseinline
getXRunCount() constoboe::AudioStreaminlinevirtual
incrementFramesRead(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
incrementFramesWritten(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
isPlaying() (defined in oboe::AudioStream)oboe::AudioStream
incrementFramesRead(int32_t frames)oboe::AudioStreaminlineprotectedvirtual
incrementFramesWritten(int32_t frames)oboe::AudioStreaminlineprotectedvirtual
isPlaying()oboe::AudioStream
isXRunCountSupported() const =0oboe::AudioStreampure virtual
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesRead (defined in oboe::AudioStream)oboe::AudioStreamprotected
mFramesWritten (defined in oboe::AudioStream)oboe::AudioStreamprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mNativeFormat (defined in oboe::AudioStream)oboe::AudioStreamprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferCapacityInFramesoboe::AudioStreamBaseprotected
mBufferSizeInFramesoboe::AudioStreamBaseprotected
mChannelCountoboe::AudioStreamBaseprotected
mContentTypeoboe::AudioStreamBaseprotected
mDeviceIdoboe::AudioStreamBaseprotected
mDirectionoboe::AudioStreamBaseprotected
mFormatoboe::AudioStreamBaseprotected
mFramesPerBurstoboe::AudioStreamBaseprotected
mFramesPerCallbackoboe::AudioStreamBaseprotected
mFramesReadoboe::AudioStreamprotected
mFramesWrittenoboe::AudioStreamprotected
mInputPresetoboe::AudioStreamBaseprotected
mNativeFormatoboe::AudioStreamprotected
mPerformanceModeoboe::AudioStreamBaseprotected
mSampleRateoboe::AudioStreamBaseprotected
mSessionIdoboe::AudioStreamBaseprotected
mSharingModeoboe::AudioStreamBaseprotected
mStreamCallbackoboe::AudioStreamBaseprotected
mUsageoboe::AudioStreamBaseprotected
onDefaultCallback(void *audioData, int numFrames)oboe::AudioStreaminlineprotectedvirtual
open()oboe::AudioStreamvirtual
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
requestFlush()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestPause()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestStart()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestStop()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
operator=(const AudioStreamBase &)=defaultoboe::AudioStreamBase
pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)oboe::AudioStreaminlinevirtual
requestFlush()=0oboe::AudioStreampure virtual
requestPause()=0oboe::AudioStreampure virtual
requestStart()=0oboe::AudioStreampure virtual
requestStop()=0oboe::AudioStreampure virtual
setBufferSizeInFrames(int32_t requestedFrames)oboe::AudioStreaminlinevirtual
setNativeFormat(AudioFormat format) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
setNativeFormat(AudioFormat format)oboe::AudioStreaminlineprotectedvirtual
start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
usesAAudio() constoboe::AudioStreaminline
waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0oboe::AudioStreampure virtual
waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)oboe::AudioStreamprotectedvirtual
+ + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+ + + + + + + + + +
+
+ + +
+ +
+ + + +
+
+
oboe::AudioStream Member List
+
+
+ +

This is the complete list of members for oboe::AudioStream, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AudioStream() (defined in oboe::AudioStream)oboe::AudioStreaminline
AudioStream(const AudioStreamBuilder &builder)oboe::AudioStreamexplicit
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
calculateLatencyMillis()oboe::AudioStreaminlinevirtual
close()=0oboe::AudioStreampure virtual
fireCallback(void *audioData, int numFrames) (defined in oboe::AudioStream)oboe::AudioStreamprotected
flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
getAudioApi() const =0oboe::AudioStreampure virtual
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getBytesPerFrame() const (defined in oboe::AudioStream)oboe::AudioStreaminline
getBytesPerSample() const (defined in oboe::AudioStream)oboe::AudioStream
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerBurst()=0oboe::AudioStreampure virtual
getFramesPerCallback() constoboe::AudioStreamBaseinline
getFramesRead() (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getFramesWritten()oboe::AudioStreaminlinevirtual
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getState()=0oboe::AudioStreampure virtual
getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getUnderlyingStream() constoboe::AudioStreaminlinevirtual
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getXRunCount() constoboe::AudioStreaminlinevirtual
incrementFramesRead(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
incrementFramesWritten(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
isPlaying()oboe::AudioStream
isXRunCountSupported() const =0oboe::AudioStreampure virtual
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesRead (defined in oboe::AudioStream)oboe::AudioStreamprotected
mFramesWritten (defined in oboe::AudioStream)oboe::AudioStreamprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mNativeFormat (defined in oboe::AudioStream)oboe::AudioStreamprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
onDefaultCallback(void *audioData, int numFrames)oboe::AudioStreaminlineprotectedvirtual
open()oboe::AudioStreamvirtual
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
requestFlush()=0oboe::AudioStreampure virtual
requestPause()=0oboe::AudioStreampure virtual
requestStart()=0oboe::AudioStreampure virtual
requestStop()=0oboe::AudioStreampure virtual
setBufferSizeInFrames(int32_t requestedFrames)oboe::AudioStreaminlinevirtual
setNativeFormat(AudioFormat format) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
usesAAudio() constoboe::AudioStreaminline
waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0oboe::AudioStreampure virtual
waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)oboe::AudioStreamprotectedvirtual
write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)oboe::AudioStreaminlinevirtual
~AudioStream()=default (defined in oboe::AudioStream)oboe::AudioStreamvirtual
~AudioStreamBase()=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBasevirtual
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00035.html b/docs/reference/a00035.html new file mode 100644 index 000000000..6bdd54705 --- /dev/null +++ b/docs/reference/a00035.html @@ -0,0 +1,160 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::AudioStream Member List
+
+
+ +

This is the complete list of members for oboe::AudioStream, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AudioStream() (defined in oboe::AudioStream)oboe::AudioStreaminline
AudioStream(const AudioStreamBuilder &builder)oboe::AudioStreamexplicit
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
calculateLatencyMillis()oboe::AudioStreaminlinevirtual
close()=0oboe::AudioStreampure virtual
fireCallback(void *audioData, int numFrames) (defined in oboe::AudioStream)oboe::AudioStreamprotected
flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
getAudioApi() const =0oboe::AudioStreampure virtual
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getBytesPerFrame() const (defined in oboe::AudioStream)oboe::AudioStreaminline
getBytesPerSample() const (defined in oboe::AudioStream)oboe::AudioStream
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerBurst()=0oboe::AudioStreampure virtual
getFramesPerCallback() constoboe::AudioStreamBaseinline
getFramesRead() (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getFramesWritten()oboe::AudioStreaminlinevirtual
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getState()=0oboe::AudioStreampure virtual
getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getUnderlyingStream() constoboe::AudioStreaminlinevirtual
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getXRunCount() constoboe::AudioStreaminlinevirtual
incrementFramesRead(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
incrementFramesWritten(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
isPlaying()oboe::AudioStream
isXRunCountSupported() const =0oboe::AudioStreampure virtual
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesRead (defined in oboe::AudioStream)oboe::AudioStreamprotected
mFramesWritten (defined in oboe::AudioStream)oboe::AudioStreamprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mNativeFormat (defined in oboe::AudioStream)oboe::AudioStreamprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
onDefaultCallback(void *audioData, int numFrames)oboe::AudioStreaminlineprotectedvirtual
open()oboe::AudioStreamvirtual
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
requestFlush()=0oboe::AudioStreampure virtual
requestPause()=0oboe::AudioStreampure virtual
requestStart()=0oboe::AudioStreampure virtual
requestStop()=0oboe::AudioStreampure virtual
setBufferSizeInFrames(int32_t requestedFrames)oboe::AudioStreaminlinevirtual
setNativeFormat(AudioFormat format) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)oboe::AudioStreamvirtual
usesAAudio() constoboe::AudioStreaminline
waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0oboe::AudioStreampure virtual
waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)oboe::AudioStreamprotectedvirtual
write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)oboe::AudioStreaminlinevirtual
~AudioStream()=default (defined in oboe::AudioStream)oboe::AudioStreamvirtual
~AudioStreamBase()=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBasevirtual
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00036.html b/docs/reference/a00036.html index f11a47e41..f132bf6f5 100644 --- a/docs/reference/a00036.html +++ b/docs/reference/a00036.html @@ -90,40 +90,31 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -133,29 +124,23 @@ - + - + - + - + - + - + @@ -164,134 +149,135 @@ - + - + - + - + - + - + - + - + - + - + - + - +

Public Member Functions

- AudioStream (const AudioStreamBuilder &builder)
 AudioStream (const AudioStreamBuilder &builder)
 
virtual Result open ()
virtual Result open ()
 
virtual Result close ()=0
virtual Result close ()=0
 
-virtual Result start (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
virtual Result start (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result pause (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
virtual Result pause (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result flush (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
virtual Result flush (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result stop (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
virtual Result stop (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result requestStart ()=0
virtual Result requestStart ()=0
 
-virtual Result requestPause ()=0
virtual Result requestPause ()=0
 
-virtual Result requestFlush ()=0
virtual Result requestFlush ()=0
 
-virtual Result requestStop ()=0
virtual Result requestStop ()=0
 
virtual StreamState getState ()=0
virtual StreamState getState ()=0
 
virtual Result waitForStateChange (StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
virtual Result waitForStateChange (StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
 
virtual ResultWithValue< int32_t > setBufferSizeInFrames (int32_t requestedFrames)
 
 
virtual int32_t getFramesPerBurst ()=0
 
-bool isPlaying ()
bool isPlaying ()
 
-int32_t getBytesPerFrame () const
int32_t getBytesPerFrame () const
 
-int32_t getBytesPerSample () const
int32_t getBytesPerSample () const
 
virtual int64_t getFramesWritten ()
 
-virtual int64_t getFramesRead ()
virtual int64_t getFramesRead ()
 
virtual ResultWithValue< double > calculateLatencyMillis ()
 
-virtual Result getTimestamp (clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds)
virtual Result getTimestamp (clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds)
 
virtual ResultWithValue< int32_t > write (const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
 
-virtual ResultWithValue< int32_t > read (void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
virtual ResultWithValue< int32_t > read (void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
 
virtual AudioApi getAudioApi () const =0
 
virtual void * getUnderlyingStream () const
 
- Public Member Functions inherited from oboe::AudioStreamBase
- AudioStreamBase (const AudioStreamBase &)=default
 AudioStreamBase (const AudioStreamBase &)=default
 
-AudioStreamBase & operator= (const AudioStreamBase &)=default
AudioStreamBase & operator= (const AudioStreamBase &)=default
 
int getChannelCount () const
 
Direction getDirection () const
Direction getDirection () const
 
int32_t getSampleRate () const
 
int getFramesPerCallback () const
 
AudioFormat getFormat () const
AudioFormat getFormat () const
 
virtual int32_t getBufferSizeInFrames ()
 
virtual int32_t getBufferCapacityInFrames () const
 
-SharingMode getSharingMode () const
SharingMode getSharingMode () const
 
-PerformanceMode getPerformanceMode () const
PerformanceMode getPerformanceMode () const
 
-int32_t getDeviceId () const
int32_t getDeviceId () const
 
-AudioStreamCallback * getCallback () const
AudioStreamCallback * getCallback () const
 
-Usage getUsage () const
Usage getUsage () const
 
-ContentType getContentType () const
ContentType getContentType () const
 
-InputPreset getInputPreset () const
InputPreset getInputPreset () const
 
-SessionId getSessionId () const
SessionId getSessionId () const
 
- + - + - + - + - + - +

Protected Member Functions

-virtual int64_t incrementFramesWritten (int32_t frames)
virtual int64_t incrementFramesWritten (int32_t frames)
 
-virtual int64_t incrementFramesRead (int32_t frames)
virtual int64_t incrementFramesRead (int32_t frames)
 
virtual Result waitForStateTransition (StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
virtual Result waitForStateTransition (StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
 
virtual DataCallbackResult onDefaultCallback (void *audioData, int numFrames)
virtual DataCallbackResult onDefaultCallback (void *audioData, int numFrames)
 
-DataCallbackResult fireCallback (void *audioData, int numFrames)
DataCallbackResult fireCallback (void *audioData, int numFrames)
 
-virtual void setNativeFormat (AudioFormat format)
virtual void setNativeFormat (AudioFormat format)
 
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +

Protected Attributes

-AudioFormat mNativeFormat = AudioFormat::Invalid
AudioFormat mNativeFormat = AudioFormat::Invalid
 
-int64_t mFramesWritten = 0
int64_t mFramesWritten = 0
 
-int64_t mFramesRead = 0
int64_t mFramesRead = 0
 
- Protected Attributes inherited from oboe::AudioStreamBase
-AudioStreamCallback * mStreamCallback = nullptr
AudioStreamCallback * mStreamCallback = nullptr
 
-int32_t mFramesPerCallback = kUnspecified
int32_t mFramesPerCallback = kUnspecified
 
-int32_t mChannelCount = kUnspecified
int32_t mChannelCount = kUnspecified
 
-int32_t mSampleRate = kUnspecified
int32_t mSampleRate = kUnspecified
 
-int32_t mDeviceId = kUnspecified
int32_t mDeviceId = kUnspecified
 
-int32_t mBufferCapacityInFrames = kUnspecified
int32_t mBufferCapacityInFrames = kUnspecified
 
-int32_t mBufferSizeInFrames = kUnspecified
int32_t mBufferSizeInFrames = kUnspecified
 
-int32_t mFramesPerBurst = kUnspecified
int32_t mFramesPerBurst = kUnspecified
 
-SharingMode mSharingMode = SharingMode::Shared
SharingMode mSharingMode = SharingMode::Shared
 
-AudioFormat mFormat = AudioFormat::Unspecified
AudioFormat mFormat = AudioFormat::Unspecified
 
-Direction mDirection = Direction::Output
Direction mDirection = Direction::Output
 
-PerformanceMode mPerformanceMode = PerformanceMode::None
PerformanceMode mPerformanceMode = PerformanceMode::None
 
-Usage mUsage = Usage::Media
Usage mUsage = Usage::Media
 
-ContentType mContentType = ContentType::Music
ContentType mContentType = ContentType::Music
 
-InputPreset mInputPreset = InputPreset::VoiceRecognition
InputPreset mInputPreset = InputPreset::VoiceRecognition
 
-SessionId mSessionId = SessionId::None
SessionId mSessionId = SessionId::None
 

Detailed Description

Base class for Oboe C++ audio stream.

-

Member Function Documentation

+

Constructor & Destructor Documentation

+ +

◆ AudioStream()

+ +
+
+ + + + + +
+ + + + + + + + +
oboe::AudioStream::AudioStream (const AudioStreamBuilder & builder)
+ 		+explicit
+
+

Construct an AudioStream using the given AudioStreamBuilder

+
Parameters
+ + +
buildercontaining all the stream's attributes
+
+
+ +
+
+

Member Function Documentation

◆ calculateLatencyMillis()

@@ -302,30 +288,528 @@

- + + + + + +
virtual ResultWithValue<double> oboe::AudioStream::calculateLatencyMillis virtual ResultWithValue<double> oboe::AudioStream::calculateLatencyMillis ()
+ + +inlinevirtual + + +
+

Calculate the latency of a stream based on getTimestamp().

+

Output latency is the time it takes for a given frame to travel from the app to some type of digital-to-analog converter. If the DAC is external, for example in a USB interface or a TV connected by HDMI, then there may be additional latency that the Android device is unaware of.

+

Input latency is the time it takes to a given frame to travel from an analog-to-digital converter (ADC) to the app.

+

Note that the latency of an OUTPUT stream will increase abruptly when you write data to it and then decrease slowly over time as the data is consumed.

+

The latency of an INPUT stream will decrease abruptly when you read data from it and then increase slowly over time as more data arrives.

+

The latency of an OUTPUT stream is generally higher than the INPUT latency because an app generally tries to keep the OUTPUT buffer full and the INPUT buffer empty.

+
Returns
a ResultWithValue which has a result of Result::OK and a value containing the latency in milliseconds, or a result of Result::Error*.
+ +
+ + +

◆ close()

+ +
+
+ + + + + +
+ + + + + + + +
virtual Result oboe::AudioStream::close ()
+ 		+pure virtual
+
+

Close the stream and deallocate any resources from the open() call.

+ +
+
+ +

◆ fireCallback()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DataCallbackResult oboe::AudioStream::fireCallback (void * audioData,
int numFrames 
)
+ 		+protected
+
+

Override this to provide your own behaviour for the audio callback

+
Parameters
+ + + +
audioDatacontainer array which audio frames will be written into or read from
numFramesnumber of frames which were read/written
+
+
+
Returns
the result of the callback: stop or continue
+ +
+
+ +

◆ flush()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual Result oboe::AudioStream::flush (int64_t timeoutNanoseconds = kDefaultTimeoutNanos)
+ 		+virtual
+
+

Flush the stream. This will block until the stream has been flushed, an error occurs or timeoutNanoseconds has been reached.

+ +
+
+ +

◆ getAudioApi()

+ +
+
+ + + + + +
+ + + + + + + +
virtual AudioApi oboe::AudioStream::getAudioApi () const
+ 		+pure virtual
+
+

Get the underlying audio API which the stream uses.

+
Returns
the API that this stream uses.
+ +
+
+ +

◆ getBytesPerFrame()

+ +
+
+ + + + + +
+ + + + + + + +
int32_t oboe::AudioStream::getBytesPerFrame () const
+ 		+inline
+
+

Get the number of bytes in each audio frame. This is calculated using the channel count and the sample format. For example, a 2 channel floating point stream will have 2 * 4 = 8 bytes per frame.

+
Returns
number of bytes in each audio frame.
+ +
+
+ +

◆ getBytesPerSample()

+ +
+
+ + + + + + + +
int32_t oboe::AudioStream::getBytesPerSample () const
+
+

Get the number of bytes per sample. This is calculated using the sample format. For example, stream using 16-bit integer samples will have 2 bytes per sample.

+
Returns
the number of bytes per sample.
+ +
+
+ +

◆ getFramesPerBurst()

+ +
+
+ + + + + +
+ + + + + + + +
virtual int32_t oboe::AudioStream::getFramesPerBurst ()
+ 		+pure virtual
+
+

Query the number of frames that are read or written by the endpoint at one time.

+
Returns
burst size
+ +
+
+ +

◆ getFramesRead()

+ +
+
+ + + + + +
+ + + + + + + +
virtual int64_t oboe::AudioStream::getFramesRead ()
+ 		+inlinevirtual
+
+

The number of audio frames read from the stream. This monotonic counter will never get reset.

+
Returns
the number of frames read so far
+ +
+
+ +

◆ getFramesWritten()

+ +
+
+ + + + + +
+ + + + + + + +
virtual int64_t oboe::AudioStream::getFramesWritten ()
+ 		+inlinevirtual
+
+

The number of audio frames written into the stream. This monotonic counter will never get reset.

+
Returns
the number of frames written so far
+ +
+
+ +

◆ getState()

+ +
+
+ + + + + +
+ + + + + + + +
virtual StreamState oboe::AudioStream::getState ()
+ 		+pure virtual
+
+

Query the current state, eg. StreamState::Pausing

+
Returns
state or a negative error.
+ +
+
+ +

◆ getTimestamp()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual Result oboe::AudioStream::getTimestamp (clockid_t clockId,
int64_t * framePosition,
int64_t * timeNanoseconds 
)
+ 		+inlinevirtual
+
+

Get the timestamp that the frame at framePosition was presented to the audio hardware.

+
Parameters
+ + + + +
clockIdthe type of clock to use e.g. CLOCK_MONOTONIC
framePositionthe frame number to query
timeNanosecondsan output parameter which will contain the presentation timestamp (if the operation is successful)
+
+
+ +
+
+ +

◆ getUnderlyingStream()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void* oboe::AudioStream::getUnderlyingStream () const
+ 		+inlinevirtual
+
+

Only for debugging. Do use in production. If you need to call this method something is wrong. If you think you need it for production then please let us know so we can modify Oboe so that you don't need this.

+
Returns
nullptr or a pointer to a stream from the system API
+ +
+
+ +

◆ getXRunCount()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ResultWithValue<int32_t> oboe::AudioStream::getXRunCount () const
+ 		+inlinevirtual
+
+

An XRun is an Underrun or an Overrun. During playing, an underrun will occur if the stream is not written in time and the system runs out of valid data. During recording, an overrun will occur if the stream is not read in time and there is no place to put the incoming data so it is discarded.

+

An underrun or overrun can cause an audible "pop" or "glitch".

+
Returns
a result which is either Result::OK with the xRun count as the value, or a Result::Error* code
+ +
+
+ +

◆ incrementFramesRead()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual int64_t oboe::AudioStream::incrementFramesRead (int32_t frames)
+ 		+inlineprotectedvirtual
+
+

Increment the frames which have been read from this stream

+
Parameters
+ + +
framesnumber of frames to increment by
+
+
+
Returns
total frames which have been read
+ +
+
+ +

◆ incrementFramesWritten()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual int64_t oboe::AudioStream::incrementFramesWritten (int32_t frames)
+ 		+inlineprotectedvirtual
+
+

Increment the frames written to this stream

+
Parameters
+ + +
framesnumber of frames to increment by
+
+
+
Returns
total frames which have been written
+ +
+
+ +

◆ isPlaying()

+ +
+
+ + + + + + + +
bool oboe::AudioStream::isPlaying ()
+
+

Indicates whether the audio stream is playing.

+

THIS MAY BE REMOVED IN FUTURE. https://github.com/google/oboe/issues/208

+ +
+
+ +

◆ isXRunCountSupported()

+ +
+
+ + + +pure virtual
+ + + - +
virtual bool oboe::AudioStream::isXRunCountSupported ( ) const
-inlinevirtual
-

Calculate the latency of a stream based on getTimestamp().

-

Output latency is the time it takes for a given frame to travel from the app to some type of digital-to-analog converter. If the DAC is external, for example in a USB interface or a TV connected by HDMI, then there may be additional latency that the Android device is unaware of.

-

Input latency is the time it takes to a given frame to travel from an analog-to-digital converter (ADC) to the app.

-

Note that the latency of an OUTPUT stream will increase abruptly when you write data to it and then decrease slowly over time as the data is consumed.

-

The latency of an INPUT stream will decrease abruptly when you read data from it and then increase slowly over time as more data arrives.

-

The latency of an OUTPUT stream is generally higher than the INPUT latency because an app generally tries to keep the OUTPUT buffer full and the INPUT buffer empty.

-
Returns
a ResultWithValue which has a result of Result::OK and a value containing the latency in milliseconds, or a result of Result::Error*.
+
Returns
true if XRun counts are supported on the stream
- -

◆ close()

+ +

◆ onDefaultCallback()

@@ -334,24 +818,43 @@

- + - + + + + + + + + + + + +
virtual Result oboe::AudioStream::close virtual DataCallbackResult oboe::AudioStream::onDefaultCallback ()void * audioData,
int numFrames 
)
-pure virtual +inlineprotectedvirtual

-

Close the stream and deallocate any resources from the open() call.

+

Override this to provide a default for when the application did not specify a callback.

+
Parameters
+ + + +
audioData
numFrames
+
+
+
Returns
result
- -

◆ getAudioApi()

+ +

◆ open()

@@ -360,24 +863,26 @@

- + - +
virtual AudioApi oboe::AudioStream::getAudioApi virtual Result oboe::AudioStream::open ( ) const
-pure virtual +virtual

-
Returns
the API that this stream uses
+

Open a stream based on the current settings.

+

Note that we do not recommend re-opening a stream that has been closed. TODO Should we prevent re-opening?

+
Returns
- -

◆ getFramesPerBurst()

+ +

◆ pause()

@@ -386,25 +891,25 @@

- + - + +
virtual int32_t oboe::AudioStream::getFramesPerBurst virtual Result oboe::AudioStream::pause ()int64_t timeoutNanoseconds = kDefaultTimeoutNanos)
-pure virtual +virtual

-

Query the number of frames that are read or written by the endpoint at one time.

-
Returns
burst size
+

Pause the stream. This will block until the stream has been paused, an error occurs or timeoutNanoseconds has been reached.

- -

◆ getFramesWritten()

+ +

◆ read()

@@ -413,10 +918,27 @@

- + - + + + + + + + + + + + + + + + + + +
virtual int64_t oboe::AudioStream::getFramesWritten virtual ResultWithValue<int32_t> oboe::AudioStream::read ()void * buffer,
int32_t numFrames,
int64_t timeoutNanoseconds 
)
@@ -425,12 +947,22 @@

-

This monotonic counter will never get reset.

Returns
the number of frames written so far
+

Read data into the supplied buffer from the stream. This method will block until the read is complete or it runs out of time.

+

If timeoutNanoseconds is zero then this call will not wait.

+
Parameters
+ + + + +
bufferThe address of the first sample.
numFramesNumber of frames to read. Only complete frames will be read.
timeoutNanosecondsMaximum number of nanoseconds to wait for completion.
+
+
+
Returns
a ResultWithValue which has a result of Result::OK and a value containing the number of frames actually read, or result of Result::Error*.

- -

◆ getState()

+ +

◆ requestFlush()

@@ -439,7 +971,7 @@

- + @@ -451,13 +983,12 @@

-

Query the current state, eg. StreamState::Pausing

-
Returns
state or a negative error.
+

Flush the stream asynchronously. Returns immediately (does not block). Equivalent to calling flush(0).

- -

◆ getUnderlyingStream()

+ +

◆ requestPause()

@@ -466,25 +997,24 @@

virtual StreamState oboe::AudioStream::getState virtual Result oboe::AudioStream::requestFlush ( )
- + - +
virtual void* oboe::AudioStream::getUnderlyingStream virtual Result oboe::AudioStream::requestPause ( ) const
-inlinevirtual +pure virtual

-

Do not use this for production. This is only for debugging. If you need to call this method then something is wrong. If you think you need it for production then please let us know so we can modify Oboe so that you don't need this.

-
Returns
nullptr or a pointer to a stream from the system API
+

Pause the stream asynchronously. Returns immediately (does not block). Equivalent to calling pause(0).

- -

◆ getXRunCount()

+ +

◆ requestStart()

@@ -493,26 +1023,24 @@

- + - +
virtual ResultWithValue<int32_t> oboe::AudioStream::getXRunCount virtual Result oboe::AudioStream::requestStart ( ) const
-inlinevirtual +pure virtual

-

An XRun is an Underrun or an Overrun. During playing, an underrun will occur if the stream is not written in time and the system runs out of valid data. During recording, an overrun will occur if the stream is not read in time and there is no place to put the incoming data so it is discarded.

-

An underrun or overrun can cause an audible "pop" or "glitch".

-
Returns
a result which is either Result::OK with the xRun count as the value, or a Result::Error* code
+

Start the stream asynchronously. Returns immediately (does not block). Equivalent to calling start(0).

- -

◆ isXRunCountSupported()

+ +

◆ requestStop()

@@ -521,10 +1049,10 @@

- + - +
virtual bool oboe::AudioStream::isXRunCountSupported virtual Result oboe::AudioStream::requestStop ( ) const
@@ -533,12 +1061,12 @@

-
Returns
true if XRun counts are supported on the stream
+

Stop the stream asynchronously. Returns immediately (does not block). Equivalent to calling stop(0).

- -

◆ onDefaultCallback()

+ +

◆ setBufferSizeInFrames()

@@ -547,43 +1075,33 @@

- + - - - - - - - - - - + + - -
virtual DataCallbackResult oboe::AudioStream::onDefaultCallback virtual ResultWithValue<int32_t> oboe::AudioStream::setBufferSizeInFrames (void * audioData,
int numFrames 
int32_t requestedFrames) )
-inlineprotectedvirtual +inlinevirtual

-

Override this to provide a default for when the application did not specify a callback.

+

This can be used to adjust the latency of the buffer by changing the threshold where blocking will occur. By combining this with getXRunCount(), the latency can be tuned at run-time for each device.

+

This cannot be set higher than getBufferCapacity().

Parameters
- - +
audioData
numFrames
requestedFramesrequested number of frames that can be filled without blocking
-
Returns
result
+
Returns
the resulting buffer size in frames (obtained using value()) or an error (obtained using error())
- -

◆ open()

+ +

◆ setNativeFormat()

@@ -592,9 +1110,37 @@

- + - + + + + +
virtual Result oboe::AudioStream::open virtual void oboe::AudioStream::setNativeFormat ()AudioFormat format)
+ + +inlineprotectedvirtual + + +

+

Used to set the format of the underlying stream

+ +
+
+ +

◆ start()

+ +
+
+ + + +virtual
+ + + + + +
virtual Result oboe::AudioStream::start (int64_t timeoutNanoseconds = kDefaultTimeoutNanos)
@@ -604,14 +1150,12 @@

-

Open a stream based on the current settings.

-

Note that we do not recommend re-opening a stream that has been closed. TODO Should we prevent re-opening?

-
Returns
+

Start the stream. This will block until the stream has been started, an error occurs or timeoutNanoseconds has been reached.

- -

◆ setBufferSizeInFrames()

+ +

◆ stop()

@@ -620,28 +1164,20 @@

- + - - + +
virtual ResultWithValue<int32_t> oboe::AudioStream::setBufferSizeInFrames virtual Result oboe::AudioStream::stop (int32_t requestedFrames)int64_t timeoutNanoseconds = kDefaultTimeoutNanos)

-inlinevirtual
-

This can be used to adjust the latency of the buffer by changing the threshold where blocking will occur. By combining this with getXRunCount(), the latency can be tuned at run-time for each device.

-

This cannot be set higher than getBufferCapacity().

-
Parameters
- - -
requestedFramesrequested number of frames that can be filled without blocking
-
-
-
Returns
the resulting buffer size in frames (obtained using value()) or an error (obtained using error())
+

Stop the stream. This will block until the stream has been stopped, an error occurs or timeoutNanoseconds has been reached.

@@ -667,7 +1203,8 @@

-
Returns
true if this stream is implemented using the AAudio API
+

Returns true if the underlying audio API is AAudio.

+
Returns
true if this stream is implemented using the AAudio API.
@@ -681,15 +1218,15 @@

- + - + - + @@ -743,15 +1280,15 @@

virtual Result oboe::AudioStream::waitForStateChange virtual Result oboe::AudioStream::waitForStateChange (StreamState StreamState  inputState,
StreamState * StreamState *  nextState,
- + - + - + @@ -815,10 +1352,10 @@

-

A high level write that will wait until the write is complete or it runs out of time. If timeoutNanoseconds is zero then this call will not wait.

+

Write data from the supplied buffer into the stream. This method will block until the write is complete or it runs out of time.

+

If timeoutNanoseconds is zero then this call will not wait.

Parameters

virtual Result oboe::AudioStream::waitForStateTransition virtual Result oboe::AudioStream::waitForStateTransition (StreamState StreamState  startingState,
StreamState StreamState  endingState,
- @@ -827,6 +1364,79 @@

Returns
a ResultWithValue which has a result of Result::OK and a value containing the number of frames actually written, or result of Result::Error*.
+ + +

Member Data Documentation

+ +

◆ mFramesRead

+ +
+
+
streamA stream created using OboeStream_Open().
bufferThe address of the first sample.
numFramesNumber of frames to write. Only complete frames will be written.
timeoutNanosecondsMaximum number of nanoseconds to wait for completion.
+ + + + +
+ + + + +
int64_t oboe::AudioStream::mFramesRead = 0
+ 		+protected
+
+

Number of frames which have been read from the stream

+

TODO these should be atomic like in AAudio

+ +
+ + +

◆ mFramesWritten

+ +
+
+ + + + + +
+ + + + +
int64_t oboe::AudioStream::mFramesWritten = 0
+ 		+protected
+
+

Number of frames which have been written into the stream

+

TODO these should be atomic like in AAudio

+ +
+
+ +

◆ mNativeFormat

+ +
+
+ + + + + +
+ + + + +
AudioFormat oboe::AudioStream::mNativeFormat = AudioFormat::Invalid
+ 		+protected
+
+

Do not set directly, use setNativeFormat

+

TODO: make private These do not change after open.

+
The documentation for this class was generated from the following file:
@@ -72,12 +72,12 @@
-

This is the complete list of members for oboe::AudioStreamCallback, including all inherited members.

+

This is the complete list of members for oboe::AudioStreamCallback, including all inherited members.

- - - - + + + +
onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0oboe::AudioStreamCallbackpure virtual
onErrorAfterClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
onErrorBeforeClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
~AudioStreamCallback()=default (defined in oboe::AudioStreamCallback)oboe::AudioStreamCallbackvirtual
onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0oboe::AudioStreamCallbackpure virtual
onErrorAfterClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
onErrorBeforeClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
~AudioStreamCallback()=default (defined in oboe::AudioStreamCallback)oboe::AudioStreamCallbackvirtual
diff --git a/docs/reference/a00046.png b/docs/reference/a00046.png new file mode 100644 index 000000000..5ce65566e Binary files /dev/null and b/docs/reference/a00046.png differ diff --git a/docs/reference/a00047.html b/docs/reference/a00047.html new file mode 100644 index 000000000..d45f700d7 --- /dev/null +++ b/docs/reference/a00047.html @@ -0,0 +1,89 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::AudioStreamCallback Member List
+
+
+ +

This is the complete list of members for oboe::AudioStreamCallback, including all inherited members.

+ + + + + +
onAudioReady(AudioStream *oboeStream, void *audioData, int32_t numFrames)=0oboe::AudioStreamCallbackpure virtual
onErrorAfterClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
onErrorBeforeClose(AudioStream *oboeStream, Result error)oboe::AudioStreamCallbackinlinevirtual
~AudioStreamCallback()=default (defined in oboe::AudioStreamCallback)oboe::AudioStreamCallbackvirtual
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00048.html b/docs/reference/a00048.html index d98317bce..aafc612fd 100644 --- a/docs/reference/a00048.html +++ b/docs/reference/a00048.html @@ -74,17 +74,22 @@
oboe::AudioStreamCallback Class Referenceabstract
+ +

#include <AudioStreamCallback.h>

- + - + - +

Public Member Functions

virtual DataCallbackResult onAudioReady (AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
virtual DataCallbackResult onAudioReady (AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
 
virtual void onErrorBeforeClose (AudioStream *oboeStream, Result error)
virtual void onErrorBeforeClose (AudioStream *oboeStream, Result error)
 
virtual void onErrorAfterClose (AudioStream *oboeStream, Result error)
virtual void onErrorAfterClose (AudioStream *oboeStream, Result error)
 
-

Member Function Documentation

+

Detailed Description

+

AudioStreamCallback defines a callback interface for:

+

1) moving data to/from an audio stream using onAudioReady 2) being alerted when a stream has an error using onError* methods

+

Member Function Documentation

◆ onAudioReady()

@@ -95,7 +100,7 @@

- + @@ -155,7 +160,7 @@

- + @@ -200,7 +205,7 @@

- + diff --git a/docs/reference/a00049.html b/docs/reference/a00049.html index e2a175cc9..f949d0d3b 100644 --- a/docs/reference/a00049.html +++ b/docs/reference/a00049.html @@ -74,8 +74,8 @@

This is the complete list of members for oboe::DefaultStreamValues, including all inherited members.

virtual DataCallbackResult oboe::AudioStreamCallback::onAudioReady virtual DataCallbackResult oboe::AudioStreamCallback::onAudioReady ( AudioStream *  oboeStream, Result Result  error 
Result Result  error 
- - + +
ChannelCount (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
FramesPerBurst (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
ChannelCountoboe::DefaultStreamValuesstatic
FramesPerBurstoboe::DefaultStreamValuesstatic
SampleRateoboe::DefaultStreamValuesstatic

diff --git a/docs/reference/classoboe_1_1_default_stream_values-members.html b/docs/reference/a00050.html similarity index 72% rename from docs/reference/classoboe_1_1_default_stream_values-members.html rename to docs/reference/a00050.html index 56661763e..61bda1f86 100644 --- a/docs/reference/classoboe_1_1_default_stream_values-members.html +++ b/docs/reference/a00050.html @@ -63,7 +63,7 @@
@@ -72,11 +72,11 @@
-

This is the complete list of members for oboe::DefaultStreamValues, including all inherited members.

+

This is the complete list of members for oboe::DefaultStreamValues, including all inherited members.

- - - + + +
ChannelCount (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
FramesPerBurst (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
SampleRateoboe::DefaultStreamValuesstatic
ChannelCount (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
FramesPerBurst (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
SampleRate (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
diff --git a/docs/reference/a00051.html b/docs/reference/a00051.html new file mode 100644 index 000000000..72ac57071 --- /dev/null +++ b/docs/reference/a00051.html @@ -0,0 +1,88 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::DefaultStreamValues Member List
+
+
+ +

This is the complete list of members for oboe::DefaultStreamValues, including all inherited members.

+ + + + +
ChannelCount (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
FramesPerBurst (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
SampleRate (defined in oboe::DefaultStreamValues)oboe::DefaultStreamValuesstatic
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00052.html b/docs/reference/a00052.html index 50dd516a1..ce4b43e48 100644 --- a/docs/reference/a00052.html +++ b/docs/reference/a00052.html @@ -74,19 +74,76 @@
oboe::DefaultStreamValues Class Reference
+ +

#include <Definitions.h>

- + - +

Static Public Attributes

static int32_t SampleRate
 
-static int32_t FramesPerBurst
static int32_t FramesPerBurst
 
-static int32_t ChannelCount
static int32_t ChannelCount
 
-

Member Data Documentation

+

Detailed Description

+

On API 16 to 25 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and framesPerBurst are not known by the native code. On API 17+ these values should be obtained from the AudioManager using this code:

+

+Note that this technique only works for built-in speakers and headphones.
+        AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
+        String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
+        int defaultSampleRate = Integer.parseInt(sampleRateStr);
+        String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
+        int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
+

It can then be passed down to Oboe through JNI.

+

AAudio will get the optimal framesPerBurst from the HAL and will ignore this value.

+

Member Data Documentation

+ +

◆ ChannelCount

+ +
+
+ + + + + +
+ + + + +
int32_t oboe::DefaultStreamValues::ChannelCount
+ 		+static
+
+

The default channel count to use when opening new audio streams

+ +
+
+ +

◆ FramesPerBurst

+ +
+
+ + + + + +
+ + + + +
int32_t oboe::DefaultStreamValues::FramesPerBurst
+ 		+static
+
+

The default frames per burst to use when opening new audio streams

+ +
+

◆ SampleRate

@@ -106,16 +163,7 @@

-

On API 16 to 25 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and framesPerBurst are not known by the native code. On API 17+ these values should be obtained from the AudioManager using this code:

-

-Note that this technique only works for built-in speakers and headphones.
-            AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
-            String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
-            int defaultSampleRate = Integer.parseInt(sampleRateStr);
-            String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
-            int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
-

It can then be passed down to Oboe through JNI.

-

AAudio will get the optimal framesPerBurst from the HAL and will ignore this value.

+

The default sample rate to use when opening new audio streams

diff --git a/docs/reference/a00053.html b/docs/reference/a00053.html index 335341c28..d5dfe3247 100644 --- a/docs/reference/a00053.html +++ b/docs/reference/a00053.html @@ -74,7 +74,7 @@

This is the complete list of members for oboe::LatencyTuner, including all inherited members.

- +
LatencyTuner(AudioStream &stream) (defined in oboe::LatencyTuner)oboe::LatencyTunerexplicit
LatencyTuner(AudioStream &stream)oboe::LatencyTunerexplicit
requestReset()oboe::LatencyTuner
tune()oboe::LatencyTuner
diff --git a/docs/reference/classoboe_1_1_latency_tuner-members.html b/docs/reference/a00054.html similarity index 75% rename from docs/reference/classoboe_1_1_latency_tuner-members.html rename to docs/reference/a00054.html index e15fe3afa..010d28d24 100644 --- a/docs/reference/classoboe_1_1_latency_tuner-members.html +++ b/docs/reference/a00054.html @@ -63,7 +63,7 @@
@@ -72,11 +72,11 @@
-

This is the complete list of members for oboe::LatencyTuner, including all inherited members.

+

This is the complete list of members for oboe::LatencyTuner, including all inherited members.

- - - + + +
LatencyTuner(AudioStream &stream) (defined in oboe::LatencyTuner)oboe::LatencyTunerexplicit
requestReset()oboe::LatencyTuner
tune()oboe::LatencyTuner
LatencyTuner(AudioStream &stream) (defined in oboe::LatencyTuner)oboe::LatencyTunerexplicit
requestReset()oboe::LatencyTuner
tune()oboe::LatencyTuner
diff --git a/docs/reference/a00055.html b/docs/reference/a00055.html new file mode 100644 index 000000000..7c9735b9a --- /dev/null +++ b/docs/reference/a00055.html @@ -0,0 +1,88 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::LatencyTuner Member List
+
+
+ +

This is the complete list of members for oboe::LatencyTuner, including all inherited members.

+ + + + +
LatencyTuner(AudioStream &stream) (defined in oboe::LatencyTuner)oboe::LatencyTunerexplicit
requestReset()oboe::LatencyTuner
tune()oboe::LatencyTuner
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00056.html b/docs/reference/a00056.html index 84940660b..11a5b1931 100644 --- a/docs/reference/a00056.html +++ b/docs/reference/a00056.html @@ -79,20 +79,53 @@ - + - +

Public Member Functions

- LatencyTuner (AudioStream &stream)
 LatencyTuner (AudioStream &stream)
 
Result tune ()
Result tune ()
 
void requestReset ()
 

Detailed Description

-

This can be used to dynamically tune the latency of an output stream. It adjusts the bufferSize based on the number of underruns. The bufferSize is the portion of the total bufferCapacity that is used to store data.

+

LatencyTuner can be used to dynamically tune the latency of an output stream. It adjusts the stream's bufferSize by monitoring the number of underruns.

This only affects the latency associated with the first level of buffering that is closest to the application. It does not affect low latency in the HAL, or touch latency in the UI.

Call tune() right before returning from your data callback function if using callbacks. Call tune() right before calling write() if using blocking writes.

If you want to see the ongoing results of this tuning process then call stream->getBufferSize() periodically.

-

Member Function Documentation

+

Constructor & Destructor Documentation

+ +

◆ LatencyTuner()

+ +
+
+ + + + + +
+ + + + + + + + +
oboe::LatencyTuner::LatencyTuner (AudioStream & stream)
+ 		+explicit
+
+

Construct a new LatencyTuner object which will act on the given audio stream

+
Parameters
+ + +
streamthe stream who's latency will be tuned
+
+
+ +
+
+

Member Function Documentation

◆ requestReset()

@@ -119,7 +152,7 @@

- + diff --git a/docs/reference/a00057.html b/docs/reference/a00057.html index bbbaa51dc..2ae89a740 100644 --- a/docs/reference/a00057.html +++ b/docs/reference/a00057.html @@ -75,13 +75,13 @@

This is the complete list of members for oboe::ResultWithValue< T >, including all inherited members.

Result oboe::LatencyTuner::tune Result oboe::LatencyTuner::tune ( )
- + - - - + + +
createBasedOnSign(T numericResult)oboe::ResultWithValue< T >inlinestatic
error() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
error() constoboe::ResultWithValue< T >inline
operator bool() constoboe::ResultWithValue< T >inlineexplicit
operator Result() constoboe::ResultWithValue< T >inline
operator!() constoboe::ResultWithValue< T >inline
ResultWithValue(oboe::Result error) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
ResultWithValue(T value) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inlineexplicit
value() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
ResultWithValue(oboe::Result error)oboe::ResultWithValue< T >inline
ResultWithValue(T value)oboe::ResultWithValue< T >inlineexplicit
value() constoboe::ResultWithValue< T >inline
diff --git a/docs/reference/classoboe_1_1_result_with_value-members.html b/docs/reference/a00058.html similarity index 53% rename from docs/reference/classoboe_1_1_result_with_value-members.html rename to docs/reference/a00058.html index 51e41e19d..57f1bae29 100644 --- a/docs/reference/classoboe_1_1_result_with_value-members.html +++ b/docs/reference/a00058.html @@ -63,7 +63,7 @@
@@ -72,16 +72,16 @@
-

This is the complete list of members for oboe::ResultWithValue< T >, including all inherited members.

+

This is the complete list of members for oboe::ResultWithValue< T >, including all inherited members.

- - - - - - - - + + + + + + + +
createBasedOnSign(T numericResult)oboe::ResultWithValue< T >inlinestatic
error() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
operator bool() constoboe::ResultWithValue< T >inlineexplicit
operator Result() constoboe::ResultWithValue< T >inline
operator!() constoboe::ResultWithValue< T >inline
ResultWithValue(oboe::Result error) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
ResultWithValue(T value) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inlineexplicit
value() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
createBasedOnSign(T numericResult)oboe::ResultWithValue< T >inlinestatic
error() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
operator bool() constoboe::ResultWithValue< T >inlineexplicit
operator Result() constoboe::ResultWithValue< T >inline
operator!() constoboe::ResultWithValue< T >inline
ResultWithValue(oboe::Result error) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
ResultWithValue(T value) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inlineexplicit
value() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
diff --git a/docs/reference/a00059.html b/docs/reference/a00059.html new file mode 100644 index 000000000..9e8ead8a7 --- /dev/null +++ b/docs/reference/a00059.html @@ -0,0 +1,93 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::ResultWithValue< T > Member List
+
+
+ +

This is the complete list of members for oboe::ResultWithValue< T >, including all inherited members.

+ + + + + + + + + +
createBasedOnSign(T numericResult)oboe::ResultWithValue< T >inlinestatic
error() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
operator bool() constoboe::ResultWithValue< T >inlineexplicit
operator Result() constoboe::ResultWithValue< T >inline
operator!() constoboe::ResultWithValue< T >inline
ResultWithValue(oboe::Result error) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
ResultWithValue(T value) (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inlineexplicit
value() const (defined in oboe::ResultWithValue< T >)oboe::ResultWithValue< T >inline
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00060.html b/docs/reference/a00060.html index 1f0b6888f..7cada3c75 100644 --- a/docs/reference/a00060.html +++ b/docs/reference/a00060.html @@ -75,20 +75,18 @@
oboe::ResultWithValue< T > Class Template Reference
+ +

#include <ResultWithValue.h>

- + - + - + - + @@ -102,6 +100,86 @@

Public Member Functions

- ResultWithValue (oboe::Result error)
 ResultWithValue (oboe::Result error)
 
- ResultWithValue (T value)
 ResultWithValue (T value)
 
-oboe::Result error () const
oboe::Result error () const
 
-T value () const
T value () const
 
 operator bool () const
 
static ResultWithValue< T > createBasedOnSign (T numericResult)
 
+

Detailed Description

+

template<typename T>
+class oboe::ResultWithValue< T >

+ +

A ResultWithValue can store both the result of an operation (either OK or an error) and a value.

+

It has been designed for cases where the caller needs to know whether an operation succeeded and, if it did, a value which was obtained during the operation.

+

For example, when reading from a stream the caller needs to know the result of the read operation and, if it was successful, how many frames were read. Note that ResultWithValue can be evaluated as a boolean so it's simple to check whether the result is OK.

+

ResultWithValue<int32_t> resultOfRead = myStream.read(&buffer, numFrames, timeoutNanoseconds);

+

if (resultOfRead){ LOGD("Frames read: %d", resultOfRead.value()); } else { LOGD("Error reading from stream: %s", resultOfRead.error()); }

+

Constructor & Destructor Documentation

+ +

◆ ResultWithValue() [1/2]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
oboe::ResultWithValue< T >::ResultWithValue (oboe::Result error)
+ 		+inline
+
+

Construct a ResultWithValue containing an error result.

+
Parameters
+ + +
errorThe error
+
+
+ +
+
+ +

◆ ResultWithValue() [2/2]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
oboe::ResultWithValue< T >::ResultWithValue (T value)
+ 		+inlineexplicit
+
+

Construct a ResultWithValue containing an OK result and a value.

+
Parameters
+ + +
valuethe value to store
+
+
+ +
+

Member Function Documentation

◆ createBasedOnSign()

@@ -130,6 +208,35 @@

Create a ResultWithValue from a number. If the number is positive the ResultWithValue will have a result of Result::OK and the value will contain the number. If the number is negative the result will be obtained from the negative number (numeric error codes can be found in AAudio.h) and the value will be null.

+

+ + +

◆ error()

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + +
oboe::Result oboe::ResultWithValue< T >::error () const
+ 		+inline
+
+

Get the result.

+
Returns
the result
+
@@ -172,7 +279,7 @@

- + @@ -217,6 +324,34 @@

Returns
true if an error occurred
+ + + +

◆ value()

+ +
+
+
+template<typename T >
+

oboe::ResultWithValue< T >::operator Result oboe::ResultWithValue< T >::operator Result ( ) const
 + + + + +
+ + + + + + + +
T oboe::ResultWithValue< T >::value () const
+ 		+inline
+
+

Get the value

Returns
+
The documentation for this class was generated from the following file:
    diff --git a/docs/reference/structoboe_1_1_version-members.html b/docs/reference/a00062.html similarity index 65% rename from docs/reference/structoboe_1_1_version-members.html rename to docs/reference/a00062.html index 32eab8ab3..e2baf05c8 100644 --- a/docs/reference/structoboe_1_1_version-members.html +++ b/docs/reference/a00062.html @@ -63,7 +63,7 @@
@@ -72,13 +72,13 @@
-

This is the complete list of members for oboe::Version, including all inherited members.

+

This is the complete list of members for oboe::Version, including all inherited members.

- - - - - + + + + +
Majoroboe::Versionstatic
Minoroboe::Versionstatic
Numberoboe::Versionstatic
Patchoboe::Versionstatic
Textoboe::Versionstatic
Majoroboe::Versionstatic
Minoroboe::Versionstatic
Numberoboe::Versionstatic
Patchoboe::Versionstatic
Textoboe::Versionstatic
diff --git a/docs/reference/a00063.html b/docs/reference/a00063.html new file mode 100644 index 000000000..c34b9391d --- /dev/null +++ b/docs/reference/a00063.html @@ -0,0 +1,90 @@ + + + + + + + +Oboe: Member List + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
oboe::Version Member List
+
+
+ +

This is the complete list of members for oboe::Version, including all inherited members.

+ + + + + + +
Majoroboe::Versionstatic
Minoroboe::Versionstatic
Numberoboe::Versionstatic
Patchoboe::Versionstatic
Textoboe::Versionstatic
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/a00064.html b/docs/reference/a00064.html index 324b678a2..dc8f3b79a 100644 --- a/docs/reference/a00064.html +++ b/docs/reference/a00064.html @@ -74,6 +74,8 @@
oboe::Version Struct Reference
+ +

#include <Version.h>

@@ -88,7 +90,9 @@

Static Public Attributes

static constexpr uint32_t Number = OBOE_VERSION_NUMBER
 
-

Member Data Documentation

+

Detailed Description

+

Oboe versioning object

+

Member Data Documentation

◆ Major

diff --git a/docs/reference/structoboe_1_1_version.html b/docs/reference/a00065.html similarity index 89% rename from docs/reference/structoboe_1_1_version.html rename to docs/reference/a00065.html index a4dc7f532..b4b90d62a 100644 --- a/docs/reference/structoboe_1_1_version.html +++ b/docs/reference/a00065.html @@ -63,13 +63,13 @@
Static Public Attributes | -List of all members
+List of all members
oboe::Version Struct Reference
@@ -77,15 +77,15 @@ - + - + - + - + - +

Static Public Attributes

static constexpr uint8_t Major = OBOE_VERSION_MAJOR
static constexpr uint8_t Major = OBOE_VERSION_MAJOR
 
static constexpr uint8_t Minor = OBOE_VERSION_MINOR
static constexpr uint8_t Minor = OBOE_VERSION_MINOR
 
static constexpr uint16_t Patch = OBOE_VERSION_PATCH
static constexpr uint16_t Patch = OBOE_VERSION_PATCH
 
static constexpr const char * Text = OBOE_VERSION_TEXT
static constexpr const char * Text = OBOE_VERSION_TEXT
 
static constexpr uint32_t Number = OBOE_VERSION_NUMBER
static constexpr uint32_t Number = OBOE_VERSION_NUMBER
 

Member Data Documentation

@@ -200,12 +200,12 @@

-

Version string in the form MAJOR.MINOR.PATCH.

+

Version string in the form MAJOR.MINOR.PATCH.

The documentation for this struct was generated from the following file: diff --git a/docs/reference/a00066.html b/docs/reference/a00066.html new file mode 100644 index 000000000..d96a5f6e1 --- /dev/null +++ b/docs/reference/a00066.html @@ -0,0 +1,218 @@ + + + + + + + +Oboe: oboe::Version Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
Oboe +  1.0 +
+
Audio library for Android
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Static Public Attributes | +List of all members
+
+
oboe::Version Struct Reference
+
+
+ + + + + + + + + + + + +

+Static Public Attributes

static constexpr uint8_t Major = OBOE_VERSION_MAJOR
 
static constexpr uint8_t Minor = OBOE_VERSION_MINOR
 
static constexpr uint16_t Patch = OBOE_VERSION_PATCH
 
static constexpr const char * Text = OBOE_VERSION_TEXT
 
static constexpr uint32_t Number = OBOE_VERSION_NUMBER
 
+

Member Data Documentation

+ +

◆ Major

+ +
+
+ + + + + +
+ + + + +
constexpr uint8_t oboe::Version::Major = OBOE_VERSION_MAJOR
+ 		+static
+
+

This is incremented when we make breaking API changes. Based loosely on https://semver.org/.

+ +
+
+ +

◆ Minor

+ +
+
+ + + + + +
+ + + + +
constexpr uint8_t oboe::Version::Minor = OBOE_VERSION_MINOR
+ 		+static
+
+

This is incremented when we add backwards compatible functionality. Or set to zero when MAJOR is incremented.

+ +
+
+ +

◆ Number

+ +
+
+ + + + + +
+ + + + +
constexpr uint32_t oboe::Version::Number = OBOE_VERSION_NUMBER
+ 		+static
+
+

Integer representation of the current Oboe library version. This will always increase when the version number changes so can be compared using integer comparison.

+ +
+
+ +

◆ Patch

+ +
+
+ + + + + +
+ + + + +
constexpr uint16_t oboe::Version::Patch = OBOE_VERSION_PATCH
+ 		+static
+
+

This is incremented when we make backwards compatible bug fixes. Or set to zero when MINOR is incremented.

+ +
+
+ +

◆ Text

+ +
+
+ + + + + +
+ + + + +
constexpr const char* oboe::Version::Text = OBOE_VERSION_TEXT
+ 		+static
+
+

Version string in the form MAJOR.MINOR.PATCH.

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.14 +
+ + diff --git a/docs/reference/classoboe_1_1_audio_stream-members.html b/docs/reference/classoboe_1_1_audio_stream-members.html deleted file mode 100644 index 4d73bb2ae..000000000 --- a/docs/reference/classoboe_1_1_audio_stream-members.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - -Oboe: Member List - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
oboe::AudioStream Member List
-
-
- -

This is the complete list of members for oboe::AudioStream, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AudioStream() (defined in oboe::AudioStream)oboe::AudioStreaminline
AudioStream(const AudioStreamBuilder &builder) (defined in oboe::AudioStream)oboe::AudioStreamexplicit
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
calculateLatencyMillis()oboe::AudioStreaminlinevirtual
close()=0oboe::AudioStreampure virtual
fireCallback(void *audioData, int numFrames) (defined in oboe::AudioStream)oboe::AudioStreamprotected
flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
getAudioApi() const =0oboe::AudioStreampure virtual
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getBytesPerFrame() const (defined in oboe::AudioStream)oboe::AudioStreaminline
getBytesPerSample() const (defined in oboe::AudioStream)oboe::AudioStream
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerBurst()=0oboe::AudioStreampure virtual
getFramesPerCallback() constoboe::AudioStreamBaseinline
getFramesRead() (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getFramesWritten()oboe::AudioStreaminlinevirtual
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getState()=0oboe::AudioStreampure virtual
getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
getUnderlyingStream() constoboe::AudioStreaminlinevirtual
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getXRunCount() constoboe::AudioStreaminlinevirtual
incrementFramesRead(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
incrementFramesWritten(int32_t frames) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
isPlaying() (defined in oboe::AudioStream)oboe::AudioStream
isXRunCountSupported() const =0oboe::AudioStreampure virtual
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesRead (defined in oboe::AudioStream)oboe::AudioStreamprotected
mFramesWritten (defined in oboe::AudioStream)oboe::AudioStreamprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mNativeFormat (defined in oboe::AudioStream)oboe::AudioStreamprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
onDefaultCallback(void *audioData, int numFrames)oboe::AudioStreaminlineprotectedvirtual
open()oboe::AudioStreamvirtual
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds) (defined in oboe::AudioStream)oboe::AudioStreaminlinevirtual
requestFlush()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestPause()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestStart()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
requestStop()=0 (defined in oboe::AudioStream)oboe::AudioStreampure virtual
setBufferSizeInFrames(int32_t requestedFrames)oboe::AudioStreaminlinevirtual
setNativeFormat(AudioFormat format) (defined in oboe::AudioStream)oboe::AudioStreaminlineprotectedvirtual
start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos) (defined in oboe::AudioStream)oboe::AudioStreamvirtual
usesAAudio() constoboe::AudioStreaminline
waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0oboe::AudioStreampure virtual
waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)oboe::AudioStreamprotectedvirtual
write(const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)oboe::AudioStreaminlinevirtual
~AudioStream()=default (defined in oboe::AudioStream)oboe::AudioStreamvirtual
~AudioStreamBase()=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBasevirtual
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream.html b/docs/reference/classoboe_1_1_audio_stream.html deleted file mode 100644 index 476949721..000000000 --- a/docs/reference/classoboe_1_1_audio_stream.html +++ /dev/null @@ -1,843 +0,0 @@ - - - - - - - -Oboe: oboe::AudioStream Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -Protected Member Functions | -Protected Attributes | -List of all members
-
-
oboe::AudioStream Class Referenceabstract
-
-
- -

#include <AudioStream.h>

-
-Inheritance diagram for oboe::AudioStream:
-
-
- - -oboe::AudioStreamBase - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

- AudioStream (const AudioStreamBuilder &builder)
 
virtual Result open ()
 
virtual Result close ()=0
 
-virtual Result start (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result pause (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result flush (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result stop (int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
 
-virtual Result requestStart ()=0
 
-virtual Result requestPause ()=0
 
-virtual Result requestFlush ()=0
 
-virtual Result requestStop ()=0
 
virtual StreamState getState ()=0
 
virtual Result waitForStateChange (StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
 
virtual ResultWithValue< int32_t > setBufferSizeInFrames (int32_t requestedFrames)
 
virtual ResultWithValue< int32_t > getXRunCount () const
 
virtual bool isXRunCountSupported () const =0
 
virtual int32_t getFramesPerBurst ()=0
 
-bool isPlaying ()
 
-int32_t getBytesPerFrame () const
 
-int32_t getBytesPerSample () const
 
virtual int64_t getFramesWritten ()
 
-virtual int64_t getFramesRead ()
 
virtual ResultWithValue< double > calculateLatencyMillis ()
 
-virtual Result getTimestamp (clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds)
 
virtual ResultWithValue< int32_t > write (const void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
 
-virtual ResultWithValue< int32_t > read (void *buffer, int32_t numFrames, int64_t timeoutNanoseconds)
 
virtual AudioApi getAudioApi () const =0
 
bool usesAAudio () const
 
virtual void * getUnderlyingStream () const
 
- Public Member Functions inherited from oboe::AudioStreamBase
- AudioStreamBase (const AudioStreamBase &)=default
 
-AudioStreamBase & operator= (const AudioStreamBase &)=default
 
int getChannelCount () const
 
Direction getDirection () const
 
int32_t getSampleRate () const
 
int getFramesPerCallback () const
 
AudioFormat getFormat () const
 
virtual int32_t getBufferSizeInFrames ()
 
virtual int32_t getBufferCapacityInFrames () const
 
-SharingMode getSharingMode () const
 
-PerformanceMode getPerformanceMode () const
 
-int32_t getDeviceId () const
 
-AudioStreamCallback * getCallback () const
 
-Usage getUsage () const
 
-ContentType getContentType () const
 
-InputPreset getInputPreset () const
 
-SessionId getSessionId () const
 
- - - - - - - - - - - - - -

-Protected Member Functions

-virtual int64_t incrementFramesWritten (int32_t frames)
 
-virtual int64_t incrementFramesRead (int32_t frames)
 
virtual Result waitForStateTransition (StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
 
virtual DataCallbackResult onDefaultCallback (void *audioData, int numFrames)
 
-DataCallbackResult fireCallback (void *audioData, int numFrames)
 
-virtual void setNativeFormat (AudioFormat format)
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Protected Attributes

-AudioFormat mNativeFormat = AudioFormat::Invalid
 
-int64_t mFramesWritten = 0
 
-int64_t mFramesRead = 0
 
- Protected Attributes inherited from oboe::AudioStreamBase
-AudioStreamCallback * mStreamCallback = nullptr
 
-int32_t mFramesPerCallback = kUnspecified
 
-int32_t mChannelCount = kUnspecified
 
-int32_t mSampleRate = kUnspecified
 
-int32_t mDeviceId = kUnspecified
 
-int32_t mBufferCapacityInFrames = kUnspecified
 
-int32_t mBufferSizeInFrames = kUnspecified
 
-int32_t mFramesPerBurst = kUnspecified
 
-SharingMode mSharingMode = SharingMode::Shared
 
-AudioFormat mFormat = AudioFormat::Unspecified
 
-Direction mDirection = Direction::Output
 
-PerformanceMode mPerformanceMode = PerformanceMode::None
 
-Usage mUsage = Usage::Media
 
-ContentType mContentType = ContentType::Music
 
-InputPreset mInputPreset = InputPreset::VoiceRecognition
 
-SessionId mSessionId = SessionId::None
 
-

Detailed Description

-

Base class for Oboe C++ audio stream.

-

Member Function Documentation

- -

◆ calculateLatencyMillis()

- -
-
- - - - - -
- - - - - - - -
virtual ResultWithValue<double> oboe::AudioStream::calculateLatencyMillis ()
- 		-inlinevirtual
-
-

Calculate the latency of a stream based on getTimestamp().

-

Output latency is the time it takes for a given frame to travel from the app to some type of digital-to-analog converter. If the DAC is external, for example in a USB interface or a TV connected by HDMI, then there may be additional latency that the Android device is unaware of.

-

Input latency is the time it takes to a given frame to travel from an analog-to-digital converter (ADC) to the app.

-

Note that the latency of an OUTPUT stream will increase abruptly when you write data to it and then decrease slowly over time as the data is consumed.

-

The latency of an INPUT stream will decrease abruptly when you read data from it and then increase slowly over time as more data arrives.

-

The latency of an OUTPUT stream is generally higher than the INPUT latency because an app generally tries to keep the OUTPUT buffer full and the INPUT buffer empty.

-
Returns
a ResultWithValue which has a result of Result::OK and a value containing the latency in milliseconds, or a result of Result::Error*.
- -
-
- -

◆ close()

- -
-
- - - - - -
- - - - - - - -
virtual Result oboe::AudioStream::close ()
- 		-pure virtual
-
-

Close the stream and deallocate any resources from the open() call.

- -
-
- -

◆ getAudioApi()

- -
-
- - - - - -
- - - - - - - -
virtual AudioApi oboe::AudioStream::getAudioApi () const
- 		-pure virtual
-
-
Returns
the API that this stream uses
- -
-
- -

◆ getFramesPerBurst()

- -
-
- - - - - -
- - - - - - - -
virtual int32_t oboe::AudioStream::getFramesPerBurst ()
- 		-pure virtual
-
-

Query the number of frames that are read or written by the endpoint at one time.

-
Returns
burst size
- -
-
- -

◆ getFramesWritten()

- -
-
- - - - - -
- - - - - - - -
virtual int64_t oboe::AudioStream::getFramesWritten ()
- 		-inlinevirtual
-
-

This monotonic counter will never get reset.

Returns
the number of frames written so far
- -
-
- -

◆ getState()

- -
-
- - - - - -
- - - - - - - -
virtual StreamState oboe::AudioStream::getState ()
- 		-pure virtual
-
-

Query the current state, eg. StreamState::Pausing

-
Returns
state or a negative error.
- -
-
- -

◆ getUnderlyingStream()

- -
-
- - - - - -
- - - - - - - -
virtual void* oboe::AudioStream::getUnderlyingStream () const
- 		-inlinevirtual
-
-

Do not use this for production. This is only for debugging. If you need to call this method then something is wrong. If you think you need it for production then please let us know so we can modify Oboe so that you don't need this.

-
Returns
nullptr or a pointer to a stream from the system API
- -
-
- -

◆ getXRunCount()

- -
-
- - - - - -
- - - - - - - -
virtual ResultWithValue<int32_t> oboe::AudioStream::getXRunCount () const
- 		-inlinevirtual
-
-

An XRun is an Underrun or an Overrun. During playing, an underrun will occur if the stream is not written in time and the system runs out of valid data. During recording, an overrun will occur if the stream is not read in time and there is no place to put the incoming data so it is discarded.

-

An underrun or overrun can cause an audible "pop" or "glitch".

-
Returns
a result which is either Result::OK with the xRun count as the value, or a Result::Error* code
- -
-
- -

◆ isXRunCountSupported()

- -
-
- - - - - -
- - - - - - - -
virtual bool oboe::AudioStream::isXRunCountSupported () const
- 		-pure virtual
-
-
Returns
true if XRun counts are supported on the stream
- -
-
- -

◆ onDefaultCallback()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
virtual DataCallbackResult oboe::AudioStream::onDefaultCallback (void * audioData,
int numFrames 
)
- 		-inlineprotectedvirtual
-
-

Override this to provide a default for when the application did not specify a callback.

-
Parameters
- - - -
audioData
numFrames
-
-
-
Returns
result
- -
-
- -

◆ open()

- -
-
- - - - - -
- - - - - - - -
virtual Result oboe::AudioStream::open ()
- 		-virtual
-
-

Open a stream based on the current settings.

-

Note that we do not recommend re-opening a stream that has been closed. TODO Should we prevent re-opening?

-
Returns
- -
-
- -

◆ setBufferSizeInFrames()

- -
-
- - - - - -
- - - - - - - - -
virtual ResultWithValue<int32_t> oboe::AudioStream::setBufferSizeInFrames (int32_t requestedFrames)
- 		-inlinevirtual
-
-

This can be used to adjust the latency of the buffer by changing the threshold where blocking will occur. By combining this with getXRunCount(), the latency can be tuned at run-time for each device.

-

This cannot be set higher than getBufferCapacity().

-
Parameters
- - -
requestedFramesrequested number of frames that can be filled without blocking
-
-
-
Returns
the resulting buffer size in frames (obtained using value()) or an error (obtained using error())
- -
-
- -

◆ usesAAudio()

- -
-
- - - - - -
- - - - - - - -
bool oboe::AudioStream::usesAAudio () const
- 		-inline
-
-
Returns
true if this stream is implemented using the AAudio API
- -
-
- -

◆ waitForStateChange()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
virtual Result oboe::AudioStream::waitForStateChange (StreamState inputState,
StreamState * nextState,
int64_t timeoutNanoseconds 
)
- 		-pure virtual
-
-

Wait until the stream's current state no longer matches the input state. The input state is passed to avoid race conditions caused by the state changing between calls.

-

Note that generally applications do not need to call this. It is considered an advanced technique.

-

-int64_t timeoutNanos = 500 * kNanosPerMillisecond; // arbitrary 1/2 second
-StreamState currentState = stream->getState();
-StreamState nextState = StreamState::Unknown;
-while (result == Result::OK && currentState != StreamState::Paused) {
-    result = stream->waitForStateChange(
-                                  currentState, &nextState, timeoutNanos);
-    currentState = nextState;
-}
-
Parameters
- - - - -
inputStateThe state we want to avoid.
nextStatePointer to a variable that will be set to the new state.
timeoutNanosecondsThe maximum time to wait in nanoseconds.
-
-
-
Returns
Result::OK or a Result::Error.
- -
-
- -

◆ waitForStateTransition()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
virtual Result oboe::AudioStream::waitForStateTransition (StreamState startingState,
StreamState endingState,
int64_t timeoutNanoseconds 
)
- 		-protectedvirtual
-
-

Wait for a transition from one state to another.

Returns
OK if the endingState was observed, or ErrorUnexpectedState if any state that was not the startingState or endingState was observed or ErrorTimeout.
- -
-
- -

◆ write()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
virtual ResultWithValue<int32_t> oboe::AudioStream::write (const void * buffer,
int32_t numFrames,
int64_t timeoutNanoseconds 
)
- 		-inlinevirtual
-
-

A high level write that will wait until the write is complete or it runs out of time. If timeoutNanoseconds is zero then this call will not wait.

-
Parameters
- - - - - -
streamA stream created using OboeStream_Open().
bufferThe address of the first sample.
numFramesNumber of frames to write. Only complete frames will be written.
timeoutNanosecondsMaximum number of nanoseconds to wait for completion.
-
-
-
Returns
a ResultWithValue which has a result of Result::OK and a value containing the number of frames actually written, or result of Result::Error*.
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream_base-members.html b/docs/reference/classoboe_1_1_audio_stream_base-members.html deleted file mode 100644 index 6a058454e..000000000 --- a/docs/reference/classoboe_1_1_audio_stream_base-members.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - -Oboe: Member List - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
oboe::AudioStreamBase Member List
-
-
- -

This is the complete list of members for oboe::AudioStreamBase, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerCallback() constoboe::AudioStreamBaseinline
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
~AudioStreamBase()=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBasevirtual
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream_base.html b/docs/reference/classoboe_1_1_audio_stream_base.html deleted file mode 100644 index 31d7a970a..000000000 --- a/docs/reference/classoboe_1_1_audio_stream_base.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - -Oboe: oboe::AudioStreamBase Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -Protected Attributes | -List of all members
-
-
oboe::AudioStreamBase Class Reference
-
-
- -

#include <AudioStreamBase.h>

-
-Inheritance diagram for oboe::AudioStreamBase:
-
-
- - -oboe::AudioStream -oboe::AudioStreamBuilder - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

- AudioStreamBase (const AudioStreamBase &)=default
 
-AudioStreamBase & operator= (const AudioStreamBase &)=default
 
int getChannelCount () const
 
Direction getDirection () const
 
int32_t getSampleRate () const
 
int getFramesPerCallback () const
 
AudioFormat getFormat () const
 
virtual int32_t getBufferSizeInFrames ()
 
virtual int32_t getBufferCapacityInFrames () const
 
-SharingMode getSharingMode () const
 
-PerformanceMode getPerformanceMode () const
 
-int32_t getDeviceId () const
 
-AudioStreamCallback * getCallback () const
 
-Usage getUsage () const
 
-ContentType getContentType () const
 
-InputPreset getInputPreset () const
 
-SessionId getSessionId () const
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Protected Attributes

-AudioStreamCallback * mStreamCallback = nullptr
 
-int32_t mFramesPerCallback = kUnspecified
 
-int32_t mChannelCount = kUnspecified
 
-int32_t mSampleRate = kUnspecified
 
-int32_t mDeviceId = kUnspecified
 
-int32_t mBufferCapacityInFrames = kUnspecified
 
-int32_t mBufferSizeInFrames = kUnspecified
 
-int32_t mFramesPerBurst = kUnspecified
 
-SharingMode mSharingMode = SharingMode::Shared
 
-AudioFormat mFormat = AudioFormat::Unspecified
 
-Direction mDirection = Direction::Output
 
-PerformanceMode mPerformanceMode = PerformanceMode::None
 
-Usage mUsage = Usage::Media
 
-ContentType mContentType = ContentType::Music
 
-InputPreset mInputPreset = InputPreset::VoiceRecognition
 
-SessionId mSessionId = SessionId::None
 
-

Detailed Description

-

Base class containing parameters for Oboe streams and builders.

-

OboeStreamBuilder can return OBOE_UNSPECIFIED or the requested value.

-

OboeStream will generally return the actual final value, but getFramesPerCallback() can be unspecified even for a stream.

-

Member Function Documentation

- -

◆ getBufferCapacityInFrames()

- -
-
- - - - - -
- - - - - - - -
virtual int32_t oboe::AudioStreamBase::getBufferCapacityInFrames () const
- 		-inlinevirtual
-
-
Returns
capacityInFrames or OBOE_UNSPECIFIED
- -
-
- -

◆ getBufferSizeInFrames()

- -
-
- - - - - -
- - - - - - - -
virtual int32_t oboe::AudioStreamBase::getBufferSizeInFrames ()
- 		-inlinevirtual
-
-

Query the maximum number of frames that can be filled without blocking. If the stream has been closed the last known value will be returned.

-
Returns
buffer size
- -
-
- -

◆ getChannelCount()

- -
-
- - - - - -
- - - - - - - -
int oboe::AudioStreamBase::getChannelCount () const
- 		-inline
-
-
Returns
number of channels, for example 2 for stereo
- -
-
- -

◆ getDirection()

- -
-
- - - - - -
- - - - - - - -
Direction oboe::AudioStreamBase::getDirection () const
- 		-inline
-
-
Returns
Direction::Input or Direction::Output
- -
-
- -

◆ getFormat()

- -
-
- - - - - -
- - - - - - - -
AudioFormat oboe::AudioStreamBase::getFormat () const
- 		-inline
-
-
Returns
OBOE_AUDIO_FORMAT_PCM_FLOAT, OBOE_AUDIO_FORMAT_PCM_I16 or OBOE_AUDIO_FORMAT_UNSPECIFIED
- -
-
- -

◆ getFramesPerCallback()

- -
-
- - - - - -
- - - - - - - -
int oboe::AudioStreamBase::getFramesPerCallback () const
- 		-inline
-
-
Returns
framesPerCallback or OBOE_UNSPECIFIED
- -
-
- -

◆ getSampleRate()

- -
-
- - - - - -
- - - - - - - -
int32_t oboe::AudioStreamBase::getSampleRate () const
- 		-inline
-
-
Returns
sample rate for the stream
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream_builder-members.html b/docs/reference/classoboe_1_1_audio_stream_builder-members.html deleted file mode 100644 index 72e7f0675..000000000 --- a/docs/reference/classoboe_1_1_audio_stream_builder-members.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - -Oboe: Member List - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
oboe::AudioStreamBuilder Member List
-
-
- -

This is the complete list of members for oboe::AudioStreamBuilder, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AudioStreamBase() (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
AudioStreamBase(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
AudioStreamBuilder() (defined in oboe::AudioStreamBuilder)oboe::AudioStreamBuilderinline
getAudioApi() const (defined in oboe::AudioStreamBuilder)oboe::AudioStreamBuilderinline
getBufferCapacityInFrames() constoboe::AudioStreamBaseinlinevirtual
getBufferSizeInFrames()oboe::AudioStreamBaseinlinevirtual
getCallback() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getChannelCount() constoboe::AudioStreamBaseinline
getContentType() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDeviceId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getDirection() constoboe::AudioStreamBaseinline
getFormat() constoboe::AudioStreamBaseinline
getFramesPerCallback() constoboe::AudioStreamBaseinline
getInputPreset() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getPerformanceMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSampleRate() constoboe::AudioStreamBaseinline
getSessionId() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getSharingMode() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
getUsage() const (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseinline
isAAudioRecommended()oboe::AudioStreamBuilderstatic
isAAudioSupported()oboe::AudioStreamBuilderstatic
mBufferCapacityInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mBufferSizeInFrames (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mChannelCount (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mContentType (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDeviceId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mDirection (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFormat (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerBurst (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mFramesPerCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mInputPreset (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mPerformanceMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSampleRate (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSessionId (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mSharingMode (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mStreamCallback (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
mUsage (defined in oboe::AudioStreamBase)oboe::AudioStreamBaseprotected
openStream(AudioStream **stream)oboe::AudioStreamBuilder
operator=(const AudioStreamBase &)=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBase
setAudioApi(AudioApi audioApi)oboe::AudioStreamBuilderinline
setBufferCapacityInFrames(int32_t bufferCapacityInFrames)oboe::AudioStreamBuilderinline
setCallback(AudioStreamCallback *streamCallback)oboe::AudioStreamBuilderinline
setChannelCount(int channelCount)oboe::AudioStreamBuilderinline
setContentType(ContentType contentType)oboe::AudioStreamBuilderinline
setDeviceId(int32_t deviceId)oboe::AudioStreamBuilderinline
setDirection(Direction direction)oboe::AudioStreamBuilderinline
setFormat(AudioFormat format)oboe::AudioStreamBuilderinline
setFramesPerCallback(int framesPerCallback)oboe::AudioStreamBuilderinline
setInputPreset(InputPreset inputPreset)oboe::AudioStreamBuilderinline
setPerformanceMode(PerformanceMode performanceMode)oboe::AudioStreamBuilderinline
setSampleRate(int32_t sampleRate)oboe::AudioStreamBuilderinline
setSessionId(SessionId sessionId)oboe::AudioStreamBuilderinline
setSharingMode(SharingMode sharingMode)oboe::AudioStreamBuilderinline
setUsage(Usage usage)oboe::AudioStreamBuilderinline
~AudioStreamBase()=default (defined in oboe::AudioStreamBase)oboe::AudioStreamBasevirtual
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream_builder.html b/docs/reference/classoboe_1_1_audio_stream_builder.html deleted file mode 100644 index aaa772f64..000000000 --- a/docs/reference/classoboe_1_1_audio_stream_builder.html +++ /dev/null @@ -1,842 +0,0 @@ - - - - - - - -Oboe: oboe::AudioStreamBuilder Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -Static Public Member Functions | -List of all members
-
-
oboe::AudioStreamBuilder Class Reference
-
-
- -

#include <AudioStreamBuilder.h>

-
-Inheritance diagram for oboe::AudioStreamBuilder:
-
-
- - -oboe::AudioStreamBase - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

AudioStreamBuilder * setChannelCount (int channelCount)
 
AudioStreamBuilder * setDirection (Direction direction)
 
AudioStreamBuilder * setSampleRate (int32_t sampleRate)
 
AudioStreamBuilder * setFramesPerCallback (int framesPerCallback)
 
AudioStreamBuilder * setFormat (AudioFormat format)
 
AudioStreamBuilder * setBufferCapacityInFrames (int32_t bufferCapacityInFrames)
 
-AudioApi getAudioApi () const
 
AudioStreamBuilder * setAudioApi (AudioApi audioApi)
 
AudioStreamBuilder * setSharingMode (SharingMode sharingMode)
 
AudioStreamBuilder * setPerformanceMode (PerformanceMode performanceMode)
 
AudioStreamBuilder * setUsage (Usage usage)
 
AudioStreamBuilder * setContentType (ContentType contentType)
 
AudioStreamBuilder * setInputPreset (InputPreset inputPreset)
 
AudioStreamBuilder * setSessionId (SessionId sessionId)
 
AudioStreamBuilder * setDeviceId (int32_t deviceId)
 
AudioStreamBuilder * setCallback (AudioStreamCallback *streamCallback)
 
Result openStream (AudioStream **stream)
 
- Public Member Functions inherited from oboe::AudioStreamBase
- AudioStreamBase (const AudioStreamBase &)=default
 
-AudioStreamBase & operator= (const AudioStreamBase &)=default
 
int getChannelCount () const
 
Direction getDirection () const
 
int32_t getSampleRate () const
 
int getFramesPerCallback () const
 
AudioFormat getFormat () const
 
virtual int32_t getBufferSizeInFrames ()
 
virtual int32_t getBufferCapacityInFrames () const
 
-SharingMode getSharingMode () const
 
-PerformanceMode getPerformanceMode () const
 
-int32_t getDeviceId () const
 
-AudioStreamCallback * getCallback () const
 
-Usage getUsage () const
 
-ContentType getContentType () const
 
-InputPreset getInputPreset () const
 
-SessionId getSessionId () const
 
- - - - - -

-Static Public Member Functions

static bool isAAudioSupported ()
 
static bool isAAudioRecommended ()
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Additional Inherited Members

- Protected Attributes inherited from oboe::AudioStreamBase
-AudioStreamCallback * mStreamCallback = nullptr
 
-int32_t mFramesPerCallback = kUnspecified
 
-int32_t mChannelCount = kUnspecified
 
-int32_t mSampleRate = kUnspecified
 
-int32_t mDeviceId = kUnspecified
 
-int32_t mBufferCapacityInFrames = kUnspecified
 
-int32_t mBufferSizeInFrames = kUnspecified
 
-int32_t mFramesPerBurst = kUnspecified
 
-SharingMode mSharingMode = SharingMode::Shared
 
-AudioFormat mFormat = AudioFormat::Unspecified
 
-Direction mDirection = Direction::Output
 
-PerformanceMode mPerformanceMode = PerformanceMode::None
 
-Usage mUsage = Usage::Media
 
-ContentType mContentType = ContentType::Music
 
-InputPreset mInputPreset = InputPreset::VoiceRecognition
 
-SessionId mSessionId = SessionId::None
 
-

Detailed Description

-

Factory class for an audio Stream.

-

Member Function Documentation

- -

◆ isAAudioRecommended()

- -
-
- - - - - -
- - - - - - - -
static bool oboe::AudioStreamBuilder::isAAudioRecommended ()
- 		-static
-
-

Is the AAudio API recommended this device?

-

AAudio may be supported but not recommended because of version specific issues.

-
Returns
true if recommended
- -
-
- -

◆ isAAudioSupported()

- -
-
- - - - - -
- - - - - - - -
static bool oboe::AudioStreamBuilder::isAAudioSupported ()
- 		-static
-
-

Is the AAudio API supported on this device?

-

AAudio was introduced in the Oreo release.

-
Returns
true if supported
- -
-
- -

◆ openStream()

- -
-
- - - - - - - - -
Result oboe::AudioStreamBuilder::openStream (AudioStream ** stream)
-
-

Create and open a stream object based on the current settings.

-
Parameters
- - -
streampointer to a variable to receive the stream address
-
-
-
Returns
OBOE_OK if successful or a negative error code
- -
-
- -

◆ setAudioApi()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setAudioApi (AudioApi audioApi)
- 		-inline
-
-

If you leave this unspecified then Oboe will choose the best API for the device and SDK version at runtime.

-

If the caller requests AAudio and it is supported then AAudio will be used.

-
Parameters
- - -
audioApiMust be AudioApi::Unspecified, AudioApi::OpenSLES or AudioApi::AAudio.
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setBufferCapacityInFrames()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setBufferCapacityInFrames (int32_t bufferCapacityInFrames)
- 		-inline
-
-

Set the requested maximum buffer capacity in frames. The final stream capacity may differ, but will probably be at least this big.

-

Default is kUnspecified.

-
Parameters
- - -
bufferCapacityInFramesthe desired buffer capacity in frames or kUnspecified
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setCallback()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setCallback (AudioStreamCallback * streamCallback)
- 		-inline
-
-

Specifies an object to handle data or error related callbacks from the underlying API.

-

When an error callback occurs, the associated stream will be stopped and closed in a separate thread.

-

A note on why the streamCallback parameter is a raw pointer rather than a smart pointer:

-

The caller should retain ownership of the object streamCallback points to. At first glance weak_ptr may seem like a good candidate for streamCallback as this implies temporary ownership. However, a weak_ptr can only be created from a shared_ptr. A shared_ptr incurs some performance overhead. The callback object is likely to be accessed every few milliseconds when the stream requires new data so this overhead is something we want to avoid.

-

This leaves a raw pointer as the logical type choice. The only caveat being that the caller must not destroy the callback before the stream has been closed.

-
Parameters
- - -
streamCallback
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setChannelCount()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setChannelCount (int channelCount)
- 		-inline
-
-

Request a specific number of channels.

-

Default is kUnspecified. If the value is unspecified then the application should query for the actual value after the stream is opened.

- -
-
- -

◆ setContentType()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setContentType (ContentType contentType)
- 		-inline
-
-

Set the type of audio data that the stream will carry.

-

The system will use this information to optimize the behavior of the stream. This could, for example, affect whether a stream is paused when a notification occurs.

-

The default, if you do not call this function, is ContentType::Music.

-

Added in API level 28.

-
Parameters
- - -
contentTypethe type of audio data, eg. ContentType::Speech
-
-
- -
-
- -

◆ setDeviceId()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setDeviceId (int32_t deviceId)
- 		-inline
-
-

Request an audio device identified device using an ID. On Android, for example, the ID could be obtained from the Java AudioManager.

-

By default, the primary device will be used.

-

Note that when using OpenSL ES, this will be ignored and the created stream will have deviceId kUnspecified.

-
Parameters
- - -
deviceIddevice identifier or kUnspecified
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setDirection()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setDirection (Direction direction)
- 		-inline
-
-

Request the direction for a stream. The default is Direction::Output.

-
Parameters
- - -
directionDirection::Output or Direction::Input
-
-
- -
-
- -

◆ setFormat()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setFormat (AudioFormat format)
- 		-inline
-
-

Request a sample data format, for example Format::Float.

-

Default is Format::Unspecified. If the value is unspecified then the application should query for the actual value after the stream is opened.

- -
-
- -

◆ setFramesPerCallback()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setFramesPerCallback (int framesPerCallback)
- 		-inline
-
-

Request a specific number of frames for the data callback.

-

Default is kUnspecified. If the value is unspecified then the actual number may vary from callback to callback.

-

If an application can handle a varying number of frames then we recommend leaving this unspecified. This allow the underlying API to optimize the callbacks. But if your application is, for example, doing FFTs or other block oriented operations, then call this function to get the sizes you need.

-
Parameters
- - -
framesPerCallback
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setInputPreset()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setInputPreset (InputPreset inputPreset)
- 		-inline
-
-

Set the input (capture) preset for the stream.

-

The system will use this information to optimize the behavior of the stream. This could, for example, affect which microphones are used and how the recorded data is processed.

-

The default, if you do not call this function, is InputPreset::VoiceRecognition. That is because VoiceRecognition is the preset with the lowest latency on many platforms.

-

Added in API level 28.

-
Parameters
- - -
inputPresetthe desired configuration for recording
-
-
- -
-
- -

◆ setPerformanceMode()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setPerformanceMode (PerformanceMode performanceMode)
- 		-inline
-
-

Request a performance level for the stream. This will determine the latency, the power consumption, and the level of protection from glitches.

-
Parameters
- - -
performanceModefor example, PerformanceMode::LowLatency
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setSampleRate()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setSampleRate (int32_t sampleRate)
- 		-inline
-
-

Request a specific sample rate in Hz.

-

Default is kUnspecified. If the value is unspecified then the application should query for the actual value after the stream is opened.

-

Technically, this should be called the "frame rate" or "frames per second", because it refers to the number of complete frames transferred per second. But it is traditionally called "sample rate". Se we use that term.

- -
-
- -

◆ setSessionId()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setSessionId (SessionId sessionId)
- 		-inline
-
-

Set the requested session ID.

-

The session ID can be used to associate a stream with effects processors. The effects are controlled using the Android AudioEffect Java API.

-

The default, if you do not call this function, is SessionId::None.

-

If set to SessionId::Allocate then a session ID will be allocated when the stream is opened.

-

The allocated session ID can be obtained by calling AudioStream::getSessionId() and then used with this function when opening another stream. This allows effects to be shared between streams.

-

Session IDs from Oboe can be used the Android Java APIs and vice versa. So a session ID from an Oboe stream can be passed to Java and effects applied using the Java AudioEffect API.

-

Allocated session IDs will always be positive and nonzero.

-

Added in API level 28.

-
Parameters
- - -
sessionIdan allocated sessionID or SessionId::Allocate
-
-
- -
-
- -

◆ setSharingMode()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setSharingMode (SharingMode sharingMode)
- 		-inline
-
-

Request a mode for sharing the device. The requested sharing mode may not be available. So the application should query for the actual mode after the stream is opened.

-
Parameters
- - -
sharingModeSharingMode::Shared or SharingMode::Exclusive
-
-
-
Returns
pointer to the builder so calls can be chained
- -
-
- -

◆ setUsage()

- -
-
- - - - - -
- - - - - - - - -
AudioStreamBuilder* oboe::AudioStreamBuilder::setUsage (Usage usage)
- 		-inline
-
-

Set the intended use case for the stream.

-

The system will use this information to optimize the behavior of the stream. This could, for example, affect how volume and focus is handled for the stream.

-

The default, if you do not call this function, is Usage::Media.

-

Added in API level 28.

-
Parameters
- - -
usagethe desired usage, eg. Usage::Game
-
-
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_audio_stream_callback.html b/docs/reference/classoboe_1_1_audio_stream_callback.html deleted file mode 100644 index 20a548a34..000000000 --- a/docs/reference/classoboe_1_1_audio_stream_callback.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - -Oboe: oboe::AudioStreamCallback Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -List of all members
-
-
oboe::AudioStreamCallback Class Referenceabstract
-
-
- - - - - - - - -

-Public Member Functions

virtual DataCallbackResult onAudioReady (AudioStream *oboeStream, void *audioData, int32_t numFrames)=0
 
virtual void onErrorBeforeClose (AudioStream *oboeStream, Result error)
 
virtual void onErrorAfterClose (AudioStream *oboeStream, Result error)
 
-

Member Function Documentation

- -

◆ onAudioReady()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
virtual DataCallbackResult oboe::AudioStreamCallback::onAudioReady (AudioStream * oboeStream,
void * audioData,
int32_t numFrames 
)
- 		-pure virtual
-
-

A buffer is ready for processing.

-
Parameters
- - - - -
oboeStreampointer to the associated stream
audioDatabuffer containing input data or a place to put output data
numFramesnumber of frames to be processed
-
-
-
Returns
DataCallbackResult::Continue or DataCallbackResult::Stop
- -
-
- -

◆ onErrorAfterClose()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
virtual void oboe::AudioStreamCallback::onErrorAfterClose (AudioStream * oboeStream,
Result error 
)
- 		-inlinevirtual
-
-

This will be called when an error occurs on a stream or when the stream is disconnected. The underlying stream will already be stopped AND closed by Oboe. So the underlyng stream cannot be referenced.

-

This callback could be used to reopen a new stream on another device.

-
Parameters
- - - -
oboeStreampointer to the associated stream
error
-
-
- -
-
- -

◆ onErrorBeforeClose()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
virtual void oboe::AudioStreamCallback::onErrorBeforeClose (AudioStream * oboeStream,
Result error 
)
- 		-inlinevirtual
-
-

This will be called when an error occurs on a stream or when the stream is discomnnected. The underlying stream will already be stopped by Oboe but not yet closed. So the stream can be queried.

-
Parameters
- - - -
oboeStreampointer to the associated stream
error
-
-
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_default_stream_values.html b/docs/reference/classoboe_1_1_default_stream_values.html deleted file mode 100644 index a4dc3050b..000000000 --- a/docs/reference/classoboe_1_1_default_stream_values.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - -Oboe: oboe::DefaultStreamValues Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Static Public Attributes | -List of all members
-
-
oboe::DefaultStreamValues Class Reference
-
-
- - - - - - - - -

-Static Public Attributes

static int32_t SampleRate
 
-static int32_t FramesPerBurst
 
-static int32_t ChannelCount
 
-

Member Data Documentation

- -

◆ SampleRate

- -
-
- - - - - -
- - - - -
int32_t oboe::DefaultStreamValues::SampleRate
- 		-static
-
-

On API 16 to 25 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and framesPerBurst are not known by the native code. On API 17+ these values should be obtained from the AudioManager using this code:

-

-Note that this technique only works for built-in speakers and headphones.
-            AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
-            String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
-            int defaultSampleRate = Integer.parseInt(sampleRateStr);
-            String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
-            int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
-

It can then be passed down to Oboe through JNI.

-

AAudio will get the optimal framesPerBurst from the HAL and will ignore this value.

- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_latency_tuner.html b/docs/reference/classoboe_1_1_latency_tuner.html deleted file mode 100644 index 236f5e1a1..000000000 --- a/docs/reference/classoboe_1_1_latency_tuner.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - -Oboe: oboe::LatencyTuner Class Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -List of all members
-
-
oboe::LatencyTuner Class Reference
-
-
- -

#include <LatencyTuner.h>

- - - - - - - - -

-Public Member Functions

- LatencyTuner (AudioStream &stream)
 
Result tune ()
 
void requestReset ()
 
-

Detailed Description

-

This can be used to dynamically tune the latency of an output stream. It adjusts the bufferSize based on the number of underruns. The bufferSize is the portion of the total bufferCapacity that is used to store data.

-

This only affects the latency associated with the first level of buffering that is closest to the application. It does not affect low latency in the HAL, or touch latency in the UI.

-

Call tune() right before returning from your data callback function if using callbacks. Call tune() right before calling write() if using blocking writes.

-

If you want to see the ongoing results of this tuning process then call stream->getBufferSize() periodically.

-

Member Function Documentation

- -

◆ requestReset()

- -
-
- - - - - - - -
void oboe::LatencyTuner::requestReset ()
-
-

This may be called from another thread. Then tune() will call reset(), which will lower the latency to the minimum and then allow it to rise back up if there are glitches.

-

This is typically called in response to a user decision to minimize latency. In other words, call this from a button handler.

- -
-
- -

◆ tune()

- -
-
- - - - - - - -
Result oboe::LatencyTuner::tune ()
-
-

Adjust the bufferSizeInFrames to optimize latency. It will start with a low latency and then raise it if an underrun occurs.

-

Latency tuning is only supported for AAudio.

-
Returns
OK or negative error, ErrorUnimplemented for OpenSL ES
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/classoboe_1_1_result_with_value.html b/docs/reference/classoboe_1_1_result_with_value.html deleted file mode 100644 index 574596992..000000000 --- a/docs/reference/classoboe_1_1_result_with_value.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - - -Oboe: oboe::ResultWithValue< T > Class Template Reference - - - - - - - - - -
-
- - - - - - -
-
Oboe -  1.0 -
-
Audio library for Android
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -Static Public Member Functions | -List of all members
-
-
oboe::ResultWithValue< T > Class Template Reference
-
-
- - - - - - - - - - - - - - - - -

-Public Member Functions

- ResultWithValue (oboe::Result error)
 
- ResultWithValue (T value)
 
-oboe::Result error () const
 
-T value () const
 
 operator bool () const
 
bool operator! () const
 
 operator Result () const
 
- - - -

-Static Public Member Functions

static ResultWithValue< T > createBasedOnSign (T numericResult)
 
-

Member Function Documentation

- -

◆ createBasedOnSign()

- -
-
-
-template<typename T >
- - - - - -
- - - - - - - - -
static ResultWithValue<T> oboe::ResultWithValue< T >::createBasedOnSign (T numericResult)
- 		-inlinestatic
-
-

Create a ResultWithValue from a number. If the number is positive the ResultWithValue will have a result of Result::OK and the value will contain the number. If the number is negative the result will be obtained from the negative number (numeric error codes can be found in AAudio.h) and the value will be null.

- -
-
- -

◆ operator bool()

- -
-
-
-template<typename T >
- - - - - -
- - - - - - - -
oboe::ResultWithValue< T >::operator bool () const
- 		-inlineexplicit
-
-
Returns
true if OK
- -
-
- -

◆ operator Result()

- -
-
-
-template<typename T >
- - - - - -
- - - - - - - -
oboe::ResultWithValue< T >::operator Result () const
- 		-inline
-
-

Implicitly convert to a Result. This enables easy comparison with Result values. Example:

-

ResultWithValue result = openStream(); if (result == Result::ErrorNoMemory){ // tell user they're out of memory }

- -
-
- -

◆ operator!()

- -
-
-
-template<typename T >
- - - - - -
- - - - - - - -
bool oboe::ResultWithValue< T >::operator! () const
- 		-inline
-
-

Quick way to check for an error.

-

The caller could write something like this: if (!result) { printf("Got error %s\n", convertToText(result.error())); }

-
Returns
true if an error occurred
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.14 -
- - diff --git a/docs/reference/functions.html b/docs/reference/functions.html index b0b6618b0..78bbe9343 100644 --- a/docs/reference/functions.html +++ b/docs/reference/functions.html @@ -65,10 +65,23 @@
Here is a list of all documented class members with links to the class documentation for each member:
+

- a -

+ +

- c -

  • calculateLatencyMillis() : oboe::AudioStream
    • +
  • ChannelCount +: oboe::DefaultStreamValues +
  • close() : oboe::AudioStream
    • @@ -78,9 +91,30 @@

    - c -

    +

    - e -

    + + +

    - f -

    + +

    - g -

    • getAudioApi() : oboe::AudioStream +, oboe::AudioStreamBuilder
    • getBufferCapacityInFrames() : oboe::AudioStreamBase @@ -88,9 +122,24 @@

      - g -

      • getBufferSizeInFrames() : oboe::AudioStreamBase
        • +
      • getBytesPerFrame() +: oboe::AudioStream +
        • +
      • getBytesPerSample() +: oboe::AudioStream +
        • +
      • getCallback() +: oboe::AudioStreamBase +
      • getChannelCount() : oboe::AudioStreamBase
        • +
      • getContentType() +: oboe::AudioStreamBase +
        • +
      • getDeviceId() +: oboe::AudioStreamBase +
      • getDirection() : oboe::AudioStreamBase
        • @@ -103,18 +152,39 @@

        - g -

        • getFramesPerCallback() : oboe::AudioStreamBase
          • +
        • getFramesRead() +: oboe::AudioStream +
        • getFramesWritten() : oboe::AudioStream
          • +
        • getInputPreset() +: oboe::AudioStreamBase +
          • +
        • getPerformanceMode() +: oboe::AudioStreamBase +
        • getSampleRate() : oboe::AudioStreamBase
          • +
        • getSessionId() +: oboe::AudioStreamBase +
          • +
        • getSharingMode() +: oboe::AudioStreamBase +
        • getState() : oboe::AudioStream
          • +
        • getTimestamp() +: oboe::AudioStream +
        • getUnderlyingStream() : oboe::AudioStream
          • +
        • getUsage() +: oboe::AudioStreamBase +
        • getXRunCount() : oboe::AudioStream
          • @@ -122,25 +192,98 @@

          - g -

            - i -

            +

            - l -

            + +

            - m -

            @@ -179,6 +322,9 @@

            - o -

            @@ -186,13 +332,34 @@

            - p -

            - r -

            @@ -233,6 +400,9 @@

            - s -

            • setInputPreset() : oboe::AudioStreamBuilder
              • +
            • setNativeFormat() +: oboe::AudioStream +
            • setPerformanceMode() : oboe::AudioStreamBuilder
              • @@ -248,6 +418,12 @@

              - s -

              @@ -268,6 +444,13 @@

              - u -

              +

              - v -

              + +

              - w -

              • waitForStateChange() : oboe::AudioStream diff --git a/docs/reference/functions_func.html b/docs/reference/functions_func.html index 7c04dab89..0932c55ef 100644 --- a/docs/reference/functions_func.html +++ b/docs/reference/functions_func.html @@ -65,6 +65,16 @@
                  +

                - a -

                + +

                - c -

                • calculateLatencyMillis() : oboe::AudioStream @@ -78,9 +88,27 @@

                  - c -

                  +

                  - e -

                  + + +

                  - f -

                  + +

                  - g -

                  • getAudioApi() : oboe::AudioStream +, oboe::AudioStreamBuilder
                  • getBufferCapacityInFrames() : oboe::AudioStreamBase @@ -88,9 +116,24 @@

                    - g -

                    • getBufferSizeInFrames() : oboe::AudioStreamBase
                      • +
                    • getBytesPerFrame() +: oboe::AudioStream +
                      • +
                    • getBytesPerSample() +: oboe::AudioStream +
                      • +
                    • getCallback() +: oboe::AudioStreamBase +
                    • getChannelCount() : oboe::AudioStreamBase
                      • +
                    • getContentType() +: oboe::AudioStreamBase +
                      • +
                    • getDeviceId() +: oboe::AudioStreamBase +
                    • getDirection() : oboe::AudioStreamBase
                      • @@ -103,18 +146,39 @@

                      - g -

                      • getFramesPerCallback() : oboe::AudioStreamBase
                        • +
                      • getFramesRead() +: oboe::AudioStream +
                      • getFramesWritten() : oboe::AudioStream
                        • +
                      • getInputPreset() +: oboe::AudioStreamBase +
                        • +
                      • getPerformanceMode() +: oboe::AudioStreamBase +
                      • getSampleRate() : oboe::AudioStreamBase
                        • +
                      • getSessionId() +: oboe::AudioStreamBase +
                        • +
                      • getSharingMode() +: oboe::AudioStreamBase +
                      • getState() : oboe::AudioStream
                        • +
                      • getTimestamp() +: oboe::AudioStream +
                      • getUnderlyingStream() : oboe::AudioStream
                        • +
                      • getUsage() +: oboe::AudioStreamBase +
                      • getXRunCount() : oboe::AudioStream
                        • @@ -122,18 +186,34 @@

                        - g -

                          - i -

                          +

                          - l -

                          + +

                          - o -

                          • onAudioReady() : oboe::AudioStreamCallback @@ -162,13 +242,41 @@

                            - o -

                            + + +

                            - p -

                            - r -

                            @@ -206,6 +314,9 @@

                            - s -

                            • setInputPreset() : oboe::AudioStreamBuilder
                              • +
                            • setNativeFormat() +: oboe::AudioStream +
                            • setPerformanceMode() : oboe::AudioStreamBuilder
                              • @@ -221,6 +332,12 @@

                              - s -

                              @@ -238,6 +355,13 @@

                              - u -

                              +

                              - v -

                              + +

                              - w -

                              • waitForStateChange() : oboe::AudioStream diff --git a/docs/reference/functions_vars.html b/docs/reference/functions_vars.html index b9b4d4cdb..b645d73e0 100644 --- a/docs/reference/functions_vars.html +++ b/docs/reference/functions_vars.html @@ -64,12 +64,75 @@
                                 
                                  +
                                • ChannelCount +: oboe::DefaultStreamValues +
                                  • +
                                • FramesPerBurst +: oboe::DefaultStreamValues +
                                • Major : oboe::Version
                                  • +
                                • mBufferCapacityInFrames +: oboe::AudioStreamBase +
                                  • +
                                • mBufferSizeInFrames +: oboe::AudioStreamBase +
                                  • +
                                • mChannelCount +: oboe::AudioStreamBase +
                                  • +
                                • mContentType +: oboe::AudioStreamBase +
                                  • +
                                • mDeviceId +: oboe::AudioStreamBase +
                                  • +
                                • mDirection +: oboe::AudioStreamBase +
                                  • +
                                • mFormat +: oboe::AudioStreamBase +
                                  • +
                                • mFramesPerBurst +: oboe::AudioStreamBase +
                                  • +
                                • mFramesPerCallback +: oboe::AudioStreamBase +
                                  • +
                                • mFramesRead +: oboe::AudioStream +
                                  • +
                                • mFramesWritten +: oboe::AudioStream +
                                • Minor : oboe::Version
                                  • +
                                • mInputPreset +: oboe::AudioStreamBase +
                                  • +
                                • mNativeFormat +: oboe::AudioStream +
                                  • +
                                • mPerformanceMode +: oboe::AudioStreamBase +
                                  • +
                                • mSampleRate +: oboe::AudioStreamBase +
                                  • +
                                • mSessionId +: oboe::AudioStreamBase +
                                  • +
                                • mSharingMode +: oboe::AudioStreamBase +
                                  • +
                                • mStreamCallback +: oboe::AudioStreamBase +
                                  • +
                                • mUsage +: oboe::AudioStreamBase +
                                • Number : oboe::Version
                                  • diff --git a/docs/reference/menudata.js b/docs/reference/menudata.js index 34bf64d33..b48842d22 100644 --- a/docs/reference/menudata.js +++ b/docs/reference/menudata.js @@ -26,8 +26,23 @@ var menudata={children:[ {text:"Namespaces",url:"namespaces.html",children:[ {text:"Namespace List",url:"namespaces.html"}, {text:"Namespace Members",url:"namespacemembers.html",children:[ -{text:"All",url:"namespacemembers.html"}, +{text:"All",url:"namespacemembers.html",children:[ +{text:"a",url:"namespacemembers.html#index_a"}, +{text:"c",url:"namespacemembers.html#index_c"}, +{text:"d",url:"namespacemembers.html#index_d"}, +{text:"g",url:"namespacemembers.html#index_g"}, +{text:"i",url:"namespacemembers.html#index_i"}, +{text:"k",url:"namespacemembers.html#index_k"}, +{text:"m",url:"namespacemembers.html#index_m"}, +{text:"n",url:"namespacemembers.html#index_n"}, +{text:"o",url:"namespacemembers.html#index_o"}, +{text:"p",url:"namespacemembers.html#index_p"}, +{text:"r",url:"namespacemembers.html#index_r"}, +{text:"s",url:"namespacemembers.html#index_s"}, +{text:"u",url:"namespacemembers.html#index_u"}, +{text:"v",url:"namespacemembers.html#index_v"}]}, {text:"Functions",url:"namespacemembers_func.html"}, +{text:"Variables",url:"namespacemembers_vars.html"}, {text:"Enumerations",url:"namespacemembers_enum.html"}, {text:"Enumerator",url:"namespacemembers_eval.html"}]}]}, {text:"Classes",url:"annotated.html",children:[ @@ -36,9 +51,13 @@ var menudata={children:[ {text:"Class Hierarchy",url:"hierarchy.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, {text:"c",url:"functions.html#index_c"}, +{text:"e",url:"functions.html#index_e"}, +{text:"f",url:"functions.html#index_f"}, {text:"g",url:"functions.html#index_g"}, {text:"i",url:"functions.html#index_i"}, +{text:"l",url:"functions.html#index_l"}, {text:"m",url:"functions.html#index_m"}, {text:"n",url:"functions.html#index_n"}, {text:"o",url:"functions.html#index_o"}, @@ -47,16 +66,23 @@ var menudata={children:[ {text:"s",url:"functions.html#index_s"}, {text:"t",url:"functions.html#index_t"}, {text:"u",url:"functions.html#index_u"}, +{text:"v",url:"functions.html#index_v"}, {text:"w",url:"functions.html#index_w"}]}, {text:"Functions",url:"functions_func.html",children:[ +{text:"a",url:"functions_func.html#index_a"}, {text:"c",url:"functions_func.html#index_c"}, +{text:"e",url:"functions_func.html#index_e"}, +{text:"f",url:"functions_func.html#index_f"}, {text:"g",url:"functions_func.html#index_g"}, {text:"i",url:"functions_func.html#index_i"}, +{text:"l",url:"functions_func.html#index_l"}, {text:"o",url:"functions_func.html#index_o"}, +{text:"p",url:"functions_func.html#index_p"}, {text:"r",url:"functions_func.html#index_r"}, {text:"s",url:"functions_func.html#index_s"}, {text:"t",url:"functions_func.html#index_t"}, {text:"u",url:"functions_func.html#index_u"}, +{text:"v",url:"functions_func.html#index_v"}, {text:"w",url:"functions_func.html#index_w"}]}, {text:"Variables",url:"functions_vars.html"}]}]}, {text:"Files",url:"files.html",children:[ diff --git a/docs/reference/namespacemembers.html b/docs/reference/namespacemembers.html index 353f4f7d0..1ae075f24 100644 --- a/docs/reference/namespacemembers.html +++ b/docs/reference/namespacemembers.html @@ -63,13 +63,22 @@
                                -
                                Here is a list of all documented namespace members with links to the namespaces they belong to:
                                  +
                                  Here is a list of all documented namespace members with links to the namespaces they belong to:
                                  + +

                                  - a -

                                  + + +

                                  - c -

                                  • Camcorder : oboe
                                    • @@ -79,21 +88,71 @@
                                  • ContentType : oboe
                                    • +
                                  • convertFloatToPcm16() +: oboe +
                                  • convertFormatToSizeInBytes() : oboe
                                    • +
                                  • convertPcm16ToFloat() +: oboe +
                                  • convertToText() -: oboe +: oboe
                                    • +
                                  + + +

                                  - d -

                                    +
                                  • DataCallbackResult +: oboe +
                                    • +
                                  • Direction +: oboe +
                                    • +
                                  + + +

                                  - g -

                                  • Generic : oboe
                                  • getSdkVersion() : oboe
                                    • +
                                  + + +

                                  - i -

                                  • InputPreset : oboe
                                    • +
                                  + + +

                                  - k -

                                    +
                                  • kDefaultTimeoutNanos +: oboe +
                                    • +
                                  • kMillisPerSecond +: oboe +
                                    • +
                                  • kNanosPerMicrosecond +: oboe +
                                    • +
                                  • kNanosPerMillisecond +: oboe +
                                    • +
                                  • kNanosPerSecond +: oboe +
                                    • +
                                  • kUnspecified +: oboe +
                                    • +
                                  + + +

                                  - m -

                                  • Mono : oboe
                                    • @@ -103,9 +162,38 @@
                                  • Music : oboe
                                    • +
                                  + + +

                                  - n -

                                  + + +

                                  - o -

                                    +
                                  • operator<<() +: oboe +
                                    • +
                                  + + +

                                  - p -

                                    +
                                  • PerformanceMode +: oboe +
                                    • +
                                  + + +

                                  - r -

                                    +
                                  • Result +: oboe +
                                    • +
                                  + + +

                                  - s -

                                  • SessionId : oboe
                                    • @@ -121,6 +209,13 @@
                                  • Stereo : oboe
                                    • +
                                  • StreamState +: oboe +
                                    • +
                                  + + +

                                  - u -

                                  • Unprocessed : oboe
                                    • @@ -130,6 +225,10 @@
                                  • Usage : oboe
                                    • +
                                  + + +

                                  - v -

                                  • VoiceCommunication : oboe
                                    • diff --git a/docs/reference/namespacemembers_enum.html b/docs/reference/namespacemembers_enum.html index dd36c3339..5619d13d4 100644 --- a/docs/reference/namespacemembers_enum.html +++ b/docs/reference/namespacemembers_enum.html @@ -67,21 +67,39 @@
                                  • AudioApi : oboe
                                    • +
                                  • AudioFormat +: oboe +
                                  • ChannelCount : oboe
                                  • ContentType : oboe
                                    • +
                                  • DataCallbackResult +: oboe +
                                    • +
                                  • Direction +: oboe +
                                  • InputPreset : oboe
                                    • +
                                  • PerformanceMode +: oboe +
                                    • +
                                  • Result +: oboe +
                                  • SessionId : oboe
                                  • SharingMode : oboe
                                    • +
                                  • StreamState +: oboe +
                                  • Usage : oboe
                                    • diff --git a/docs/reference/namespacemembers_func.html b/docs/reference/namespacemembers_func.html index aeae4ef20..5d51ba8fd 100644 --- a/docs/reference/namespacemembers_func.html +++ b/docs/reference/namespacemembers_func.html @@ -64,15 +64,24 @@
                                     
                                      +
                                    • convertFloatToPcm16() +: oboe +
                                    • convertFormatToSizeInBytes() : oboe
                                      • +
                                    • convertPcm16ToFloat() +: oboe +
                                    • convertToText() -: oboe +: oboe
                                    • getSdkVersion() : oboe
                                      • +
                                    • operator<<() +: oboe +
                                    diff --git a/docs/reference/namespacemembers_vars.html b/docs/reference/namespacemembers_vars.html new file mode 100644 index 000000000..0c0047787 --- /dev/null +++ b/docs/reference/namespacemembers_vars.html @@ -0,0 +1,94 @@ + + + + + + + +Oboe: Namespace Members + + + + + + + + + +
                                    +
                                    + + + + + + +
                                    +
                                    Oboe +  1.0 +
                                    +
                                    Audio library for Android
                                    +
                                    +
                                    + + + + + + + +
                                    + +
                                    +
                                    + + +
                                    + +
                                    + +
                                    + 
                                      +
                                    • kDefaultTimeoutNanos +: oboe +
                                      • +
                                    • kMillisPerSecond +: oboe +
                                      • +
                                    • kNanosPerMicrosecond +: oboe +
                                      • +
                                    • kNanosPerMillisecond +: oboe +
                                      • +
                                    • kNanosPerSecond +: oboe +
                                      • +
                                    • kUnspecified +: oboe +
                                      • +
                                    +
                                    + +
                                    +Generated by   +doxygen + 1.8.14 +
                                    + + diff --git a/docs/reference/namespaceoboe.html b/docs/reference/namespaceoboe.html deleted file mode 100644 index 6ea1eed38..000000000 --- a/docs/reference/namespaceoboe.html +++ /dev/null @@ -1,572 +0,0 @@ - - - - - - - -Oboe: oboe Namespace Reference - - - - - - - - - -
                                    -
                                    - - - - - - -
                                    -
                                    Oboe -  1.0 -
                                    -
                                    Audio library for Android
                                    -
                                    -
                                    - - - - - - - - -
                                    -
                                    - - -
                                    - -
                                    - -
                                    -
                                    -
                                    -Classes | -Enumerations | -Functions | -Variables
                                    -
                                    -
                                    oboe Namespace Reference
                                    -
                                    -
                                    - - - - - - - - - - - - - - - - - - -

                                    -Classes

                                    class  AudioStream
                                     
                                    class  AudioStreamBase
                                     
                                    class  AudioStreamBuilder
                                     
                                    class  AudioStreamCallback
                                     
                                    class  DefaultStreamValues
                                     
                                    class  LatencyTuner
                                     
                                    class  ResultWithValue
                                     
                                    struct  Version
                                     
                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                    -Enumerations

                                    enum  StreamState : aaudio_stream_state_t {
                                    -  Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED, -Unknown = AAUDIO_STREAM_STATE_UNKNOWN, -Open = AAUDIO_STREAM_STATE_OPEN, -Starting = AAUDIO_STREAM_STATE_STARTING, -
                                    -  Started = AAUDIO_STREAM_STATE_STARTED, -Pausing = AAUDIO_STREAM_STATE_PAUSING, -Paused = AAUDIO_STREAM_STATE_PAUSED, -Flushing = AAUDIO_STREAM_STATE_FLUSHING, -
                                    -  Flushed = AAUDIO_STREAM_STATE_FLUSHED, -Stopping = AAUDIO_STREAM_STATE_STOPPING, -Stopped = AAUDIO_STREAM_STATE_STOPPED, -Closing = AAUDIO_STREAM_STATE_CLOSING, -
                                    -  Closed = AAUDIO_STREAM_STATE_CLOSED, -Disconnected = AAUDIO_STREAM_STATE_DISCONNECTED -
                                    - }
                                     
                                    enum  Direction : aaudio_direction_t { Output = AAUDIO_DIRECTION_OUTPUT, -Input = AAUDIO_DIRECTION_INPUT - }
                                     
                                    enum  AudioFormat : aaudio_format_t { Invalid = AAUDIO_FORMAT_INVALID, -Unspecified = AAUDIO_FORMAT_UNSPECIFIED, -I16 = AAUDIO_FORMAT_PCM_I16, -Float = AAUDIO_FORMAT_PCM_FLOAT - }
                                     
                                    enum  DataCallbackResult : aaudio_data_callback_result_t { Continue = AAUDIO_CALLBACK_RESULT_CONTINUE, -Stop = AAUDIO_CALLBACK_RESULT_STOP - }
                                     
                                    enum  Result : aaudio_result_t {
                                    -  OK, -ErrorBase = AAUDIO_ERROR_BASE, -ErrorDisconnected = AAUDIO_ERROR_DISCONNECTED, -ErrorIllegalArgument = AAUDIO_ERROR_ILLEGAL_ARGUMENT, -
                                    -  ErrorInternal = AAUDIO_ERROR_INTERNAL, -ErrorInvalidState = AAUDIO_ERROR_INVALID_STATE, -ErrorInvalidHandle = AAUDIO_ERROR_INVALID_HANDLE, -ErrorUnimplemented = AAUDIO_ERROR_UNIMPLEMENTED, -
                                    -  ErrorUnavailable = AAUDIO_ERROR_UNAVAILABLE, -ErrorNoFreeHandles = AAUDIO_ERROR_NO_FREE_HANDLES, -ErrorNoMemory = AAUDIO_ERROR_NO_MEMORY, -ErrorNull = AAUDIO_ERROR_NULL, -
                                    -  ErrorTimeout = AAUDIO_ERROR_TIMEOUT, -ErrorWouldBlock = AAUDIO_ERROR_WOULD_BLOCK, -ErrorInvalidFormat = AAUDIO_ERROR_INVALID_FORMAT, -ErrorOutOfRange = AAUDIO_ERROR_OUT_OF_RANGE, -
                                    -  ErrorNoService = AAUDIO_ERROR_NO_SERVICE, -ErrorInvalidRate = AAUDIO_ERROR_INVALID_RATE, -Reserved1, -Reserved2, -
                                    -  Reserved3, -Reserved4, -Reserved5, -Reserved6, -
                                    -  Reserved7, -Reserved8, -Reserved9, -Reserved10, -
                                    -  ErrorClosed -
                                    - }
                                     
                                    enum  SharingMode : aaudio_sharing_mode_t { SharingMode::Exclusive = AAUDIO_SHARING_MODE_EXCLUSIVE, -SharingMode::Shared = AAUDIO_SHARING_MODE_SHARED - }
                                     
                                    enum  PerformanceMode : aaudio_performance_mode_t { None = AAUDIO_PERFORMANCE_MODE_NONE, -PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING, -LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY - }
                                     
                                    enum  AudioApi : int32_t { Unspecified = kUnspecified, -AudioApi::OpenSLES, -AudioApi::AAudio - }
                                     
                                    enum  Usage : aaudio_usage_t {
                                    -  Usage::Media = CONSTANT_API_P(1, AAUDIO_USAGE_MEDIA), -VoiceCommunication = CONSTANT_API_P(2, AAUDIO_USAGE_VOICE_COMMUNICATION), -Usage::VoiceCommunicationSignalling, -Usage::Alarm = CONSTANT_API_P(4, AAUDIO_USAGE_ALARM), -
                                    -  Usage::Notification = CONSTANT_API_P(5, AAUDIO_USAGE_NOTIFICATION), -Usage::NotificationRingtone = CONSTANT_API_P(6, AAUDIO_USAGE_NOTIFICATION_RINGTONE), -Usage::NotificationEvent = CONSTANT_API_P(10, AAUDIO_USAGE_NOTIFICATION_EVENT), -Usage::AssistanceAccessibility = CONSTANT_API_P(11, AAUDIO_USAGE_ASSISTANCE_ACCESSIBILITY), -
                                    -  Usage::AssistanceNavigationGuidance, -Usage::AssistanceSonification = CONSTANT_API_P(13, AAUDIO_USAGE_ASSISTANCE_SONIFICATION), -Usage::Game = CONSTANT_API_P(14, AAUDIO_USAGE_GAME), -Usage::Assistant = CONSTANT_API_P(16, AAUDIO_USAGE_ASSISTANT) -
                                    - }
                                     
                                    enum  ContentType : aaudio_content_type_t { Speech = CONSTANT_API_P(1, AAUDIO_CONTENT_TYPE_SPEECH), -Music = CONSTANT_API_P(2, AAUDIO_CONTENT_TYPE_MUSIC), -Movie = CONSTANT_API_P(3, AAUDIO_CONTENT_TYPE_MOVIE), -Sonification = CONSTANT_API_P(4, AAUDIO_CONTENT_TYPE_SONIFICATION) - }
                                     
                                    enum  InputPreset : aaudio_input_preset_t {
                                    -  Generic = CONSTANT_API_P(1, AAUDIO_INPUT_PRESET_GENERIC), -Camcorder = CONSTANT_API_P(5, AAUDIO_INPUT_PRESET_CAMCORDER), -VoiceRecognition = CONSTANT_API_P(6, AAUDIO_INPUT_PRESET_VOICE_RECOGNITION), -VoiceCommunication = CONSTANT_API_P(7, AAUDIO_INPUT_PRESET_VOICE_COMMUNICATION), -
                                    -  VoiceCommunication = CONSTANT_API_P(2, AAUDIO_USAGE_VOICE_COMMUNICATION), -Unprocessed = CONSTANT_API_P(9, AAUDIO_INPUT_PRESET_UNPROCESSED) -
                                    - }
                                     
                                    enum  SessionId { None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE), -None = AAUDIO_PERFORMANCE_MODE_NONE, -Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE) - }
                                     
                                    enum  ChannelCount : int32_t {
                                    -  Unspecified = kUnspecified, -Unspecified = AAUDIO_FORMAT_UNSPECIFIED, -Unspecified = kUnspecified, -Mono = 1, -
                                    -  Stereo = 2 -
                                    - }
                                     
                                    - - - - - - - - - - - - - - - -

                                    -Functions

                                    -template<typename T >
                                    std::ostream & operator<< (std::ostream &strm, const ResultWithValue< T > &result)
                                     
                                    -void convertFloatToPcm16 (const float *source, int16_t *destination, int32_t numSamples)
                                     
                                    -void convertPcm16ToFloat (const int16_t *source, float *destination, int32_t numSamples)
                                     
                                    int32_t convertFormatToSizeInBytes (AudioFormat format)
                                     
                                    template<typename FromType >
                                    const char * convertToText (FromType)
                                     
                                    int getSdkVersion ()
                                     
                                    - - - - - - - - - - - - - -

                                    -Variables

                                    -constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond)
                                     
                                    -constexpr int32_t kUnspecified = 0
                                     
                                    -constexpr int64_t kNanosPerMicrosecond = 1000
                                     
                                    -constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000
                                     
                                    -constexpr int64_t kMillisPerSecond = 1000
                                     
                                    -constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond
                                     
                                    -

                                    Detailed Description

                                    -

                                    WARNING - UNDER CONSTRUCTION - THIS API WILL CHANGE.

                                    -

                                    Enumeration Type Documentation

                                    - -

                                    ◆ AudioApi

                                    - -
                                    -
                                    - - - - - -
                                    - - - - -
                                    enum oboe::AudioApi : int32_t
                                    -                                     		-strong
                                    -
                                    - - - - -
                                    Enumerator
                                    Unspecified 

                                    Try to use AAudio. If not available then use OpenSL ES.

                                    -
                                    OpenSLES 

                                    Use OpenSL ES.

                                    -
                                    AAudio 

                                    Try to use AAudio. Fail if unavailable.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ ChannelCount

                                    - -
                                    -
                                    - - - - -
                                    enum oboe::ChannelCount : int32_t
                                    -
                                    - - - - - -
                                    Enumerator
                                    Unspecified 

                                    Audio channel count definition, use Mono or Stereo

                                    -
                                    Unspecified 

                                    Try to use AAudio. If not available then use OpenSL ES.

                                    -
                                    Mono 

                                    Use this for mono audio

                                    -
                                    Stereo 

                                    Use this for stereo audio.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ ContentType

                                    - -
                                    -
                                    - - - - -
                                    enum oboe::ContentType : aaudio_content_type_t
                                    -
                                    -

                                    The CONTENT_TYPE attribute describes "what" you are playing. It expresses the general category of the content. This information is optional. But in case it is known (for instance AAUDIO_CONTENT_TYPE_MOVIE for a movie streaming service or AAUDIO_CONTENT_TYPE_SPEECH for an audio book application) this information might be used by the audio framework to enforce audio focus.

                                    -

                                    Note that these match the equivalent values in AudioAttributes in the Android Java API.

                                    -

                                    Added in API level 28.

                                    - - - - - -
                                    Enumerator
                                    Speech 

                                    Use this for spoken voice, audio books, etcetera.

                                    -
                                    Music 

                                    Use this for pre-recorded or live music.

                                    -
                                    Movie 

                                    Use this for a movie or video soundtrack.

                                    -
                                    Sonification 

                                    Use this for sound is designed to accompany a user action, such as a click or beep sound made when the user presses a button.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ InputPreset

                                    - -
                                    -
                                    - - - - -
                                    enum oboe::InputPreset : aaudio_input_preset_t
                                    -
                                    -

                                    Defines the audio source. An audio source defines both a default physical source of audio signal, and a recording configuration.

                                    -

                                    Note that these match the equivalent values in MediaRecorder.AudioSource in the Android Java API.

                                    -

                                    Added in API level 28.

                                    - - - - - - - -
                                    Enumerator
                                    Generic 

                                    Use this preset when other presets do not apply.

                                    -
                                    Camcorder 

                                    Use this preset when recording video.

                                    -
                                    VoiceRecognition 

                                    Use this preset when doing speech recognition.

                                    -
                                    VoiceCommunication 

                                    Use this preset when doing telephony or voice messaging.

                                    -
                                    VoiceCommunication 

                                    Use this for voice over IP, telephony, etcetera.

                                    -
                                    Unprocessed 

                                    Use this preset to obtain an input with no effects. Note that this input will not have automatic gain control so the recorded volume may be very low.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ SessionId

                                    - -
                                    -
                                    - - - - -
                                    enum oboe::SessionId
                                    -
                                    - - - -
                                    Enumerator
                                    None 

                                    Do not allocate a session ID. Effects cannot be used with this stream. Default.

                                    -

                                    Added in API level 28.

                                    -
                                    Allocate 

                                    Allocate a session ID that can be used to attach and control effects using the Java AudioEffects API. Note that the use of this flag may result in higher latency.

                                    -

                                    Note that this matches the value of AudioManager.AUDIO_SESSION_ID_GENERATE.

                                    -

                                    Added in API level 28.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ SharingMode

                                    - -
                                    -
                                    - - - - - -
                                    - - - - -
                                    enum oboe::SharingMode : aaudio_sharing_mode_t
                                    -                                     		-strong
                                    -
                                    - - - -
                                    Enumerator
                                    Exclusive 

                                    This will be the only stream using a particular source or sink. This mode will provide the lowest possible latency. You should close EXCLUSIVE streams immediately when you are not using them.

                                    -
                                    Shared 

                                    Multiple applications will be mixed by the AAudio Server. This will have higher latency than the EXCLUSIVE mode.

                                    -
                                    - -
                                    -
                                    - -

                                    ◆ Usage

                                    - -
                                    -
                                    - - - - - -
                                    - - - - -
                                    enum oboe::Usage : aaudio_usage_t
                                    -                                     		-strong
                                    -
                                    -

                                    The Usage attribute expresses "why" you are playing a sound, what is this sound used for. This information is used by certain platforms or routing policies to make more refined volume or routing decisions.

                                    -

                                    Note that these match the equivalent values in AudioAttributes in the Android Java API.

                                    -

                                    Added in API level 28.

                                    - - - - - - - - - - - - - -
                                    Enumerator
                                    Media 

                                    Use this for streaming media, music performance, video, podcasts, etcetera.

                                    -
                                    VoiceCommunication 

                                    Use this for voice over IP, telephony, etcetera.

                                    -
                                    VoiceCommunicationSignalling 

                                    Use this for sounds associated with telephony such as busy tones, DTMF, etcetera.

                                    -
                                    Alarm 

                                    Use this to demand the users attention.

                                    -
                                    Notification 

                                    Use this for notifying the user when a message has arrived or some other background event has occured.

                                    -
                                    NotificationRingtone 

                                    Use this when the phone rings.

                                    -
                                    NotificationEvent 

                                    Use this to attract the users attention when, for example, the battery is low.

                                    -
                                    AssistanceAccessibility 

                                    Use this for screen readers, etcetera.

                                    -
                                    AssistanceNavigationGuidance 

                                    Use this for driving or navigation directions.

                                    -
                                    AssistanceSonification 

                                    Use this for user interface sounds, beeps, etcetera.

                                    -
                                    Game 

                                    Use this for game audio and sound effects.

                                    -
                                    Assistant 

                                    Use this for audio responses to user queries, audio instructions or help utterances.

                                    -
                                    - -
                                    -
                                    -

                                    Function Documentation

                                    - -

                                    ◆ convertFormatToSizeInBytes()

                                    - -
                                    -
                                    - - - - - - - - -
                                    int32_t oboe::convertFormatToSizeInBytes (AudioFormat format)
                                    -
                                    -
                                    Returns
                                    the size of a sample of the given format in bytes or OBOE_ERROR_ILLEGAL_ARGUMENT
                                    - -
                                    -
                                    - -

                                    ◆ convertToText()

                                    - -
                                    -
                                    -
                                    -template<typename FromType >
                                    - - - - - - - - -
                                    const char* oboe::convertToText (FromType )
                                    -
                                    -

                                    The text is the ASCII symbol corresponding to the supplied Oboe enum value, or an English message saying the value is unrecognized. This is intended for developers to use when debugging. It is not for displaying to users.

                                    -
                                    Parameters
                                    - - -
                                    enumvalue
                                    -
                                    -
                                    -
                                    See also
                                    common/Utilities.cpp for concrete implementations
                                    -
                                    Returns
                                    text representation of an Oboe enum value.
                                    - -
                                    -
                                    - -

                                    ◆ getSdkVersion()

                                    - -
                                    -
                                    - - - - - - - -
                                    int oboe::getSdkVersion ()
                                    -
                                    -

                                    Return the version of the SDK that is currently running.

                                    -

                                    For example, on Android, this would return 27 for Oreo 8.1. If the version number cannot be determined then this will return -1.

                                    -
                                    Returns
                                    version number or -1
                                    - -
                                    -
                                    -
                                    - -
                                    -Generated by   -doxygen - 1.8.14 -
                                    - - diff --git a/docs/reference/pages.html b/docs/reference/pages.html new file mode 100644 index 000000000..0e0f087d1 --- /dev/null +++ b/docs/reference/pages.html @@ -0,0 +1,83 @@ + + + + + + + +Oboe: Related Pages + + + + + + + + + +
                                    +
                                    + + + + + + +
                                    +
                                    Oboe +  1.0 +
                                    +
                                    Audio library for Android
                                    +
                                    +
                                    + + + + + + + +
                                    + +
                                    +
                                    + + +
                                    + +
                                    + +
                                    +
                                    +
                                    Related Pages
                                    +
                                    +
                                    +
                                    Here is a list of all related documentation pages:
                                    + + +
                                     Deprecated List
                                    +
                                    +
                                    + +
                                    +Generated by   +doxygen + 1.8.14 +
                                    + + diff --git a/docs/reference/search/all_0.js b/docs/reference/search/all_0.js index bba1bfd0a..766494a37 100644 --- a/docs/reference/search/all_0.js +++ b/docs/reference/search/all_0.js @@ -8,8 +8,9 @@ var searchData= ['assistancesonification',['AssistanceSonification',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba1ce57a0572748beebfc0c664ca1077e7',1,'oboe']]], ['assistant',['Assistant',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba9b1363da9503dbd4142c0274a88e8d4b',1,'oboe']]], ['audioapi',['AudioApi',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6',1,'oboe']]], - ['audiostream',['AudioStream',['../a00036.html',1,'oboe']]], - ['audiostreambase',['AudioStreamBase',['../a00040.html',1,'oboe']]], + ['audioformat',['AudioFormat',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9',1,'oboe']]], + ['audiostream',['AudioStream',['../a00036.html',1,'oboe::AudioStream'],['../a00036.html#a8ebb587a07bf62c864fd62c63b241fd4',1,'oboe::AudioStream::AudioStream()']]], + ['audiostreambase',['AudioStreamBase',['../a00040.html',1,'oboe::AudioStreamBase'],['../a00040.html#aa6b103e1b0f808bbc4949d56f0829f98',1,'oboe::AudioStreamBase::AudioStreamBase()']]], ['audiostreambuilder',['AudioStreamBuilder',['../a00044.html',1,'oboe']]], ['audiostreamcallback',['AudioStreamCallback',['../a00048.html',1,'oboe']]] ]; diff --git a/docs/reference/search/all_1.js b/docs/reference/search/all_1.js index 6d06816b9..9982315ae 100644 --- a/docs/reference/search/all_1.js +++ b/docs/reference/search/all_1.js @@ -2,10 +2,12 @@ var searchData= [ ['calculatelatencymillis',['calculateLatencyMillis',['../a00036.html#ae023cb001f3261d064f423101798d6be',1,'oboe::AudioStream']]], ['camcorder',['Camcorder',['../a00032.html#a17f63a064de966efddd5d0335992bc04a6e8ef178769235d18b44fe2bb5ab33fe',1,'oboe']]], - ['channelcount',['ChannelCount',['../a00032.html#a522e6806948369987639a0d1df03c029',1,'oboe']]], + ['channelcount',['ChannelCount',['../a00052.html#ad5dce538d5963c81bf58350ab730962d',1,'oboe::DefaultStreamValues::ChannelCount()'],['../a00032.html#a522e6806948369987639a0d1df03c029',1,'oboe::ChannelCount()']]], ['close',['close',['../a00036.html#ad33a20f0d6792e322b9d8a2bcf14fcf8',1,'oboe::AudioStream']]], ['contenttype',['ContentType',['../a00032.html#a07eed38097ed944422063801f8f83406',1,'oboe']]], + ['convertfloattopcm16',['convertFloatToPcm16',['../a00032.html#adbda063116feb9fa98a31ee820170060',1,'oboe']]], ['convertformattosizeinbytes',['convertFormatToSizeInBytes',['../a00032.html#ac67383a3df0f6e7a51f8415ffd9fdaca',1,'oboe']]], - ['converttotext',['convertToText',['../a00032.html#a8d1ae211254cc239019f165b607f4365',1,'oboe']]], + ['convertpcm16tofloat',['convertPcm16ToFloat',['../a00032.html#ad17bee42828d13f2ef62a889e175c643',1,'oboe']]], + ['converttotext',['convertToText',['../a00032.html#af65aaea3c5d82eee6906664d61c094b3',1,'oboe']]], ['createbasedonsign',['createBasedOnSign',['../a00060.html#a2304c6120e2aad8f2189383a98c7b0a7',1,'oboe::ResultWithValue']]] ]; diff --git a/docs/reference/search/all_10.js b/docs/reference/search/all_10.js index 57aa014d2..2e1db42b3 100644 --- a/docs/reference/search/all_10.js +++ b/docs/reference/search/all_10.js @@ -1,6 +1,7 @@ var searchData= [ - ['waitforstatechange',['waitForStateChange',['../a00036.html#a0c865a5501f369d959c39d8ab8b46a07',1,'oboe::AudioStream']]], - ['waitforstatetransition',['waitForStateTransition',['../a00036.html#a8adbacd6a55a94a532916ab037fba1d6',1,'oboe::AudioStream']]], - ['write',['write',['../a00036.html#ab3f6bf8abed87f3804ac4df3472c3670',1,'oboe::AudioStream']]] + ['unprocessed',['Unprocessed',['../a00032.html#a17f63a064de966efddd5d0335992bc04acad9424158aefae0af7975901b11d85f',1,'oboe']]], + ['unspecified',['Unspecified',['../a00032.html#a522e6806948369987639a0d1df03c029a946257a568f77c12df4fc4c49125da76',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()']]], + ['usage',['Usage',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb',1,'oboe']]], + ['usesaaudio',['usesAAudio',['../a00036.html#a15cdaaaa4c1e8da322d6da33334c8147',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/all_11.html b/docs/reference/search/all_11.html new file mode 100644 index 000000000..b35c8bf0e --- /dev/null +++ b/docs/reference/search/all_11.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/all_11.js b/docs/reference/search/all_11.js new file mode 100644 index 000000000..e396fc3fe --- /dev/null +++ b/docs/reference/search/all_11.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['value',['value',['../a00060.html#a45f5c99a2c9f8fbaca502276f7ebb434',1,'oboe::ResultWithValue']]], + ['version',['Version',['../a00064.html',1,'oboe']]], + ['voicecommunication',['VoiceCommunication',['../a00032.html#a17f63a064de966efddd5d0335992bc04a1862e72c9730c448fbec6f61a5d8234d',1,'oboe::VoiceCommunication()'],['../a00032.html#a17f63a064de966efddd5d0335992bc04a5bad8854288c956062ec1d4d7c14fed6',1,'oboe::VoiceCommunication()']]], + ['voicecommunicationsignalling',['VoiceCommunicationSignalling',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba404f62633744bf4da0c6a27a2b78ce74',1,'oboe']]], + ['voicerecognition',['VoiceRecognition',['../a00032.html#a17f63a064de966efddd5d0335992bc04af6e440b4e9edf49afe18aa4be77be6fc',1,'oboe']]] +]; diff --git a/docs/reference/search/all_12.html b/docs/reference/search/all_12.html new file mode 100644 index 000000000..fd265245b --- /dev/null +++ b/docs/reference/search/all_12.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/all_12.js b/docs/reference/search/all_12.js new file mode 100644 index 000000000..57aa014d2 --- /dev/null +++ b/docs/reference/search/all_12.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['waitforstatechange',['waitForStateChange',['../a00036.html#a0c865a5501f369d959c39d8ab8b46a07',1,'oboe::AudioStream']]], + ['waitforstatetransition',['waitForStateTransition',['../a00036.html#a8adbacd6a55a94a532916ab037fba1d6',1,'oboe::AudioStream']]], + ['write',['write',['../a00036.html#ab3f6bf8abed87f3804ac4df3472c3670',1,'oboe::AudioStream']]] +]; diff --git a/docs/reference/search/all_2.js b/docs/reference/search/all_2.js index 2ade1f561..65acb7453 100644 --- a/docs/reference/search/all_2.js +++ b/docs/reference/search/all_2.js @@ -1,4 +1,6 @@ var searchData= [ - ['defaultstreamvalues',['DefaultStreamValues',['../a00052.html',1,'oboe']]] + ['datacallbackresult',['DataCallbackResult',['../a00032.html#a9cb0d39766aa6d50132a2daa6e826457',1,'oboe']]], + ['defaultstreamvalues',['DefaultStreamValues',['../a00052.html',1,'oboe']]], + ['direction',['Direction',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387b',1,'oboe']]] ]; diff --git a/docs/reference/search/all_3.js b/docs/reference/search/all_3.js index e11587d3e..32feb76b3 100644 --- a/docs/reference/search/all_3.js +++ b/docs/reference/search/all_3.js @@ -1,4 +1,5 @@ var searchData= [ + ['error',['error',['../a00060.html#adfc76ae6db81535c2e82b856975eed41',1,'oboe::ResultWithValue']]], ['exclusive',['Exclusive',['../a00032.html#ae3a52556c58387e0cecba01f9abffdffa2ef50b4c466304dc6ac77bac8a779971',1,'oboe']]] ]; diff --git a/docs/reference/search/all_4.js b/docs/reference/search/all_4.js index 8c241026e..149c04899 100644 --- a/docs/reference/search/all_4.js +++ b/docs/reference/search/all_4.js @@ -1,19 +1,7 @@ var searchData= [ - ['game',['Game',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba63d72051e901c069f8aa1b32aa0c43bb',1,'oboe']]], - ['generic',['Generic',['../a00032.html#a17f63a064de966efddd5d0335992bc04a0ba6f369e7f8a700c14afe2992290544',1,'oboe']]], - ['getaudioapi',['getAudioApi',['../a00036.html#a2b7a3cee7444114843dbdd1fc705f6bb',1,'oboe::AudioStream']]], - ['getbuffercapacityinframes',['getBufferCapacityInFrames',['../a00040.html#ab1531253e64aaebe9e9eddbafb9098fc',1,'oboe::AudioStreamBase']]], - ['getbuffersizeinframes',['getBufferSizeInFrames',['../a00040.html#af5217ab05bfde0d7637024b599302d0b',1,'oboe::AudioStreamBase']]], - ['getchannelcount',['getChannelCount',['../a00040.html#aa0b0a068097efaf967fb235c55383dd8',1,'oboe::AudioStreamBase']]], - ['getdirection',['getDirection',['../a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1',1,'oboe::AudioStreamBase']]], - ['getformat',['getFormat',['../a00040.html#ab1e640461d7bf9d596decb913da7ac86',1,'oboe::AudioStreamBase']]], - ['getframesperburst',['getFramesPerBurst',['../a00036.html#ac160acb656515814fa6fdd157c131a0a',1,'oboe::AudioStream']]], - ['getframespercallback',['getFramesPerCallback',['../a00040.html#a1c133e1949f0814f60bd8bb61346756b',1,'oboe::AudioStreamBase']]], - ['getframeswritten',['getFramesWritten',['../a00036.html#ab43dd4074e1de57bac1c3fd111430341',1,'oboe::AudioStream']]], - ['getsamplerate',['getSampleRate',['../a00040.html#ae9d32f3e09174bad69e74f147ee33087',1,'oboe::AudioStreamBase']]], - ['getsdkversion',['getSdkVersion',['../a00032.html#a54528938e9fccab7ad8947ccf0e409db',1,'oboe']]], - ['getstate',['getState',['../a00036.html#a47bb5798275f14d76444283a6b6f35eb',1,'oboe::AudioStream']]], - ['getunderlyingstream',['getUnderlyingStream',['../a00036.html#a5458d7130415eb4defe3dbc11d479e2f',1,'oboe::AudioStream']]], - ['getxruncount',['getXRunCount',['../a00036.html#ad1a1d3bbf3b348ed92b7ed18ce9cc261',1,'oboe::AudioStream']]] + ['firecallback',['fireCallback',['../a00036.html#a0c4fd19b01a4ef750dd9d6ae3a512eda',1,'oboe::AudioStream']]], + ['float',['Float',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9a22ae0e2b89e5e3d477f988cc36d3272b',1,'oboe']]], + ['flush',['flush',['../a00036.html#a32c25c0333eab3d65ce02275ad4acb3d',1,'oboe::AudioStream']]], + ['framesperburst',['FramesPerBurst',['../a00052.html#ab5ea5576699cebc56193f5c297d3e300',1,'oboe::DefaultStreamValues']]] ]; diff --git a/docs/reference/search/all_5.js b/docs/reference/search/all_5.js index 37682de71..6c381ed4f 100644 --- a/docs/reference/search/all_5.js +++ b/docs/reference/search/all_5.js @@ -1,7 +1,31 @@ var searchData= [ - ['inputpreset',['InputPreset',['../a00032.html#a17f63a064de966efddd5d0335992bc04',1,'oboe']]], - ['isaaudiorecommended',['isAAudioRecommended',['../a00044.html#a622732bbe5c6577356d749f7dc2108df',1,'oboe::AudioStreamBuilder']]], - ['isaaudiosupported',['isAAudioSupported',['../a00044.html#a18e7b5f7554a4c2ca763e35e8117d699',1,'oboe::AudioStreamBuilder']]], - ['isxruncountsupported',['isXRunCountSupported',['../a00036.html#a43d8a098440cde28f4ee8bedd6d107c4',1,'oboe::AudioStream']]] + ['game',['Game',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba63d72051e901c069f8aa1b32aa0c43bb',1,'oboe']]], + ['generic',['Generic',['../a00032.html#a17f63a064de966efddd5d0335992bc04a0ba6f369e7f8a700c14afe2992290544',1,'oboe']]], + ['getaudioapi',['getAudioApi',['../a00036.html#a2b7a3cee7444114843dbdd1fc705f6bb',1,'oboe::AudioStream::getAudioApi()'],['../a00044.html#ac9d41811c297fd28bc61833f640bb8d0',1,'oboe::AudioStreamBuilder::getAudioApi()']]], + ['getbuffercapacityinframes',['getBufferCapacityInFrames',['../a00040.html#ab1531253e64aaebe9e9eddbafb9098fc',1,'oboe::AudioStreamBase']]], + ['getbuffersizeinframes',['getBufferSizeInFrames',['../a00040.html#af5217ab05bfde0d7637024b599302d0b',1,'oboe::AudioStreamBase']]], + ['getbytesperframe',['getBytesPerFrame',['../a00036.html#a5c01907a59d5f89a5e4b819fe66b08bc',1,'oboe::AudioStream']]], + ['getbytespersample',['getBytesPerSample',['../a00036.html#a44dda61e6e948e49b68f87172f084d62',1,'oboe::AudioStream']]], + ['getcallback',['getCallback',['../a00040.html#a1b4a2a191546708da657510c3cd6b797',1,'oboe::AudioStreamBase']]], + ['getchannelcount',['getChannelCount',['../a00040.html#aa0b0a068097efaf967fb235c55383dd8',1,'oboe::AudioStreamBase']]], + ['getcontenttype',['getContentType',['../a00040.html#ab12e2d068fa87e0553b01a400d96eb82',1,'oboe::AudioStreamBase']]], + ['getdeviceid',['getDeviceId',['../a00040.html#a093057d625bc896864b959974c265f21',1,'oboe::AudioStreamBase']]], + ['getdirection',['getDirection',['../a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1',1,'oboe::AudioStreamBase']]], + ['getformat',['getFormat',['../a00040.html#ab1e640461d7bf9d596decb913da7ac86',1,'oboe::AudioStreamBase']]], + ['getframesperburst',['getFramesPerBurst',['../a00036.html#ac160acb656515814fa6fdd157c131a0a',1,'oboe::AudioStream']]], + ['getframespercallback',['getFramesPerCallback',['../a00040.html#a1c133e1949f0814f60bd8bb61346756b',1,'oboe::AudioStreamBase']]], + ['getframesread',['getFramesRead',['../a00036.html#aeebfc59abd978cd6dff07c16cfe266df',1,'oboe::AudioStream']]], + ['getframeswritten',['getFramesWritten',['../a00036.html#ab43dd4074e1de57bac1c3fd111430341',1,'oboe::AudioStream']]], + ['getinputpreset',['getInputPreset',['../a00040.html#a5c773b93b8aa38191c7199cab023428a',1,'oboe::AudioStreamBase']]], + ['getperformancemode',['getPerformanceMode',['../a00040.html#a2ddb935de0e24dd7ae8e2cfbecac9fdc',1,'oboe::AudioStreamBase']]], + ['getsamplerate',['getSampleRate',['../a00040.html#ae9d32f3e09174bad69e74f147ee33087',1,'oboe::AudioStreamBase']]], + ['getsdkversion',['getSdkVersion',['../a00032.html#a54528938e9fccab7ad8947ccf0e409db',1,'oboe']]], + ['getsessionid',['getSessionId',['../a00040.html#aa3c502ce09bbad7690a2dd6acaf8892e',1,'oboe::AudioStreamBase']]], + ['getsharingmode',['getSharingMode',['../a00040.html#a1fb033fc963f971bd1aa8f6707e49b41',1,'oboe::AudioStreamBase']]], + ['getstate',['getState',['../a00036.html#a47bb5798275f14d76444283a6b6f35eb',1,'oboe::AudioStream']]], + ['gettimestamp',['getTimestamp',['../a00036.html#a1d7cf4e43fb9d7b31857a90d9eceee6d',1,'oboe::AudioStream']]], + ['getunderlyingstream',['getUnderlyingStream',['../a00036.html#a5458d7130415eb4defe3dbc11d479e2f',1,'oboe::AudioStream']]], + ['getusage',['getUsage',['../a00040.html#a0bcfb2f8bd11c92b541fd910da9af397',1,'oboe::AudioStreamBase']]], + ['getxruncount',['getXRunCount',['../a00036.html#ad1a1d3bbf3b348ed92b7ed18ce9cc261',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/all_6.js b/docs/reference/search/all_6.js index 14dda9c6d..c5ee92235 100644 --- a/docs/reference/search/all_6.js +++ b/docs/reference/search/all_6.js @@ -1,4 +1,13 @@ var searchData= [ - ['latencytuner',['LatencyTuner',['../a00056.html',1,'oboe']]] + ['i16',['I16',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9abcd774f891b5f9df7099f3ea75dadf8d',1,'oboe']]], + ['incrementframesread',['incrementFramesRead',['../a00036.html#a81568482a217b314498e2501210758d7',1,'oboe::AudioStream']]], + ['incrementframeswritten',['incrementFramesWritten',['../a00036.html#ad6b4c63f6ed1ecb509f7b80352a9c0bd',1,'oboe::AudioStream']]], + ['input',['Input',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387ba324118a6721dd6b8a9b9f4e327df2bf5',1,'oboe']]], + ['inputpreset',['InputPreset',['../a00032.html#a17f63a064de966efddd5d0335992bc04',1,'oboe']]], + ['invalid',['Invalid',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9a4bbb8f967da6d1a610596d7257179c2b',1,'oboe']]], + ['isaaudiorecommended',['isAAudioRecommended',['../a00044.html#a622732bbe5c6577356d749f7dc2108df',1,'oboe::AudioStreamBuilder']]], + ['isaaudiosupported',['isAAudioSupported',['../a00044.html#a18e7b5f7554a4c2ca763e35e8117d699',1,'oboe::AudioStreamBuilder']]], + ['isplaying',['isPlaying',['../a00036.html#ad5260e2cc71108b1b2e694bf6162279f',1,'oboe::AudioStream']]], + ['isxruncountsupported',['isXRunCountSupported',['../a00036.html#a43d8a098440cde28f4ee8bedd6d107c4',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/all_7.js b/docs/reference/search/all_7.js index 040b1d17a..980d3280c 100644 --- a/docs/reference/search/all_7.js +++ b/docs/reference/search/all_7.js @@ -1,9 +1,9 @@ var searchData= [ - ['major',['Major',['../a00064.html#a270f2e92582d5187be339eeda8e2b276',1,'oboe::Version']]], - ['media',['Media',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74',1,'oboe']]], - ['minor',['Minor',['../a00064.html#ae460bb95e3a9099696205a35fffb5469',1,'oboe::Version']]], - ['mono',['Mono',['../a00032.html#a522e6806948369987639a0d1df03c029a8be103218645e121b51078620f452c79',1,'oboe']]], - ['movie',['Movie',['../a00032.html#a07eed38097ed944422063801f8f83406a8b3b366178c2b7b1688bca6cd33758b1',1,'oboe']]], - ['music',['Music',['../a00032.html#a07eed38097ed944422063801f8f83406ac156fcc7b29059305cef26f3904d4517',1,'oboe']]] + ['kdefaulttimeoutnanos',['kDefaultTimeoutNanos',['../a00032.html#aab8f5f081a8b2147e16ec920347c1b5c',1,'oboe']]], + ['kmillispersecond',['kMillisPerSecond',['../a00032.html#ad1bb9f5626cec20d3a052a8721959873',1,'oboe']]], + ['knanospermicrosecond',['kNanosPerMicrosecond',['../a00032.html#aedef0759ae3622b6f0324799bcbdebf0',1,'oboe']]], + ['knanospermillisecond',['kNanosPerMillisecond',['../a00032.html#a831e887150474c087170679eaca8672b',1,'oboe']]], + ['knanospersecond',['kNanosPerSecond',['../a00032.html#a5948466b593c4eab65f7025846a39f51',1,'oboe']]], + ['kunspecified',['kUnspecified',['../a00032.html#ab0772052200184e514082eaa89be7905',1,'oboe']]] ]; diff --git a/docs/reference/search/all_8.js b/docs/reference/search/all_8.js index daaac4ae0..435842f45 100644 --- a/docs/reference/search/all_8.js +++ b/docs/reference/search/all_8.js @@ -1,8 +1,5 @@ var searchData= [ - ['none',['None',['../a00032.html#a5752250c10e96179e3618d7f72937eafa58c518b26e83ea48393a76f6c9ecb51f',1,'oboe']]], - ['notification',['Notification',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba96d008db67fc0b5551a926842bbb6a71',1,'oboe']]], - ['notificationevent',['NotificationEvent',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba089240b5380dbd12f1eac0ec258a3b2f',1,'oboe']]], - ['notificationringtone',['NotificationRingtone',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba4e7a4b08274d472394b740a20d3bbdaf',1,'oboe']]], - ['number',['Number',['../a00064.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]] + ['latencytuner',['LatencyTuner',['../a00056.html',1,'oboe::LatencyTuner'],['../a00056.html#a0263b9a55825c0a403653b2b508073ea',1,'oboe::LatencyTuner::LatencyTuner()']]], + ['lowlatency',['LowLatency',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fdea611907b5ab1865515c35357efa41a9b9',1,'oboe']]] ]; diff --git a/docs/reference/search/all_9.js b/docs/reference/search/all_9.js index 56b6df09e..2b89aac9e 100644 --- a/docs/reference/search/all_9.js +++ b/docs/reference/search/all_9.js @@ -1,14 +1,28 @@ var searchData= [ - ['oboe',['oboe',['../a00032.html',1,'']]], - ['onaudioready',['onAudioReady',['../a00048.html#af3a7c44f0254abe6e5e5bb566e2317df',1,'oboe::AudioStreamCallback']]], - ['ondefaultcallback',['onDefaultCallback',['../a00036.html#abda7ae8e6832030572785de3964ed848',1,'oboe::AudioStream']]], - ['onerrorafterclose',['onErrorAfterClose',['../a00048.html#a7089c5e18a80cba89eb3f4fe2341aeba',1,'oboe::AudioStreamCallback']]], - ['onerrorbeforeclose',['onErrorBeforeClose',['../a00048.html#a2407ff537a60301fd161bd2c36913bfd',1,'oboe::AudioStreamCallback']]], - ['open',['open',['../a00036.html#a686c6ce8a29051c858fd1de386805dc6',1,'oboe::AudioStream']]], - ['opensles',['OpenSLES',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6a24e758ea9c1e842ef71cc8ff8b63fa9b',1,'oboe']]], - ['openstream',['openStream',['../a00044.html#a86b94cfa47729bef2e04dce1a9086074',1,'oboe::AudioStreamBuilder']]], - ['operator_20bool',['operator bool',['../a00060.html#ae32b1953b777af7d1d0c94862ca39986',1,'oboe::ResultWithValue']]], - ['operator_20result',['operator Result',['../a00060.html#af62107817c0bc76047e6b655a78504ba',1,'oboe::ResultWithValue']]], - ['operator_21',['operator!',['../a00060.html#a2dbc8b09ead8b073a78af95b4b0186e3',1,'oboe::ResultWithValue']]] + ['major',['Major',['../a00064.html#a270f2e92582d5187be339eeda8e2b276',1,'oboe::Version']]], + ['mbuffercapacityinframes',['mBufferCapacityInFrames',['../a00040.html#ac81d4719b350f8138aad1af38f0873b6',1,'oboe::AudioStreamBase']]], + ['mbuffersizeinframes',['mBufferSizeInFrames',['../a00040.html#a3b65595d26d1eae1b8ce9925a5b98f6a',1,'oboe::AudioStreamBase']]], + ['mchannelcount',['mChannelCount',['../a00040.html#a5ff460bac9d14dfeac4eeddfcbb6e206',1,'oboe::AudioStreamBase']]], + ['mcontenttype',['mContentType',['../a00040.html#a5f8f0e5add381b841856de80ea4cdb2b',1,'oboe::AudioStreamBase']]], + ['mdeviceid',['mDeviceId',['../a00040.html#a23dafa12fb1a6242b088ebd5a52798c8',1,'oboe::AudioStreamBase']]], + ['mdirection',['mDirection',['../a00040.html#a26e9294721561d3b16bcaeec5faf4880',1,'oboe::AudioStreamBase']]], + ['media',['Media',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74',1,'oboe']]], + ['mformat',['mFormat',['../a00040.html#a7869f04836c2c2bdc10c7309ad4b8e09',1,'oboe::AudioStreamBase']]], + ['mframesperburst',['mFramesPerBurst',['../a00040.html#a54061319ed348329a29d883a5de2482e',1,'oboe::AudioStreamBase']]], + ['mframespercallback',['mFramesPerCallback',['../a00040.html#a3962eb94420ad0ecea70029236001899',1,'oboe::AudioStreamBase']]], + ['mframesread',['mFramesRead',['../a00036.html#a2b9124ba3b0f564fa58b0651438250e7',1,'oboe::AudioStream']]], + ['mframeswritten',['mFramesWritten',['../a00036.html#aa88d2a712b91a8b763f2721d78480ba8',1,'oboe::AudioStream']]], + ['minor',['Minor',['../a00064.html#ae460bb95e3a9099696205a35fffb5469',1,'oboe::Version']]], + ['minputpreset',['mInputPreset',['../a00040.html#a1e5d4f5b30c4cc36f81ffd858cc00589',1,'oboe::AudioStreamBase']]], + ['mnativeformat',['mNativeFormat',['../a00036.html#a07ed6b5e5bd4bc276bc1e1fc08e51d60',1,'oboe::AudioStream']]], + ['mono',['Mono',['../a00032.html#a522e6806948369987639a0d1df03c029a8be103218645e121b51078620f452c79',1,'oboe']]], + ['movie',['Movie',['../a00032.html#a07eed38097ed944422063801f8f83406a8b3b366178c2b7b1688bca6cd33758b1',1,'oboe']]], + ['mperformancemode',['mPerformanceMode',['../a00040.html#ab99671c2d0552557e75dc7b4afe91765',1,'oboe::AudioStreamBase']]], + ['msamplerate',['mSampleRate',['../a00040.html#a998885bb6c4f37e145f4626ad4177dea',1,'oboe::AudioStreamBase']]], + ['msessionid',['mSessionId',['../a00040.html#abe1c1e9cada1ced9b5c1504ac9b07737',1,'oboe::AudioStreamBase']]], + ['msharingmode',['mSharingMode',['../a00040.html#ae9187492b679c97a0963e264954be473',1,'oboe::AudioStreamBase']]], + ['mstreamcallback',['mStreamCallback',['../a00040.html#ae3f72318212dd9977d7fa0ced92c91f4',1,'oboe::AudioStreamBase']]], + ['musage',['mUsage',['../a00040.html#a5b518e82f39c9fcbd7050fd66adb253c',1,'oboe::AudioStreamBase']]], + ['music',['Music',['../a00032.html#a07eed38097ed944422063801f8f83406ac156fcc7b29059305cef26f3904d4517',1,'oboe']]] ]; diff --git a/docs/reference/search/all_a.js b/docs/reference/search/all_a.js index 3e251a9a2..580452f79 100644 --- a/docs/reference/search/all_a.js +++ b/docs/reference/search/all_a.js @@ -1,4 +1,8 @@ var searchData= [ - ['patch',['Patch',['../a00064.html#a690110f2b3e887892da8f29ab5c057b2',1,'oboe::Version']]] + ['none',['None',['../a00032.html#a5752250c10e96179e3618d7f72937eafa58c518b26e83ea48393a76f6c9ecb51f',1,'oboe::None()'],['../a00032.html#a5752250c10e96179e3618d7f72937eafa6adf97f83acf6453d4a6a4b1070f3754',1,'oboe::None()']]], + ['notification',['Notification',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba96d008db67fc0b5551a926842bbb6a71',1,'oboe']]], + ['notificationevent',['NotificationEvent',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba089240b5380dbd12f1eac0ec258a3b2f',1,'oboe']]], + ['notificationringtone',['NotificationRingtone',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba4e7a4b08274d472394b740a20d3bbdaf',1,'oboe']]], + ['number',['Number',['../a00064.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]] ]; diff --git a/docs/reference/search/all_b.js b/docs/reference/search/all_b.js index 9997821ea..d9cc432ef 100644 --- a/docs/reference/search/all_b.js +++ b/docs/reference/search/all_b.js @@ -1,5 +1,17 @@ var searchData= [ - ['requestreset',['requestReset',['../a00056.html#a6c0142e08dc65eda8f758b4794450867',1,'oboe::LatencyTuner']]], - ['resultwithvalue',['ResultWithValue',['../a00060.html',1,'oboe']]] + ['oboe',['oboe',['../a00032.html',1,'']]], + ['onaudioready',['onAudioReady',['../a00048.html#af3a7c44f0254abe6e5e5bb566e2317df',1,'oboe::AudioStreamCallback']]], + ['ondefaultcallback',['onDefaultCallback',['../a00036.html#abda7ae8e6832030572785de3964ed848',1,'oboe::AudioStream']]], + ['onerrorafterclose',['onErrorAfterClose',['../a00048.html#a7089c5e18a80cba89eb3f4fe2341aeba',1,'oboe::AudioStreamCallback']]], + ['onerrorbeforeclose',['onErrorBeforeClose',['../a00048.html#a2407ff537a60301fd161bd2c36913bfd',1,'oboe::AudioStreamCallback']]], + ['open',['open',['../a00036.html#a686c6ce8a29051c858fd1de386805dc6',1,'oboe::AudioStream']]], + ['opensles',['OpenSLES',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6a24e758ea9c1e842ef71cc8ff8b63fa9b',1,'oboe']]], + ['openstream',['openStream',['../a00044.html#a86b94cfa47729bef2e04dce1a9086074',1,'oboe::AudioStreamBuilder']]], + ['operator_20bool',['operator bool',['../a00060.html#ae32b1953b777af7d1d0c94862ca39986',1,'oboe::ResultWithValue']]], + ['operator_20result',['operator Result',['../a00060.html#af62107817c0bc76047e6b655a78504ba',1,'oboe::ResultWithValue']]], + ['operator_21',['operator!',['../a00060.html#a2dbc8b09ead8b073a78af95b4b0186e3',1,'oboe::ResultWithValue']]], + ['operator_3c_3c',['operator<<',['../a00032.html#aa403103686222502d1cfc47bafc10aeb',1,'oboe']]], + ['operator_3d',['operator=',['../a00040.html#aa9c987a59555d7a60b9f7a63f4afc7fc',1,'oboe::AudioStreamBase']]], + ['output',['Output',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387ba29c2c02a361c9d7028472e5d92cd4a54',1,'oboe']]] ]; diff --git a/docs/reference/search/all_c.js b/docs/reference/search/all_c.js index ab09002a6..25016d7f2 100644 --- a/docs/reference/search/all_c.js +++ b/docs/reference/search/all_c.js @@ -1,26 +1,7 @@ var searchData= [ - ['samplerate',['SampleRate',['../a00052.html#a46a5d9a653f2153f618cadcab764e1b1',1,'oboe::DefaultStreamValues']]], - ['sessionid',['SessionId',['../a00032.html#a5752250c10e96179e3618d7f72937eaf',1,'oboe']]], - ['setaudioapi',['setAudioApi',['../a00044.html#a38c6d6c5e718df1e3ac69daaac47c391',1,'oboe::AudioStreamBuilder']]], - ['setbuffercapacityinframes',['setBufferCapacityInFrames',['../a00044.html#abaff480867af51ca0899bfa6fd7cc3ef',1,'oboe::AudioStreamBuilder']]], - ['setbuffersizeinframes',['setBufferSizeInFrames',['../a00036.html#ac93b18e18487e809151f63ec3c6228bb',1,'oboe::AudioStream']]], - ['setcallback',['setCallback',['../a00044.html#a698cefa9af73bc97c020c004821fccbd',1,'oboe::AudioStreamBuilder']]], - ['setchannelcount',['setChannelCount',['../a00044.html#a075d10291e1f998d90c2f73ef767b5a7',1,'oboe::AudioStreamBuilder']]], - ['setcontenttype',['setContentType',['../a00044.html#a6a17bafc217c2b624179fbbf77fe4468',1,'oboe::AudioStreamBuilder']]], - ['setdeviceid',['setDeviceId',['../a00044.html#af36ddcd00686a9e1de661bdac0685a8e',1,'oboe::AudioStreamBuilder']]], - ['setdirection',['setDirection',['../a00044.html#ab3fbd47b06197619c26393637e26354c',1,'oboe::AudioStreamBuilder']]], - ['setformat',['setFormat',['../a00044.html#aa2e1d2d73cd6c2eb9f349bf2fe5f6515',1,'oboe::AudioStreamBuilder']]], - ['setframespercallback',['setFramesPerCallback',['../a00044.html#a3f397821f61eabaeedaf31064c859a54',1,'oboe::AudioStreamBuilder']]], - ['setinputpreset',['setInputPreset',['../a00044.html#a144a3d095fd668210282f1a91f23e1f0',1,'oboe::AudioStreamBuilder']]], - ['setperformancemode',['setPerformanceMode',['../a00044.html#a6cd1d65612e844e59da71a68ea0ab3ee',1,'oboe::AudioStreamBuilder']]], - ['setsamplerate',['setSampleRate',['../a00044.html#a30ef3d5f51d56a9f980dc09600ed139d',1,'oboe::AudioStreamBuilder']]], - ['setsessionid',['setSessionId',['../a00044.html#a54c1651bdbe089d0d714af499e8a5f1d',1,'oboe::AudioStreamBuilder']]], - ['setsharingmode',['setSharingMode',['../a00044.html#a3e991742acbbfb6fe5ebcf592c478654',1,'oboe::AudioStreamBuilder']]], - ['setusage',['setUsage',['../a00044.html#a593255a2f5eb972665775cfc5bc58f6a',1,'oboe::AudioStreamBuilder']]], - ['shared',['Shared',['../a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca',1,'oboe']]], - ['sharingmode',['SharingMode',['../a00032.html#ae3a52556c58387e0cecba01f9abffdff',1,'oboe']]], - ['sonification',['Sonification',['../a00032.html#a07eed38097ed944422063801f8f83406a0885eef555037e94a7cf39fe683c2799',1,'oboe']]], - ['speech',['Speech',['../a00032.html#a07eed38097ed944422063801f8f83406a3dc48a4b4619aa4edd1da7b937b4dcd1',1,'oboe']]], - ['stereo',['Stereo',['../a00032.html#a522e6806948369987639a0d1df03c029a534e646333ca7568317b171ea96b89ba',1,'oboe']]] + ['patch',['Patch',['../a00064.html#a690110f2b3e887892da8f29ab5c057b2',1,'oboe::Version']]], + ['pause',['pause',['../a00036.html#a04f29836748a8e5842aef2be200022ad',1,'oboe::AudioStream']]], + ['performancemode',['PerformanceMode',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fde',1,'oboe']]], + ['powersaving',['PowerSaving',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fdeabbad080463ed11f9d77797c04aa1e5b1',1,'oboe']]] ]; diff --git a/docs/reference/search/all_d.js b/docs/reference/search/all_d.js index d703e14fb..f6db3d080 100644 --- a/docs/reference/search/all_d.js +++ b/docs/reference/search/all_d.js @@ -1,5 +1,11 @@ var searchData= [ - ['text',['Text',['../a00064.html#a2c86e578b827fbca5f40c460a7754503',1,'oboe::Version']]], - ['tune',['tune',['../a00056.html#ad2be756965e6a9af3114008eda892174',1,'oboe::LatencyTuner']]] + ['read',['read',['../a00036.html#acbf3933af829313d281b5455053338da',1,'oboe::AudioStream']]], + ['requestflush',['requestFlush',['../a00036.html#a6bd5d633ff999e4da1faf3cd949aa602',1,'oboe::AudioStream']]], + ['requestpause',['requestPause',['../a00036.html#a7f18bb3cc5490fd7fbc1f6da63c730f6',1,'oboe::AudioStream']]], + ['requestreset',['requestReset',['../a00056.html#a6c0142e08dc65eda8f758b4794450867',1,'oboe::LatencyTuner']]], + ['requeststart',['requestStart',['../a00036.html#a3c484e314dee8dfed1d419f487b5d601',1,'oboe::AudioStream']]], + ['requeststop',['requestStop',['../a00036.html#a820e634f741e6b5efdcef8104cecb919',1,'oboe::AudioStream']]], + ['result',['Result',['../a00032.html#a5e32586b07bf64da91f99fc33c043cb1',1,'oboe']]], + ['resultwithvalue',['ResultWithValue',['../a00060.html',1,'oboe::ResultWithValue< T >'],['../a00060.html#aae75caa0d16a9e23a012f77fb50c5927',1,'oboe::ResultWithValue::ResultWithValue(oboe::Result error)'],['../a00060.html#a600309367db58d71f0ec16e90f7ebea5',1,'oboe::ResultWithValue::ResultWithValue(T value)']]] ]; diff --git a/docs/reference/search/all_e.js b/docs/reference/search/all_e.js index 58219ff34..8d4ce7d9d 100644 --- a/docs/reference/search/all_e.js +++ b/docs/reference/search/all_e.js @@ -1,7 +1,30 @@ var searchData= [ - ['unprocessed',['Unprocessed',['../a00032.html#a17f63a064de966efddd5d0335992bc04acad9424158aefae0af7975901b11d85f',1,'oboe']]], - ['unspecified',['Unspecified',['../a00032.html#a522e6806948369987639a0d1df03c029a946257a568f77c12df4fc4c49125da76',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()']]], - ['usage',['Usage',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb',1,'oboe']]], - ['usesaaudio',['usesAAudio',['../a00036.html#a15cdaaaa4c1e8da322d6da33334c8147',1,'oboe::AudioStream']]] + ['samplerate',['SampleRate',['../a00052.html#a46a5d9a653f2153f618cadcab764e1b1',1,'oboe::DefaultStreamValues']]], + ['sessionid',['SessionId',['../a00032.html#a5752250c10e96179e3618d7f72937eaf',1,'oboe']]], + ['setaudioapi',['setAudioApi',['../a00044.html#a38c6d6c5e718df1e3ac69daaac47c391',1,'oboe::AudioStreamBuilder']]], + ['setbuffercapacityinframes',['setBufferCapacityInFrames',['../a00044.html#abaff480867af51ca0899bfa6fd7cc3ef',1,'oboe::AudioStreamBuilder']]], + ['setbuffersizeinframes',['setBufferSizeInFrames',['../a00036.html#ac93b18e18487e809151f63ec3c6228bb',1,'oboe::AudioStream']]], + ['setcallback',['setCallback',['../a00044.html#a698cefa9af73bc97c020c004821fccbd',1,'oboe::AudioStreamBuilder']]], + ['setchannelcount',['setChannelCount',['../a00044.html#a075d10291e1f998d90c2f73ef767b5a7',1,'oboe::AudioStreamBuilder']]], + ['setcontenttype',['setContentType',['../a00044.html#a6a17bafc217c2b624179fbbf77fe4468',1,'oboe::AudioStreamBuilder']]], + ['setdeviceid',['setDeviceId',['../a00044.html#af36ddcd00686a9e1de661bdac0685a8e',1,'oboe::AudioStreamBuilder']]], + ['setdirection',['setDirection',['../a00044.html#ab3fbd47b06197619c26393637e26354c',1,'oboe::AudioStreamBuilder']]], + ['setformat',['setFormat',['../a00044.html#aa2e1d2d73cd6c2eb9f349bf2fe5f6515',1,'oboe::AudioStreamBuilder']]], + ['setframespercallback',['setFramesPerCallback',['../a00044.html#a3f397821f61eabaeedaf31064c859a54',1,'oboe::AudioStreamBuilder']]], + ['setinputpreset',['setInputPreset',['../a00044.html#a144a3d095fd668210282f1a91f23e1f0',1,'oboe::AudioStreamBuilder']]], + ['setnativeformat',['setNativeFormat',['../a00036.html#ab01c37fca9110e916a482a909f5cc82d',1,'oboe::AudioStream']]], + ['setperformancemode',['setPerformanceMode',['../a00044.html#a6cd1d65612e844e59da71a68ea0ab3ee',1,'oboe::AudioStreamBuilder']]], + ['setsamplerate',['setSampleRate',['../a00044.html#a30ef3d5f51d56a9f980dc09600ed139d',1,'oboe::AudioStreamBuilder']]], + ['setsessionid',['setSessionId',['../a00044.html#a54c1651bdbe089d0d714af499e8a5f1d',1,'oboe::AudioStreamBuilder']]], + ['setsharingmode',['setSharingMode',['../a00044.html#a3e991742acbbfb6fe5ebcf592c478654',1,'oboe::AudioStreamBuilder']]], + ['setusage',['setUsage',['../a00044.html#a593255a2f5eb972665775cfc5bc58f6a',1,'oboe::AudioStreamBuilder']]], + ['shared',['Shared',['../a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca',1,'oboe']]], + ['sharingmode',['SharingMode',['../a00032.html#ae3a52556c58387e0cecba01f9abffdff',1,'oboe']]], + ['sonification',['Sonification',['../a00032.html#a07eed38097ed944422063801f8f83406a0885eef555037e94a7cf39fe683c2799',1,'oboe']]], + ['speech',['Speech',['../a00032.html#a07eed38097ed944422063801f8f83406a3dc48a4b4619aa4edd1da7b937b4dcd1',1,'oboe']]], + ['start',['start',['../a00036.html#af04f03eb6b64b564f1c4401688987d21',1,'oboe::AudioStream']]], + ['stereo',['Stereo',['../a00032.html#a522e6806948369987639a0d1df03c029a534e646333ca7568317b171ea96b89ba',1,'oboe']]], + ['stop',['stop',['../a00036.html#aec093859d42f0470c884edd1e976d9f3',1,'oboe::AudioStream']]], + ['streamstate',['StreamState',['../a00032.html#a7fd7bd0828b61e3b3097e33dc90ac123',1,'oboe']]] ]; diff --git a/docs/reference/search/all_f.js b/docs/reference/search/all_f.js index b372964ff..d703e14fb 100644 --- a/docs/reference/search/all_f.js +++ b/docs/reference/search/all_f.js @@ -1,7 +1,5 @@ var searchData= [ - ['version',['Version',['../a00064.html',1,'oboe']]], - ['voicecommunication',['VoiceCommunication',['../a00032.html#a17f63a064de966efddd5d0335992bc04a1862e72c9730c448fbec6f61a5d8234d',1,'oboe::VoiceCommunication()'],['../a00032.html#a17f63a064de966efddd5d0335992bc04a5bad8854288c956062ec1d4d7c14fed6',1,'oboe::VoiceCommunication()']]], - ['voicecommunicationsignalling',['VoiceCommunicationSignalling',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba404f62633744bf4da0c6a27a2b78ce74',1,'oboe']]], - ['voicerecognition',['VoiceRecognition',['../a00032.html#a17f63a064de966efddd5d0335992bc04af6e440b4e9edf49afe18aa4be77be6fc',1,'oboe']]] + ['text',['Text',['../a00064.html#a2c86e578b827fbca5f40c460a7754503',1,'oboe::Version']]], + ['tune',['tune',['../a00056.html#ad2be756965e6a9af3114008eda892174',1,'oboe::LatencyTuner']]] ]; diff --git a/docs/reference/search/enums_0.js b/docs/reference/search/enums_0.js index d10a8d42c..7c834337d 100644 --- a/docs/reference/search/enums_0.js +++ b/docs/reference/search/enums_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['audioapi',['AudioApi',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6',1,'oboe']]] + ['audioapi',['AudioApi',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6',1,'oboe']]], + ['audioformat',['AudioFormat',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9',1,'oboe']]] ]; diff --git a/docs/reference/search/enums_2.js b/docs/reference/search/enums_2.js index 7d4262f25..294a8c860 100644 --- a/docs/reference/search/enums_2.js +++ b/docs/reference/search/enums_2.js @@ -1,4 +1,5 @@ var searchData= [ - ['inputpreset',['InputPreset',['../a00032.html#a17f63a064de966efddd5d0335992bc04',1,'oboe']]] + ['datacallbackresult',['DataCallbackResult',['../a00032.html#a9cb0d39766aa6d50132a2daa6e826457',1,'oboe']]], + ['direction',['Direction',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387b',1,'oboe']]] ]; diff --git a/docs/reference/search/enums_3.js b/docs/reference/search/enums_3.js index 8f9379547..7d4262f25 100644 --- a/docs/reference/search/enums_3.js +++ b/docs/reference/search/enums_3.js @@ -1,5 +1,4 @@ var searchData= [ - ['sessionid',['SessionId',['../a00032.html#a5752250c10e96179e3618d7f72937eaf',1,'oboe']]], - ['sharingmode',['SharingMode',['../a00032.html#ae3a52556c58387e0cecba01f9abffdff',1,'oboe']]] + ['inputpreset',['InputPreset',['../a00032.html#a17f63a064de966efddd5d0335992bc04',1,'oboe']]] ]; diff --git a/docs/reference/search/enums_4.js b/docs/reference/search/enums_4.js index 69368898e..dc7790e31 100644 --- a/docs/reference/search/enums_4.js +++ b/docs/reference/search/enums_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['usage',['Usage',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb',1,'oboe']]] + ['performancemode',['PerformanceMode',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fde',1,'oboe']]] ]; diff --git a/docs/reference/search/enums_5.html b/docs/reference/search/enums_5.html new file mode 100644 index 000000000..3b8639573 --- /dev/null +++ b/docs/reference/search/enums_5.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enums_5.js b/docs/reference/search/enums_5.js new file mode 100644 index 000000000..9e6d03327 --- /dev/null +++ b/docs/reference/search/enums_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['result',['Result',['../a00032.html#a5e32586b07bf64da91f99fc33c043cb1',1,'oboe']]] +]; diff --git a/docs/reference/search/enums_6.html b/docs/reference/search/enums_6.html new file mode 100644 index 000000000..acd7a5424 --- /dev/null +++ b/docs/reference/search/enums_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enums_6.js b/docs/reference/search/enums_6.js new file mode 100644 index 000000000..ca162d2b4 --- /dev/null +++ b/docs/reference/search/enums_6.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['sessionid',['SessionId',['../a00032.html#a5752250c10e96179e3618d7f72937eaf',1,'oboe']]], + ['sharingmode',['SharingMode',['../a00032.html#ae3a52556c58387e0cecba01f9abffdff',1,'oboe']]], + ['streamstate',['StreamState',['../a00032.html#a7fd7bd0828b61e3b3097e33dc90ac123',1,'oboe']]] +]; diff --git a/docs/reference/search/enums_7.html b/docs/reference/search/enums_7.html new file mode 100644 index 000000000..ee24b455c --- /dev/null +++ b/docs/reference/search/enums_7.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enums_7.js b/docs/reference/search/enums_7.js new file mode 100644 index 000000000..69368898e --- /dev/null +++ b/docs/reference/search/enums_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['usage',['Usage',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb',1,'oboe']]] +]; diff --git a/docs/reference/search/enumvalues_3.js b/docs/reference/search/enumvalues_3.js index 3f872d7c6..d9a33bc34 100644 --- a/docs/reference/search/enumvalues_3.js +++ b/docs/reference/search/enumvalues_3.js @@ -1,5 +1,4 @@ var searchData= [ - ['game',['Game',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba63d72051e901c069f8aa1b32aa0c43bb',1,'oboe']]], - ['generic',['Generic',['../a00032.html#a17f63a064de966efddd5d0335992bc04a0ba6f369e7f8a700c14afe2992290544',1,'oboe']]] + ['float',['Float',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9a22ae0e2b89e5e3d477f988cc36d3272b',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_4.js b/docs/reference/search/enumvalues_4.js index 50ea809f2..3f872d7c6 100644 --- a/docs/reference/search/enumvalues_4.js +++ b/docs/reference/search/enumvalues_4.js @@ -1,7 +1,5 @@ var searchData= [ - ['media',['Media',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74',1,'oboe']]], - ['mono',['Mono',['../a00032.html#a522e6806948369987639a0d1df03c029a8be103218645e121b51078620f452c79',1,'oboe']]], - ['movie',['Movie',['../a00032.html#a07eed38097ed944422063801f8f83406a8b3b366178c2b7b1688bca6cd33758b1',1,'oboe']]], - ['music',['Music',['../a00032.html#a07eed38097ed944422063801f8f83406ac156fcc7b29059305cef26f3904d4517',1,'oboe']]] + ['game',['Game',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba63d72051e901c069f8aa1b32aa0c43bb',1,'oboe']]], + ['generic',['Generic',['../a00032.html#a17f63a064de966efddd5d0335992bc04a0ba6f369e7f8a700c14afe2992290544',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_5.js b/docs/reference/search/enumvalues_5.js index 30728ae16..9f70d07af 100644 --- a/docs/reference/search/enumvalues_5.js +++ b/docs/reference/search/enumvalues_5.js @@ -1,7 +1,6 @@ var searchData= [ - ['none',['None',['../a00032.html#a5752250c10e96179e3618d7f72937eafa58c518b26e83ea48393a76f6c9ecb51f',1,'oboe']]], - ['notification',['Notification',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba96d008db67fc0b5551a926842bbb6a71',1,'oboe']]], - ['notificationevent',['NotificationEvent',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba089240b5380dbd12f1eac0ec258a3b2f',1,'oboe']]], - ['notificationringtone',['NotificationRingtone',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba4e7a4b08274d472394b740a20d3bbdaf',1,'oboe']]] + ['i16',['I16',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9abcd774f891b5f9df7099f3ea75dadf8d',1,'oboe']]], + ['input',['Input',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387ba324118a6721dd6b8a9b9f4e327df2bf5',1,'oboe']]], + ['invalid',['Invalid',['../a00032.html#a58191d1a396041246bd4e0a87dbfdec9a4bbb8f967da6d1a610596d7257179c2b',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_6.js b/docs/reference/search/enumvalues_6.js index 9a1508f12..9c54de829 100644 --- a/docs/reference/search/enumvalues_6.js +++ b/docs/reference/search/enumvalues_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['opensles',['OpenSLES',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6a24e758ea9c1e842ef71cc8ff8b63fa9b',1,'oboe']]] + ['lowlatency',['LowLatency',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fdea611907b5ab1865515c35357efa41a9b9',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_7.js b/docs/reference/search/enumvalues_7.js index 04f3bc482..50ea809f2 100644 --- a/docs/reference/search/enumvalues_7.js +++ b/docs/reference/search/enumvalues_7.js @@ -1,7 +1,7 @@ var searchData= [ - ['shared',['Shared',['../a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca',1,'oboe']]], - ['sonification',['Sonification',['../a00032.html#a07eed38097ed944422063801f8f83406a0885eef555037e94a7cf39fe683c2799',1,'oboe']]], - ['speech',['Speech',['../a00032.html#a07eed38097ed944422063801f8f83406a3dc48a4b4619aa4edd1da7b937b4dcd1',1,'oboe']]], - ['stereo',['Stereo',['../a00032.html#a522e6806948369987639a0d1df03c029a534e646333ca7568317b171ea96b89ba',1,'oboe']]] + ['media',['Media',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74',1,'oboe']]], + ['mono',['Mono',['../a00032.html#a522e6806948369987639a0d1df03c029a8be103218645e121b51078620f452c79',1,'oboe']]], + ['movie',['Movie',['../a00032.html#a07eed38097ed944422063801f8f83406a8b3b366178c2b7b1688bca6cd33758b1',1,'oboe']]], + ['music',['Music',['../a00032.html#a07eed38097ed944422063801f8f83406ac156fcc7b29059305cef26f3904d4517',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_8.js b/docs/reference/search/enumvalues_8.js index c3b1d9fd1..d8758a77f 100644 --- a/docs/reference/search/enumvalues_8.js +++ b/docs/reference/search/enumvalues_8.js @@ -1,5 +1,7 @@ var searchData= [ - ['unprocessed',['Unprocessed',['../a00032.html#a17f63a064de966efddd5d0335992bc04acad9424158aefae0af7975901b11d85f',1,'oboe']]], - ['unspecified',['Unspecified',['../a00032.html#a522e6806948369987639a0d1df03c029a946257a568f77c12df4fc4c49125da76',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()']]] + ['none',['None',['../a00032.html#a5752250c10e96179e3618d7f72937eafa58c518b26e83ea48393a76f6c9ecb51f',1,'oboe::None()'],['../a00032.html#a5752250c10e96179e3618d7f72937eafa6adf97f83acf6453d4a6a4b1070f3754',1,'oboe::None()']]], + ['notification',['Notification',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba96d008db67fc0b5551a926842bbb6a71',1,'oboe']]], + ['notificationevent',['NotificationEvent',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba089240b5380dbd12f1eac0ec258a3b2f',1,'oboe']]], + ['notificationringtone',['NotificationRingtone',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba4e7a4b08274d472394b740a20d3bbdaf',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_9.js b/docs/reference/search/enumvalues_9.js index a62416c43..1f7b13692 100644 --- a/docs/reference/search/enumvalues_9.js +++ b/docs/reference/search/enumvalues_9.js @@ -1,6 +1,5 @@ var searchData= [ - ['voicecommunication',['VoiceCommunication',['../a00032.html#a17f63a064de966efddd5d0335992bc04a1862e72c9730c448fbec6f61a5d8234d',1,'oboe::VoiceCommunication()'],['../a00032.html#a17f63a064de966efddd5d0335992bc04a5bad8854288c956062ec1d4d7c14fed6',1,'oboe::VoiceCommunication()']]], - ['voicecommunicationsignalling',['VoiceCommunicationSignalling',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba404f62633744bf4da0c6a27a2b78ce74',1,'oboe']]], - ['voicerecognition',['VoiceRecognition',['../a00032.html#a17f63a064de966efddd5d0335992bc04af6e440b4e9edf49afe18aa4be77be6fc',1,'oboe']]] + ['opensles',['OpenSLES',['../a00032.html#a92972414867c81d5974cb2ed7abefbf6a24e758ea9c1e842ef71cc8ff8b63fa9b',1,'oboe']]], + ['output',['Output',['../a00032.html#aea1c5f88e3dd4144f51ed5a434fb387ba29c2c02a361c9d7028472e5d92cd4a54',1,'oboe']]] ]; diff --git a/docs/reference/search/enumvalues_a.html b/docs/reference/search/enumvalues_a.html new file mode 100644 index 000000000..1ec3a2a87 --- /dev/null +++ b/docs/reference/search/enumvalues_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enumvalues_a.js b/docs/reference/search/enumvalues_a.js new file mode 100644 index 000000000..f44abd967 --- /dev/null +++ b/docs/reference/search/enumvalues_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['powersaving',['PowerSaving',['../a00032.html#acd0e87a1512eca01c60eb3b7a6676fdeabbad080463ed11f9d77797c04aa1e5b1',1,'oboe']]] +]; diff --git a/docs/reference/search/enumvalues_b.html b/docs/reference/search/enumvalues_b.html new file mode 100644 index 000000000..bfc2bf3f4 --- /dev/null +++ b/docs/reference/search/enumvalues_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enumvalues_b.js b/docs/reference/search/enumvalues_b.js new file mode 100644 index 000000000..04f3bc482 --- /dev/null +++ b/docs/reference/search/enumvalues_b.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['shared',['Shared',['../a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca',1,'oboe']]], + ['sonification',['Sonification',['../a00032.html#a07eed38097ed944422063801f8f83406a0885eef555037e94a7cf39fe683c2799',1,'oboe']]], + ['speech',['Speech',['../a00032.html#a07eed38097ed944422063801f8f83406a3dc48a4b4619aa4edd1da7b937b4dcd1',1,'oboe']]], + ['stereo',['Stereo',['../a00032.html#a522e6806948369987639a0d1df03c029a534e646333ca7568317b171ea96b89ba',1,'oboe']]] +]; diff --git a/docs/reference/search/enumvalues_c.html b/docs/reference/search/enumvalues_c.html new file mode 100644 index 000000000..36070b87e --- /dev/null +++ b/docs/reference/search/enumvalues_c.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enumvalues_c.js b/docs/reference/search/enumvalues_c.js new file mode 100644 index 000000000..ac3b81fc1 --- /dev/null +++ b/docs/reference/search/enumvalues_c.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['unprocessed',['Unprocessed',['../a00032.html#a17f63a064de966efddd5d0335992bc04acad9424158aefae0af7975901b11d85f',1,'oboe']]], + ['unspecified',['Unspecified',['../a00032.html#a522e6806948369987639a0d1df03c029a946257a568f77c12df4fc4c49125da76',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()'],['../a00032.html#a522e6806948369987639a0d1df03c029a6fcdc090caeade09d0efd6253932b6f5',1,'oboe::Unspecified()']]] +]; diff --git a/docs/reference/search/enumvalues_d.html b/docs/reference/search/enumvalues_d.html new file mode 100644 index 000000000..e15d8c992 --- /dev/null +++ b/docs/reference/search/enumvalues_d.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/enumvalues_d.js b/docs/reference/search/enumvalues_d.js new file mode 100644 index 000000000..a62416c43 --- /dev/null +++ b/docs/reference/search/enumvalues_d.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['voicecommunication',['VoiceCommunication',['../a00032.html#a17f63a064de966efddd5d0335992bc04a1862e72c9730c448fbec6f61a5d8234d',1,'oboe::VoiceCommunication()'],['../a00032.html#a17f63a064de966efddd5d0335992bc04a5bad8854288c956062ec1d4d7c14fed6',1,'oboe::VoiceCommunication()']]], + ['voicecommunicationsignalling',['VoiceCommunicationSignalling',['../a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba404f62633744bf4da0c6a27a2b78ce74',1,'oboe']]], + ['voicerecognition',['VoiceRecognition',['../a00032.html#a17f63a064de966efddd5d0335992bc04af6e440b4e9edf49afe18aa4be77be6fc',1,'oboe']]] +]; diff --git a/docs/reference/search/functions_0.js b/docs/reference/search/functions_0.js index b960c6807..99961b47b 100644 --- a/docs/reference/search/functions_0.js +++ b/docs/reference/search/functions_0.js @@ -1,8 +1,5 @@ var searchData= [ - ['calculatelatencymillis',['calculateLatencyMillis',['../a00036.html#ae023cb001f3261d064f423101798d6be',1,'oboe::AudioStream']]], - ['close',['close',['../a00036.html#ad33a20f0d6792e322b9d8a2bcf14fcf8',1,'oboe::AudioStream']]], - ['convertformattosizeinbytes',['convertFormatToSizeInBytes',['../a00032.html#ac67383a3df0f6e7a51f8415ffd9fdaca',1,'oboe']]], - ['converttotext',['convertToText',['../a00032.html#a8d1ae211254cc239019f165b607f4365',1,'oboe']]], - ['createbasedonsign',['createBasedOnSign',['../a00060.html#a2304c6120e2aad8f2189383a98c7b0a7',1,'oboe::ResultWithValue']]] + ['audiostream',['AudioStream',['../a00036.html#a8ebb587a07bf62c864fd62c63b241fd4',1,'oboe::AudioStream']]], + ['audiostreambase',['AudioStreamBase',['../a00040.html#aa6b103e1b0f808bbc4949d56f0829f98',1,'oboe::AudioStreamBase']]] ]; diff --git a/docs/reference/search/functions_1.js b/docs/reference/search/functions_1.js index 233a00e9f..2eb05ebaf 100644 --- a/docs/reference/search/functions_1.js +++ b/docs/reference/search/functions_1.js @@ -1,17 +1,10 @@ var searchData= [ - ['getaudioapi',['getAudioApi',['../a00036.html#a2b7a3cee7444114843dbdd1fc705f6bb',1,'oboe::AudioStream']]], - ['getbuffercapacityinframes',['getBufferCapacityInFrames',['../a00040.html#ab1531253e64aaebe9e9eddbafb9098fc',1,'oboe::AudioStreamBase']]], - ['getbuffersizeinframes',['getBufferSizeInFrames',['../a00040.html#af5217ab05bfde0d7637024b599302d0b',1,'oboe::AudioStreamBase']]], - ['getchannelcount',['getChannelCount',['../a00040.html#aa0b0a068097efaf967fb235c55383dd8',1,'oboe::AudioStreamBase']]], - ['getdirection',['getDirection',['../a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1',1,'oboe::AudioStreamBase']]], - ['getformat',['getFormat',['../a00040.html#ab1e640461d7bf9d596decb913da7ac86',1,'oboe::AudioStreamBase']]], - ['getframesperburst',['getFramesPerBurst',['../a00036.html#ac160acb656515814fa6fdd157c131a0a',1,'oboe::AudioStream']]], - ['getframespercallback',['getFramesPerCallback',['../a00040.html#a1c133e1949f0814f60bd8bb61346756b',1,'oboe::AudioStreamBase']]], - ['getframeswritten',['getFramesWritten',['../a00036.html#ab43dd4074e1de57bac1c3fd111430341',1,'oboe::AudioStream']]], - ['getsamplerate',['getSampleRate',['../a00040.html#ae9d32f3e09174bad69e74f147ee33087',1,'oboe::AudioStreamBase']]], - ['getsdkversion',['getSdkVersion',['../a00032.html#a54528938e9fccab7ad8947ccf0e409db',1,'oboe']]], - ['getstate',['getState',['../a00036.html#a47bb5798275f14d76444283a6b6f35eb',1,'oboe::AudioStream']]], - ['getunderlyingstream',['getUnderlyingStream',['../a00036.html#a5458d7130415eb4defe3dbc11d479e2f',1,'oboe::AudioStream']]], - ['getxruncount',['getXRunCount',['../a00036.html#ad1a1d3bbf3b348ed92b7ed18ce9cc261',1,'oboe::AudioStream']]] + ['calculatelatencymillis',['calculateLatencyMillis',['../a00036.html#ae023cb001f3261d064f423101798d6be',1,'oboe::AudioStream']]], + ['close',['close',['../a00036.html#ad33a20f0d6792e322b9d8a2bcf14fcf8',1,'oboe::AudioStream']]], + ['convertfloattopcm16',['convertFloatToPcm16',['../a00032.html#adbda063116feb9fa98a31ee820170060',1,'oboe']]], + ['convertformattosizeinbytes',['convertFormatToSizeInBytes',['../a00032.html#ac67383a3df0f6e7a51f8415ffd9fdaca',1,'oboe']]], + ['convertpcm16tofloat',['convertPcm16ToFloat',['../a00032.html#ad17bee42828d13f2ef62a889e175c643',1,'oboe']]], + ['converttotext',['convertToText',['../a00032.html#af65aaea3c5d82eee6906664d61c094b3',1,'oboe']]], + ['createbasedonsign',['createBasedOnSign',['../a00060.html#a2304c6120e2aad8f2189383a98c7b0a7',1,'oboe::ResultWithValue']]] ]; diff --git a/docs/reference/search/functions_2.js b/docs/reference/search/functions_2.js index dbacfe3f9..313a17a4a 100644 --- a/docs/reference/search/functions_2.js +++ b/docs/reference/search/functions_2.js @@ -1,6 +1,4 @@ var searchData= [ - ['isaaudiorecommended',['isAAudioRecommended',['../a00044.html#a622732bbe5c6577356d749f7dc2108df',1,'oboe::AudioStreamBuilder']]], - ['isaaudiosupported',['isAAudioSupported',['../a00044.html#a18e7b5f7554a4c2ca763e35e8117d699',1,'oboe::AudioStreamBuilder']]], - ['isxruncountsupported',['isXRunCountSupported',['../a00036.html#a43d8a098440cde28f4ee8bedd6d107c4',1,'oboe::AudioStream']]] + ['error',['error',['../a00060.html#adfc76ae6db81535c2e82b856975eed41',1,'oboe::ResultWithValue']]] ]; diff --git a/docs/reference/search/functions_3.js b/docs/reference/search/functions_3.js index d8643bc9b..cdee9ca92 100644 --- a/docs/reference/search/functions_3.js +++ b/docs/reference/search/functions_3.js @@ -1,12 +1,5 @@ var searchData= [ - ['onaudioready',['onAudioReady',['../a00048.html#af3a7c44f0254abe6e5e5bb566e2317df',1,'oboe::AudioStreamCallback']]], - ['ondefaultcallback',['onDefaultCallback',['../a00036.html#abda7ae8e6832030572785de3964ed848',1,'oboe::AudioStream']]], - ['onerrorafterclose',['onErrorAfterClose',['../a00048.html#a7089c5e18a80cba89eb3f4fe2341aeba',1,'oboe::AudioStreamCallback']]], - ['onerrorbeforeclose',['onErrorBeforeClose',['../a00048.html#a2407ff537a60301fd161bd2c36913bfd',1,'oboe::AudioStreamCallback']]], - ['open',['open',['../a00036.html#a686c6ce8a29051c858fd1de386805dc6',1,'oboe::AudioStream']]], - ['openstream',['openStream',['../a00044.html#a86b94cfa47729bef2e04dce1a9086074',1,'oboe::AudioStreamBuilder']]], - ['operator_20bool',['operator bool',['../a00060.html#ae32b1953b777af7d1d0c94862ca39986',1,'oboe::ResultWithValue']]], - ['operator_20result',['operator Result',['../a00060.html#af62107817c0bc76047e6b655a78504ba',1,'oboe::ResultWithValue']]], - ['operator_21',['operator!',['../a00060.html#a2dbc8b09ead8b073a78af95b4b0186e3',1,'oboe::ResultWithValue']]] + ['firecallback',['fireCallback',['../a00036.html#a0c4fd19b01a4ef750dd9d6ae3a512eda',1,'oboe::AudioStream']]], + ['flush',['flush',['../a00036.html#a32c25c0333eab3d65ce02275ad4acb3d',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/functions_4.js b/docs/reference/search/functions_4.js index 16f079872..24b276811 100644 --- a/docs/reference/search/functions_4.js +++ b/docs/reference/search/functions_4.js @@ -1,4 +1,29 @@ var searchData= [ - ['requestreset',['requestReset',['../a00056.html#a6c0142e08dc65eda8f758b4794450867',1,'oboe::LatencyTuner']]] + ['getaudioapi',['getAudioApi',['../a00036.html#a2b7a3cee7444114843dbdd1fc705f6bb',1,'oboe::AudioStream::getAudioApi()'],['../a00044.html#ac9d41811c297fd28bc61833f640bb8d0',1,'oboe::AudioStreamBuilder::getAudioApi()']]], + ['getbuffercapacityinframes',['getBufferCapacityInFrames',['../a00040.html#ab1531253e64aaebe9e9eddbafb9098fc',1,'oboe::AudioStreamBase']]], + ['getbuffersizeinframes',['getBufferSizeInFrames',['../a00040.html#af5217ab05bfde0d7637024b599302d0b',1,'oboe::AudioStreamBase']]], + ['getbytesperframe',['getBytesPerFrame',['../a00036.html#a5c01907a59d5f89a5e4b819fe66b08bc',1,'oboe::AudioStream']]], + ['getbytespersample',['getBytesPerSample',['../a00036.html#a44dda61e6e948e49b68f87172f084d62',1,'oboe::AudioStream']]], + ['getcallback',['getCallback',['../a00040.html#a1b4a2a191546708da657510c3cd6b797',1,'oboe::AudioStreamBase']]], + ['getchannelcount',['getChannelCount',['../a00040.html#aa0b0a068097efaf967fb235c55383dd8',1,'oboe::AudioStreamBase']]], + ['getcontenttype',['getContentType',['../a00040.html#ab12e2d068fa87e0553b01a400d96eb82',1,'oboe::AudioStreamBase']]], + ['getdeviceid',['getDeviceId',['../a00040.html#a093057d625bc896864b959974c265f21',1,'oboe::AudioStreamBase']]], + ['getdirection',['getDirection',['../a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1',1,'oboe::AudioStreamBase']]], + ['getformat',['getFormat',['../a00040.html#ab1e640461d7bf9d596decb913da7ac86',1,'oboe::AudioStreamBase']]], + ['getframesperburst',['getFramesPerBurst',['../a00036.html#ac160acb656515814fa6fdd157c131a0a',1,'oboe::AudioStream']]], + ['getframespercallback',['getFramesPerCallback',['../a00040.html#a1c133e1949f0814f60bd8bb61346756b',1,'oboe::AudioStreamBase']]], + ['getframesread',['getFramesRead',['../a00036.html#aeebfc59abd978cd6dff07c16cfe266df',1,'oboe::AudioStream']]], + ['getframeswritten',['getFramesWritten',['../a00036.html#ab43dd4074e1de57bac1c3fd111430341',1,'oboe::AudioStream']]], + ['getinputpreset',['getInputPreset',['../a00040.html#a5c773b93b8aa38191c7199cab023428a',1,'oboe::AudioStreamBase']]], + ['getperformancemode',['getPerformanceMode',['../a00040.html#a2ddb935de0e24dd7ae8e2cfbecac9fdc',1,'oboe::AudioStreamBase']]], + ['getsamplerate',['getSampleRate',['../a00040.html#ae9d32f3e09174bad69e74f147ee33087',1,'oboe::AudioStreamBase']]], + ['getsdkversion',['getSdkVersion',['../a00032.html#a54528938e9fccab7ad8947ccf0e409db',1,'oboe']]], + ['getsessionid',['getSessionId',['../a00040.html#aa3c502ce09bbad7690a2dd6acaf8892e',1,'oboe::AudioStreamBase']]], + ['getsharingmode',['getSharingMode',['../a00040.html#a1fb033fc963f971bd1aa8f6707e49b41',1,'oboe::AudioStreamBase']]], + ['getstate',['getState',['../a00036.html#a47bb5798275f14d76444283a6b6f35eb',1,'oboe::AudioStream']]], + ['gettimestamp',['getTimestamp',['../a00036.html#a1d7cf4e43fb9d7b31857a90d9eceee6d',1,'oboe::AudioStream']]], + ['getunderlyingstream',['getUnderlyingStream',['../a00036.html#a5458d7130415eb4defe3dbc11d479e2f',1,'oboe::AudioStream']]], + ['getusage',['getUsage',['../a00040.html#a0bcfb2f8bd11c92b541fd910da9af397',1,'oboe::AudioStreamBase']]], + ['getxruncount',['getXRunCount',['../a00036.html#ad1a1d3bbf3b348ed92b7ed18ce9cc261',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/functions_5.js b/docs/reference/search/functions_5.js index 0abd90f04..bc43339c3 100644 --- a/docs/reference/search/functions_5.js +++ b/docs/reference/search/functions_5.js @@ -1,19 +1,9 @@ var searchData= [ - ['setaudioapi',['setAudioApi',['../a00044.html#a38c6d6c5e718df1e3ac69daaac47c391',1,'oboe::AudioStreamBuilder']]], - ['setbuffercapacityinframes',['setBufferCapacityInFrames',['../a00044.html#abaff480867af51ca0899bfa6fd7cc3ef',1,'oboe::AudioStreamBuilder']]], - ['setbuffersizeinframes',['setBufferSizeInFrames',['../a00036.html#ac93b18e18487e809151f63ec3c6228bb',1,'oboe::AudioStream']]], - ['setcallback',['setCallback',['../a00044.html#a698cefa9af73bc97c020c004821fccbd',1,'oboe::AudioStreamBuilder']]], - ['setchannelcount',['setChannelCount',['../a00044.html#a075d10291e1f998d90c2f73ef767b5a7',1,'oboe::AudioStreamBuilder']]], - ['setcontenttype',['setContentType',['../a00044.html#a6a17bafc217c2b624179fbbf77fe4468',1,'oboe::AudioStreamBuilder']]], - ['setdeviceid',['setDeviceId',['../a00044.html#af36ddcd00686a9e1de661bdac0685a8e',1,'oboe::AudioStreamBuilder']]], - ['setdirection',['setDirection',['../a00044.html#ab3fbd47b06197619c26393637e26354c',1,'oboe::AudioStreamBuilder']]], - ['setformat',['setFormat',['../a00044.html#aa2e1d2d73cd6c2eb9f349bf2fe5f6515',1,'oboe::AudioStreamBuilder']]], - ['setframespercallback',['setFramesPerCallback',['../a00044.html#a3f397821f61eabaeedaf31064c859a54',1,'oboe::AudioStreamBuilder']]], - ['setinputpreset',['setInputPreset',['../a00044.html#a144a3d095fd668210282f1a91f23e1f0',1,'oboe::AudioStreamBuilder']]], - ['setperformancemode',['setPerformanceMode',['../a00044.html#a6cd1d65612e844e59da71a68ea0ab3ee',1,'oboe::AudioStreamBuilder']]], - ['setsamplerate',['setSampleRate',['../a00044.html#a30ef3d5f51d56a9f980dc09600ed139d',1,'oboe::AudioStreamBuilder']]], - ['setsessionid',['setSessionId',['../a00044.html#a54c1651bdbe089d0d714af499e8a5f1d',1,'oboe::AudioStreamBuilder']]], - ['setsharingmode',['setSharingMode',['../a00044.html#a3e991742acbbfb6fe5ebcf592c478654',1,'oboe::AudioStreamBuilder']]], - ['setusage',['setUsage',['../a00044.html#a593255a2f5eb972665775cfc5bc58f6a',1,'oboe::AudioStreamBuilder']]] + ['incrementframesread',['incrementFramesRead',['../a00036.html#a81568482a217b314498e2501210758d7',1,'oboe::AudioStream']]], + ['incrementframeswritten',['incrementFramesWritten',['../a00036.html#ad6b4c63f6ed1ecb509f7b80352a9c0bd',1,'oboe::AudioStream']]], + ['isaaudiorecommended',['isAAudioRecommended',['../a00044.html#a622732bbe5c6577356d749f7dc2108df',1,'oboe::AudioStreamBuilder']]], + ['isaaudiosupported',['isAAudioSupported',['../a00044.html#a18e7b5f7554a4c2ca763e35e8117d699',1,'oboe::AudioStreamBuilder']]], + ['isplaying',['isPlaying',['../a00036.html#ad5260e2cc71108b1b2e694bf6162279f',1,'oboe::AudioStream']]], + ['isxruncountsupported',['isXRunCountSupported',['../a00036.html#a43d8a098440cde28f4ee8bedd6d107c4',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/functions_6.js b/docs/reference/search/functions_6.js index 9f8dfb69b..68e93bd74 100644 --- a/docs/reference/search/functions_6.js +++ b/docs/reference/search/functions_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['tune',['tune',['../a00056.html#ad2be756965e6a9af3114008eda892174',1,'oboe::LatencyTuner']]] + ['latencytuner',['LatencyTuner',['../a00056.html#a0263b9a55825c0a403653b2b508073ea',1,'oboe::LatencyTuner']]] ]; diff --git a/docs/reference/search/functions_7.js b/docs/reference/search/functions_7.js index 88c115f25..3b927be50 100644 --- a/docs/reference/search/functions_7.js +++ b/docs/reference/search/functions_7.js @@ -1,4 +1,14 @@ var searchData= [ - ['usesaaudio',['usesAAudio',['../a00036.html#a15cdaaaa4c1e8da322d6da33334c8147',1,'oboe::AudioStream']]] + ['onaudioready',['onAudioReady',['../a00048.html#af3a7c44f0254abe6e5e5bb566e2317df',1,'oboe::AudioStreamCallback']]], + ['ondefaultcallback',['onDefaultCallback',['../a00036.html#abda7ae8e6832030572785de3964ed848',1,'oboe::AudioStream']]], + ['onerrorafterclose',['onErrorAfterClose',['../a00048.html#a7089c5e18a80cba89eb3f4fe2341aeba',1,'oboe::AudioStreamCallback']]], + ['onerrorbeforeclose',['onErrorBeforeClose',['../a00048.html#a2407ff537a60301fd161bd2c36913bfd',1,'oboe::AudioStreamCallback']]], + ['open',['open',['../a00036.html#a686c6ce8a29051c858fd1de386805dc6',1,'oboe::AudioStream']]], + ['openstream',['openStream',['../a00044.html#a86b94cfa47729bef2e04dce1a9086074',1,'oboe::AudioStreamBuilder']]], + ['operator_20bool',['operator bool',['../a00060.html#ae32b1953b777af7d1d0c94862ca39986',1,'oboe::ResultWithValue']]], + ['operator_20result',['operator Result',['../a00060.html#af62107817c0bc76047e6b655a78504ba',1,'oboe::ResultWithValue']]], + ['operator_21',['operator!',['../a00060.html#a2dbc8b09ead8b073a78af95b4b0186e3',1,'oboe::ResultWithValue']]], + ['operator_3c_3c',['operator<<',['../a00032.html#aa403103686222502d1cfc47bafc10aeb',1,'oboe']]], + ['operator_3d',['operator=',['../a00040.html#aa9c987a59555d7a60b9f7a63f4afc7fc',1,'oboe::AudioStreamBase']]] ]; diff --git a/docs/reference/search/functions_8.js b/docs/reference/search/functions_8.js index 57aa014d2..385c0844e 100644 --- a/docs/reference/search/functions_8.js +++ b/docs/reference/search/functions_8.js @@ -1,6 +1,4 @@ var searchData= [ - ['waitforstatechange',['waitForStateChange',['../a00036.html#a0c865a5501f369d959c39d8ab8b46a07',1,'oboe::AudioStream']]], - ['waitforstatetransition',['waitForStateTransition',['../a00036.html#a8adbacd6a55a94a532916ab037fba1d6',1,'oboe::AudioStream']]], - ['write',['write',['../a00036.html#ab3f6bf8abed87f3804ac4df3472c3670',1,'oboe::AudioStream']]] + ['pause',['pause',['../a00036.html#a04f29836748a8e5842aef2be200022ad',1,'oboe::AudioStream']]] ]; diff --git a/docs/reference/search/functions_9.html b/docs/reference/search/functions_9.html new file mode 100644 index 000000000..5ccec4291 --- /dev/null +++ b/docs/reference/search/functions_9.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_9.js b/docs/reference/search/functions_9.js new file mode 100644 index 000000000..7be512955 --- /dev/null +++ b/docs/reference/search/functions_9.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['read',['read',['../a00036.html#acbf3933af829313d281b5455053338da',1,'oboe::AudioStream']]], + ['requestflush',['requestFlush',['../a00036.html#a6bd5d633ff999e4da1faf3cd949aa602',1,'oboe::AudioStream']]], + ['requestpause',['requestPause',['../a00036.html#a7f18bb3cc5490fd7fbc1f6da63c730f6',1,'oboe::AudioStream']]], + ['requestreset',['requestReset',['../a00056.html#a6c0142e08dc65eda8f758b4794450867',1,'oboe::LatencyTuner']]], + ['requeststart',['requestStart',['../a00036.html#a3c484e314dee8dfed1d419f487b5d601',1,'oboe::AudioStream']]], + ['requeststop',['requestStop',['../a00036.html#a820e634f741e6b5efdcef8104cecb919',1,'oboe::AudioStream']]], + ['resultwithvalue',['ResultWithValue',['../a00060.html#aae75caa0d16a9e23a012f77fb50c5927',1,'oboe::ResultWithValue::ResultWithValue(oboe::Result error)'],['../a00060.html#a600309367db58d71f0ec16e90f7ebea5',1,'oboe::ResultWithValue::ResultWithValue(T value)']]] +]; diff --git a/docs/reference/search/functions_a.html b/docs/reference/search/functions_a.html new file mode 100644 index 000000000..3958eb7b9 --- /dev/null +++ b/docs/reference/search/functions_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_a.js b/docs/reference/search/functions_a.js new file mode 100644 index 000000000..5823ff7ba --- /dev/null +++ b/docs/reference/search/functions_a.js @@ -0,0 +1,22 @@ +var searchData= +[ + ['setaudioapi',['setAudioApi',['../a00044.html#a38c6d6c5e718df1e3ac69daaac47c391',1,'oboe::AudioStreamBuilder']]], + ['setbuffercapacityinframes',['setBufferCapacityInFrames',['../a00044.html#abaff480867af51ca0899bfa6fd7cc3ef',1,'oboe::AudioStreamBuilder']]], + ['setbuffersizeinframes',['setBufferSizeInFrames',['../a00036.html#ac93b18e18487e809151f63ec3c6228bb',1,'oboe::AudioStream']]], + ['setcallback',['setCallback',['../a00044.html#a698cefa9af73bc97c020c004821fccbd',1,'oboe::AudioStreamBuilder']]], + ['setchannelcount',['setChannelCount',['../a00044.html#a075d10291e1f998d90c2f73ef767b5a7',1,'oboe::AudioStreamBuilder']]], + ['setcontenttype',['setContentType',['../a00044.html#a6a17bafc217c2b624179fbbf77fe4468',1,'oboe::AudioStreamBuilder']]], + ['setdeviceid',['setDeviceId',['../a00044.html#af36ddcd00686a9e1de661bdac0685a8e',1,'oboe::AudioStreamBuilder']]], + ['setdirection',['setDirection',['../a00044.html#ab3fbd47b06197619c26393637e26354c',1,'oboe::AudioStreamBuilder']]], + ['setformat',['setFormat',['../a00044.html#aa2e1d2d73cd6c2eb9f349bf2fe5f6515',1,'oboe::AudioStreamBuilder']]], + ['setframespercallback',['setFramesPerCallback',['../a00044.html#a3f397821f61eabaeedaf31064c859a54',1,'oboe::AudioStreamBuilder']]], + ['setinputpreset',['setInputPreset',['../a00044.html#a144a3d095fd668210282f1a91f23e1f0',1,'oboe::AudioStreamBuilder']]], + ['setnativeformat',['setNativeFormat',['../a00036.html#ab01c37fca9110e916a482a909f5cc82d',1,'oboe::AudioStream']]], + ['setperformancemode',['setPerformanceMode',['../a00044.html#a6cd1d65612e844e59da71a68ea0ab3ee',1,'oboe::AudioStreamBuilder']]], + ['setsamplerate',['setSampleRate',['../a00044.html#a30ef3d5f51d56a9f980dc09600ed139d',1,'oboe::AudioStreamBuilder']]], + ['setsessionid',['setSessionId',['../a00044.html#a54c1651bdbe089d0d714af499e8a5f1d',1,'oboe::AudioStreamBuilder']]], + ['setsharingmode',['setSharingMode',['../a00044.html#a3e991742acbbfb6fe5ebcf592c478654',1,'oboe::AudioStreamBuilder']]], + ['setusage',['setUsage',['../a00044.html#a593255a2f5eb972665775cfc5bc58f6a',1,'oboe::AudioStreamBuilder']]], + ['start',['start',['../a00036.html#af04f03eb6b64b564f1c4401688987d21',1,'oboe::AudioStream']]], + ['stop',['stop',['../a00036.html#aec093859d42f0470c884edd1e976d9f3',1,'oboe::AudioStream']]] +]; diff --git a/docs/reference/search/functions_b.html b/docs/reference/search/functions_b.html new file mode 100644 index 000000000..b99b702d2 --- /dev/null +++ b/docs/reference/search/functions_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_b.js b/docs/reference/search/functions_b.js new file mode 100644 index 000000000..9f8dfb69b --- /dev/null +++ b/docs/reference/search/functions_b.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['tune',['tune',['../a00056.html#ad2be756965e6a9af3114008eda892174',1,'oboe::LatencyTuner']]] +]; diff --git a/docs/reference/search/functions_c.html b/docs/reference/search/functions_c.html new file mode 100644 index 000000000..3a33d874d --- /dev/null +++ b/docs/reference/search/functions_c.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_c.js b/docs/reference/search/functions_c.js new file mode 100644 index 000000000..88c115f25 --- /dev/null +++ b/docs/reference/search/functions_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['usesaaudio',['usesAAudio',['../a00036.html#a15cdaaaa4c1e8da322d6da33334c8147',1,'oboe::AudioStream']]] +]; diff --git a/docs/reference/search/functions_d.html b/docs/reference/search/functions_d.html new file mode 100644 index 000000000..31b75b889 --- /dev/null +++ b/docs/reference/search/functions_d.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_d.js b/docs/reference/search/functions_d.js new file mode 100644 index 000000000..c9e05760b --- /dev/null +++ b/docs/reference/search/functions_d.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['value',['value',['../a00060.html#a45f5c99a2c9f8fbaca502276f7ebb434',1,'oboe::ResultWithValue']]] +]; diff --git a/docs/reference/search/functions_e.html b/docs/reference/search/functions_e.html new file mode 100644 index 000000000..cddb9bb58 --- /dev/null +++ b/docs/reference/search/functions_e.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/functions_e.js b/docs/reference/search/functions_e.js new file mode 100644 index 000000000..57aa014d2 --- /dev/null +++ b/docs/reference/search/functions_e.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['waitforstatechange',['waitForStateChange',['../a00036.html#a0c865a5501f369d959c39d8ab8b46a07',1,'oboe::AudioStream']]], + ['waitforstatetransition',['waitForStateTransition',['../a00036.html#a8adbacd6a55a94a532916ab037fba1d6',1,'oboe::AudioStream']]], + ['write',['write',['../a00036.html#ab3f6bf8abed87f3804ac4df3472c3670',1,'oboe::AudioStream']]] +]; diff --git a/docs/reference/search/pages_0.html b/docs/reference/search/pages_0.html new file mode 100644 index 000000000..d7528582d --- /dev/null +++ b/docs/reference/search/pages_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/pages_0.js b/docs/reference/search/pages_0.js new file mode 100644 index 000000000..6ced2839e --- /dev/null +++ b/docs/reference/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['deprecated_20list',['Deprecated List',['../a00032.html',1,'']]] +]; diff --git a/docs/reference/search/pages_1.html b/docs/reference/search/pages_1.html new file mode 100644 index 000000000..924fb482e --- /dev/null +++ b/docs/reference/search/pages_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/pages_1.js b/docs/reference/search/pages_1.js new file mode 100644 index 000000000..093992df5 --- /dev/null +++ b/docs/reference/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../a00032.html',1,'']]] +]; diff --git a/docs/reference/search/searchdata.js b/docs/reference/search/searchdata.js index 4a41a4cb8..19097a0fc 100644 --- a/docs/reference/search/searchdata.js +++ b/docs/reference/search/searchdata.js @@ -1,12 +1,12 @@ var indexSectionsWithContent = { - 0: "acdegilmnoprstuvw", + 0: "acdefgiklmnoprstuvw", 1: "adlrv", 2: "o", - 3: "cgiorstuw", - 4: "mnpst", - 5: "acisu", - 6: "acegmnosuv" + 3: "acefgiloprstuvw", + 4: "cfkmnpst", + 5: "acdiprsu", + 6: "acefgilmnopsuv" }; var indexSectionNames = diff --git a/docs/reference/search/variables_0.js b/docs/reference/search/variables_0.js index 093dfa7b8..5f9c25140 100644 --- a/docs/reference/search/variables_0.js +++ b/docs/reference/search/variables_0.js @@ -1,5 +1,4 @@ var searchData= [ - ['major',['Major',['../a00064.html#a270f2e92582d5187be339eeda8e2b276',1,'oboe::Version']]], - ['minor',['Minor',['../a00064.html#ae460bb95e3a9099696205a35fffb5469',1,'oboe::Version']]] + ['channelcount',['ChannelCount',['../a00052.html#ad5dce538d5963c81bf58350ab730962d',1,'oboe::DefaultStreamValues']]] ]; diff --git a/docs/reference/search/variables_1.js b/docs/reference/search/variables_1.js index 3f287d2c4..fa2a0d2cb 100644 --- a/docs/reference/search/variables_1.js +++ b/docs/reference/search/variables_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['number',['Number',['../a00064.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]] + ['framesperburst',['FramesPerBurst',['../a00052.html#ab5ea5576699cebc56193f5c297d3e300',1,'oboe::DefaultStreamValues']]] ]; diff --git a/docs/reference/search/variables_2.js b/docs/reference/search/variables_2.js index 3e251a9a2..980d3280c 100644 --- a/docs/reference/search/variables_2.js +++ b/docs/reference/search/variables_2.js @@ -1,4 +1,9 @@ var searchData= [ - ['patch',['Patch',['../a00064.html#a690110f2b3e887892da8f29ab5c057b2',1,'oboe::Version']]] + ['kdefaulttimeoutnanos',['kDefaultTimeoutNanos',['../a00032.html#aab8f5f081a8b2147e16ec920347c1b5c',1,'oboe']]], + ['kmillispersecond',['kMillisPerSecond',['../a00032.html#ad1bb9f5626cec20d3a052a8721959873',1,'oboe']]], + ['knanospermicrosecond',['kNanosPerMicrosecond',['../a00032.html#aedef0759ae3622b6f0324799bcbdebf0',1,'oboe']]], + ['knanospermillisecond',['kNanosPerMillisecond',['../a00032.html#a831e887150474c087170679eaca8672b',1,'oboe']]], + ['knanospersecond',['kNanosPerSecond',['../a00032.html#a5948466b593c4eab65f7025846a39f51',1,'oboe']]], + ['kunspecified',['kUnspecified',['../a00032.html#ab0772052200184e514082eaa89be7905',1,'oboe']]] ]; diff --git a/docs/reference/search/variables_3.js b/docs/reference/search/variables_3.js index 0667719ef..d645969ec 100644 --- a/docs/reference/search/variables_3.js +++ b/docs/reference/search/variables_3.js @@ -1,4 +1,24 @@ var searchData= [ - ['samplerate',['SampleRate',['../a00052.html#a46a5d9a653f2153f618cadcab764e1b1',1,'oboe::DefaultStreamValues']]] + ['major',['Major',['../a00064.html#a270f2e92582d5187be339eeda8e2b276',1,'oboe::Version']]], + ['mbuffercapacityinframes',['mBufferCapacityInFrames',['../a00040.html#ac81d4719b350f8138aad1af38f0873b6',1,'oboe::AudioStreamBase']]], + ['mbuffersizeinframes',['mBufferSizeInFrames',['../a00040.html#a3b65595d26d1eae1b8ce9925a5b98f6a',1,'oboe::AudioStreamBase']]], + ['mchannelcount',['mChannelCount',['../a00040.html#a5ff460bac9d14dfeac4eeddfcbb6e206',1,'oboe::AudioStreamBase']]], + ['mcontenttype',['mContentType',['../a00040.html#a5f8f0e5add381b841856de80ea4cdb2b',1,'oboe::AudioStreamBase']]], + ['mdeviceid',['mDeviceId',['../a00040.html#a23dafa12fb1a6242b088ebd5a52798c8',1,'oboe::AudioStreamBase']]], + ['mdirection',['mDirection',['../a00040.html#a26e9294721561d3b16bcaeec5faf4880',1,'oboe::AudioStreamBase']]], + ['mformat',['mFormat',['../a00040.html#a7869f04836c2c2bdc10c7309ad4b8e09',1,'oboe::AudioStreamBase']]], + ['mframesperburst',['mFramesPerBurst',['../a00040.html#a54061319ed348329a29d883a5de2482e',1,'oboe::AudioStreamBase']]], + ['mframespercallback',['mFramesPerCallback',['../a00040.html#a3962eb94420ad0ecea70029236001899',1,'oboe::AudioStreamBase']]], + ['mframesread',['mFramesRead',['../a00036.html#a2b9124ba3b0f564fa58b0651438250e7',1,'oboe::AudioStream']]], + ['mframeswritten',['mFramesWritten',['../a00036.html#aa88d2a712b91a8b763f2721d78480ba8',1,'oboe::AudioStream']]], + ['minor',['Minor',['../a00064.html#ae460bb95e3a9099696205a35fffb5469',1,'oboe::Version']]], + ['minputpreset',['mInputPreset',['../a00040.html#a1e5d4f5b30c4cc36f81ffd858cc00589',1,'oboe::AudioStreamBase']]], + ['mnativeformat',['mNativeFormat',['../a00036.html#a07ed6b5e5bd4bc276bc1e1fc08e51d60',1,'oboe::AudioStream']]], + ['mperformancemode',['mPerformanceMode',['../a00040.html#ab99671c2d0552557e75dc7b4afe91765',1,'oboe::AudioStreamBase']]], + ['msamplerate',['mSampleRate',['../a00040.html#a998885bb6c4f37e145f4626ad4177dea',1,'oboe::AudioStreamBase']]], + ['msessionid',['mSessionId',['../a00040.html#abe1c1e9cada1ced9b5c1504ac9b07737',1,'oboe::AudioStreamBase']]], + ['msharingmode',['mSharingMode',['../a00040.html#ae9187492b679c97a0963e264954be473',1,'oboe::AudioStreamBase']]], + ['mstreamcallback',['mStreamCallback',['../a00040.html#ae3f72318212dd9977d7fa0ced92c91f4',1,'oboe::AudioStreamBase']]], + ['musage',['mUsage',['../a00040.html#a5b518e82f39c9fcbd7050fd66adb253c',1,'oboe::AudioStreamBase']]] ]; diff --git a/docs/reference/search/variables_4.js b/docs/reference/search/variables_4.js index 13a94071d..3f287d2c4 100644 --- a/docs/reference/search/variables_4.js +++ b/docs/reference/search/variables_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['text',['Text',['../a00064.html#a2c86e578b827fbca5f40c460a7754503',1,'oboe::Version']]] + ['number',['Number',['../a00064.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]] ]; diff --git a/docs/reference/search/variables_5.html b/docs/reference/search/variables_5.html new file mode 100644 index 000000000..7e95e946f --- /dev/null +++ b/docs/reference/search/variables_5.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/variables_5.js b/docs/reference/search/variables_5.js new file mode 100644 index 000000000..3e251a9a2 --- /dev/null +++ b/docs/reference/search/variables_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['patch',['Patch',['../a00064.html#a690110f2b3e887892da8f29ab5c057b2',1,'oboe::Version']]] +]; diff --git a/docs/reference/search/variables_6.html b/docs/reference/search/variables_6.html new file mode 100644 index 000000000..3d398e628 --- /dev/null +++ b/docs/reference/search/variables_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/variables_6.js b/docs/reference/search/variables_6.js new file mode 100644 index 000000000..0667719ef --- /dev/null +++ b/docs/reference/search/variables_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['samplerate',['SampleRate',['../a00052.html#a46a5d9a653f2153f618cadcab764e1b1',1,'oboe::DefaultStreamValues']]] +]; diff --git a/docs/reference/search/variables_7.html b/docs/reference/search/variables_7.html new file mode 100644 index 000000000..7b791460a --- /dev/null +++ b/docs/reference/search/variables_7.html @@ -0,0 +1,30 @@ + + + + + + + + + +
                                    +
                                    Loading...
                                    +
                                    + +
                                    Searching...
                                    +
                                    No Matches
                                    + +
                                    + + diff --git a/docs/reference/search/variables_7.js b/docs/reference/search/variables_7.js new file mode 100644 index 000000000..13a94071d --- /dev/null +++ b/docs/reference/search/variables_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['text',['Text',['../a00064.html#a2c86e578b827fbca5f40c460a7754503',1,'oboe::Version']]] +]; diff --git a/include/oboe/AudioStream.h b/include/oboe/AudioStream.h index cb54a1c16..1e9a20583 100644 --- a/include/oboe/AudioStream.h +++ b/include/oboe/AudioStream.h @@ -28,6 +28,12 @@ namespace oboe { +/** + * The default number of nanoseconds to wait for when performing state change operations on the + * stream, such as `start` and `stop`. + * + * @see oboe::AudioStream::start + */ constexpr int64_t kDefaultTimeoutNanos = (2000 * kNanosPerMillisecond); /** @@ -37,6 +43,12 @@ class AudioStream : public AudioStreamBase { public: AudioStream() {} + + /** + * Construct an `AudioStream` using the given `AudioStreamBuilder` + * + * @param builder containing all the stream's attributes + */ explicit AudioStream(const AudioStreamBuilder &builder); virtual ~AudioStream() = default; @@ -56,20 +68,56 @@ class AudioStream : public AudioStreamBase { */ virtual Result close() = 0; - /* - * These are synchronous and will block until the operation is complete. + /** + * Start the stream. This will block until the stream has been started, an error occurs + * or `timeoutNanoseconds` has been reached. */ virtual Result start(int64_t timeoutNanoseconds = kDefaultTimeoutNanos); + + /** + * Pause the stream. This will block until the stream has been paused, an error occurs + * or `timeoutNanoseconds` has been reached. + */ virtual Result pause(int64_t timeoutNanoseconds = kDefaultTimeoutNanos); + + /** + * Flush the stream. This will block until the stream has been flushed, an error occurs + * or `timeoutNanoseconds` has been reached. + */ virtual Result flush(int64_t timeoutNanoseconds = kDefaultTimeoutNanos); + + /** + * Stop the stream. This will block until the stream has been stopped, an error occurs + * or `timeoutNanoseconds` has been reached. + */ virtual Result stop(int64_t timeoutNanoseconds = kDefaultTimeoutNanos); /* Asynchronous requests. * Use waitForStateChange() if you need to wait for completion. */ + + /** + * Start the stream asynchronously. Returns immediately (does not block). Equivalent to calling + * `start(0)`. + */ virtual Result requestStart() = 0; + + /** + * Pause the stream asynchronously. Returns immediately (does not block). Equivalent to calling + * `pause(0)`. + */ virtual Result requestPause() = 0; + + /** + * Flush the stream asynchronously. Returns immediately (does not block). Equivalent to calling + * `flush(0)`. + */ virtual Result requestFlush() = 0; + + /** + * Stop the stream asynchronously. Returns immediately (does not block). Equivalent to calling + * `stop(0)`. + */ virtual Result requestStop() = 0; /** @@ -151,18 +199,44 @@ class AudioStream : public AudioStreamBase { */ virtual int32_t getFramesPerBurst() = 0; + /** + * Indicates whether the audio stream is playing. + * + * THIS MAY BE REMOVED IN FUTURE. https://github.com/google/oboe/issues/208 + */ bool isPlaying(); + /** + * Get the number of bytes in each audio frame. This is calculated using the channel count + * and the sample format. For example, a 2 channel floating point stream will have + * 2 * 4 = 8 bytes per frame. + * + * @return number of bytes in each audio frame. + */ int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); } + /** + * Get the number of bytes per sample. This is calculated using the sample format. For example, + * stream using 16-bit integer samples will have 2 bytes per sample. + * + * @return the number of bytes per sample. + */ int32_t getBytesPerSample() const; /** + * The number of audio frames written into the stream. * This monotonic counter will never get reset. + * * @return the number of frames written so far */ virtual int64_t getFramesWritten() { return mFramesWritten; } + /** + * The number of audio frames read from the stream. + * This monotonic counter will never get reset. + * + * @return the number of frames read so far + */ virtual int64_t getFramesRead() { return mFramesRead; } /** @@ -192,6 +266,15 @@ class AudioStream : public AudioStreamBase { return ResultWithValue(Result::ErrorUnimplemented); } + /** + * Get the timestamp that the frame at `framePosition` was presented to the + * audio hardware. + * + * @param clockId the type of clock to use e.g. CLOCK_MONOTONIC + * @param framePosition the frame number to query + * @param timeNanoseconds an output parameter which will contain the presentation timestamp + * (if the operation is successful) + */ virtual Result getTimestamp(clockid_t clockId, int64_t *framePosition, int64_t *timeNanoseconds) { @@ -200,10 +283,11 @@ class AudioStream : public AudioStreamBase { // ============== I/O =========================== /** - * A high level write that will wait until the write is complete or it runs out of time. - * If timeoutNanoseconds is zero then this call will not wait. + * Write data from the supplied buffer into the stream. This method will block until the write + * is complete or it runs out of time. + * + * If `timeoutNanoseconds` is zero then this call will not wait. * - * @param stream A stream created using OboeStream_Open(). * @param buffer The address of the first sample. * @param numFrames Number of frames to write. Only complete frames will be written. * @param timeoutNanoseconds Maximum number of nanoseconds to wait for completion. @@ -216,6 +300,18 @@ class AudioStream : public AudioStreamBase { return ResultWithValue(Result::ErrorUnimplemented); } + /** + * Read data into the supplied buffer from the stream. This method will block until the read + * is complete or it runs out of time. + * + * If `timeoutNanoseconds` is zero then this call will not wait. + * + * @param buffer The address of the first sample. + * @param numFrames Number of frames to read. Only complete frames will be read. + * @param timeoutNanoseconds Maximum number of nanoseconds to wait for completion. + * @return a ResultWithValue which has a result of Result::OK and a value containing the number + * of frames actually read, or result of Result::Error*. + */ virtual ResultWithValue read(void *buffer, int32_t numFrames, int64_t timeoutNanoseconds) { @@ -223,21 +319,24 @@ class AudioStream : public AudioStreamBase { } /** + * Get the underlying audio API which the stream uses. * - * @return the API that this stream uses + * @return the API that this stream uses. */ virtual AudioApi getAudioApi() const = 0; /** - * @return true if this stream is implemented using the AAudio API + * Returns true if the underlying audio API is AAudio. + * + * @return true if this stream is implemented using the AAudio API. */ bool usesAAudio() const { return getAudioApi() == AudioApi::AAudio; } /** - * Do not use this for production. This is only for debugging. - * If you need to call this method then something is wrong. + * Only for debugging. Do use in production. + * If you need to call this method something is wrong. * If you think you need it for production then please let us know * so we can modify Oboe so that you don't need this. * @@ -249,9 +348,22 @@ class AudioStream : public AudioStreamBase { protected: + /** + * Increment the frames written to this stream + * + * @param frames number of frames to increment by + * @return total frames which have been written + */ virtual int64_t incrementFramesWritten(int32_t frames) { return mFramesWritten += frames; } + + /** + * Increment the frames which have been read from this stream + * + * @param frames number of frames to increment by + * @return total frames which have been read + */ virtual int64_t incrementFramesRead(int32_t frames) { return mFramesRead += frames; } @@ -277,22 +389,46 @@ class AudioStream : public AudioStreamBase { return DataCallbackResult::Stop; } + /** + * Override this to provide your own behaviour for the audio callback + * + * @param audioData container array which audio frames will be written into or read from + * @param numFrames number of frames which were read/written + * @return the result of the callback: stop or continue + * + */ DataCallbackResult fireCallback(void *audioData, int numFrames); + /** + * Used to set the format of the underlying stream + */ virtual void setNativeFormat(AudioFormat format) { mNativeFormat = format; } - // TODO: make private - // These do not change after open. + /** + * Do not set directly, use `setNativeFormat` + * + * TODO: make private + * These do not change after open. + */ AudioFormat mNativeFormat = AudioFormat::Invalid; - // TODO these should be atomic like in AAudio + /** + * Number of frames which have been written into the stream + * + * TODO these should be atomic like in AAudio + */ int64_t mFramesWritten = 0; + + /** + * Number of frames which have been read from the stream + * + * TODO these should be atomic like in AAudio + */ int64_t mFramesRead = 0; private: - // TODO these should be atomic like in AAudio int mPreviousScheduler = -1; }; diff --git a/include/oboe/AudioStreamBase.h b/include/oboe/AudioStreamBase.h index 9b38fa58b..e31b0519c 100644 --- a/include/oboe/AudioStreamBase.h +++ b/include/oboe/AudioStreamBase.h @@ -24,13 +24,8 @@ namespace oboe { /** - * Base class containing parameters for Oboe streams and builders. - * - * OboeStreamBuilder can return OBOE_UNSPECIFIED or the requested value. - * - * OboeStream will generally return the actual final value, but getFramesPerCallback() - * can be unspecified even for a stream. - */ + * Base class containing parameters for audio streams and builders. + **/ class AudioStreamBase { public: @@ -39,12 +34,19 @@ class AudioStreamBase { virtual ~AudioStreamBase() = default; // This class only contains primitives so we can use default constructor and copy methods. + + /** + * Default copy constructor + */ AudioStreamBase(const AudioStreamBase&) = default; + /** + * Default assignment operator + */ AudioStreamBase& operator=(const AudioStreamBase&) = default; /** - * @return number of channels, for example 2 for stereo + * @return number of channels, for example 2 for stereo, or kUnspecified */ int getChannelCount() const { return mChannelCount; } @@ -54,18 +56,17 @@ class AudioStreamBase { Direction getDirection() const { return mDirection; } /** - * @return sample rate for the stream + * @return sample rate for the stream or kUnspecified */ int32_t getSampleRate() const { return mSampleRate; } /** - * @return framesPerCallback or OBOE_UNSPECIFIED + * @return the number of frames in each callback or kUnspecified. */ int getFramesPerCallback() const { return mFramesPerCallback; } /** - * @return OBOE_AUDIO_FORMAT_PCM_FLOAT, OBOE_AUDIO_FORMAT_PCM_I16 - * or OBOE_AUDIO_FORMAT_UNSPECIFIED + * @return the audio sample format (e.g. Float or I16) */ AudioFormat getFormat() const { return mFormat; } @@ -78,46 +79,90 @@ class AudioStreamBase { virtual int32_t getBufferSizeInFrames() { return mBufferSizeInFrames; }; /** - * @return capacityInFrames or OBOE_UNSPECIFIED + * @return capacityInFrames or kUnspecified */ virtual int32_t getBufferCapacityInFrames() const { return mBufferCapacityInFrames; } + /** + * @return the sharing mode of the stream. + */ SharingMode getSharingMode() const { return mSharingMode; } + /** + * @return the performance mode of the stream. + */ PerformanceMode getPerformanceMode() const { return mPerformanceMode; } + /** + * @return the device ID of the stream. + */ int32_t getDeviceId() const { return mDeviceId; } + /** + * @return the callback object for this stream, if set. + */ AudioStreamCallback* getCallback() const { return mStreamCallback; } + /** + * @return the usage for this stream. + */ Usage getUsage() const { return mUsage; } + /** + * @return the stream's content type. + */ ContentType getContentType() const { return mContentType; } + /** + * @return the stream's input preset. + */ InputPreset getInputPreset() const { return mInputPreset; } + /** + * @return the stream's session ID allocation strategy (None or Allocate). + */ SessionId getSessionId() const { return mSessionId; } protected: + + /** The callback which will be fired when new data is ready to be read/written **/ AudioStreamCallback *mStreamCallback = nullptr; + /** Number of audio frames which will be requested in each callback */ int32_t mFramesPerCallback = kUnspecified; + /** Stream channel count */ int32_t mChannelCount = kUnspecified; + /** Stream sample rate */ int32_t mSampleRate = kUnspecified; + /** Stream audio device ID */ int32_t mDeviceId = kUnspecified; + /** Stream buffer capacity specified as a number of audio frames */ int32_t mBufferCapacityInFrames = kUnspecified; + /** Stream buffer size specified as a number of audio frames */ int32_t mBufferSizeInFrames = kUnspecified; + /** + * Number of frames which will be copied to/from the audio device in a single read/write + * operation + */ int32_t mFramesPerBurst = kUnspecified; + /** Stream sharing mode */ SharingMode mSharingMode = SharingMode::Shared; + /** Format of audio frames */ AudioFormat mFormat = AudioFormat::Unspecified; + /** Stream direction */ Direction mDirection = Direction::Output; + /** Stream performance mode */ PerformanceMode mPerformanceMode = PerformanceMode::None; - // Added in API 28 + + /** Stream usage. Only active on Android 28+ */ Usage mUsage = Usage::Media; + /** Stream content type. Only active on Android 28+ */ ContentType mContentType = ContentType::Music; + /** Stream input preset. Only active on Android 28+ */ InputPreset mInputPreset = InputPreset::VoiceRecognition; + /** Stream session ID allocation strategy. Only active on Android 28+ */ SessionId mSessionId = SessionId::None; }; diff --git a/include/oboe/AudioStreamBuilder.h b/include/oboe/AudioStreamBuilder.h index 307493ac7..9286a5778 100644 --- a/include/oboe/AudioStreamBuilder.h +++ b/include/oboe/AudioStreamBuilder.h @@ -111,6 +111,13 @@ class AudioStreamBuilder : public AudioStreamBase { return this; } + /** + * Get the audio API which will be requested when opening the stream. No guarantees that this is + * the API which will actually be used. Query the stream itself to find out the API which is + * being used. + * + * @return the requested audio API + */ AudioApi getAudioApi() const { return mAudioApi; } /** diff --git a/include/oboe/AudioStreamCallback.h b/include/oboe/AudioStreamCallback.h index 9a5db1763..19a293f68 100644 --- a/include/oboe/AudioStreamCallback.h +++ b/include/oboe/AudioStreamCallback.h @@ -23,6 +23,13 @@ namespace oboe { class AudioStream; +/** + * AudioStreamCallback defines a callback interface for: + * + * 1) moving data to/from an audio stream using `onAudioReady` + * 2) being alerted when a stream has an error using `onError*` methods + * + */ class AudioStreamCallback { public: virtual ~AudioStreamCallback() = default; diff --git a/include/oboe/Definitions.h b/include/oboe/Definitions.h index 04ad121ee..094f733ad 100644 --- a/include/oboe/Definitions.h +++ b/include/oboe/Definitions.h @@ -35,14 +35,35 @@ ASSERT_INT32(aaudio_performance_mode_t); namespace oboe { + /** + * Represents any attribute, property or value which hasn't been specified. + */ constexpr int32_t kUnspecified = 0; // TODO: Investigate using std::chrono + /** + * The number of nanoseconds in a microsecond. 1,000. + */ constexpr int64_t kNanosPerMicrosecond = 1000; + + /** + * The number of nanoseconds in a millisecond. 1,000,000. + */ constexpr int64_t kNanosPerMillisecond = kNanosPerMicrosecond * 1000; + + /** + * The number of milliseconds in a second. 1,000. + */ constexpr int64_t kMillisPerSecond = 1000; + + /** + * The number of nanoseconds in a second. 1,000,000,000. + */ constexpr int64_t kNanosPerSecond = kNanosPerMillisecond * kMillisPerSecond; + /** + * The state of the audio stream. + */ enum class StreamState : aaudio_stream_state_t { Uninitialized = AAUDIO_STREAM_STATE_UNINITIALIZED, Unknown = AAUDIO_STREAM_STATE_UNKNOWN, @@ -60,23 +81,62 @@ namespace oboe { Disconnected = AAUDIO_STREAM_STATE_DISCONNECTED, }; + /** + * The direction of the stream. + */ enum class Direction : aaudio_direction_t { + + /** + * Used for playback. + */ Output = AAUDIO_DIRECTION_OUTPUT, + + /** + * Used for recording. + */ Input = AAUDIO_DIRECTION_INPUT, }; + /** + * The format of audio samples. + */ enum class AudioFormat : aaudio_format_t { + /** + * Invalid format. + */ Invalid = AAUDIO_FORMAT_INVALID, + + /** + * Unspecified format. Format will be decided by Oboe. + */ Unspecified = AAUDIO_FORMAT_UNSPECIFIED, + + /** + * Signed 16-bit integers. + */ I16 = AAUDIO_FORMAT_PCM_I16, + + /** + * Single precision floating points. + */ Float = AAUDIO_FORMAT_PCM_FLOAT, }; + /** + * The result of an audio callback. + */ enum class DataCallbackResult : aaudio_data_callback_result_t { + // Indicates to the caller that the callbacks should continue. Continue = AAUDIO_CALLBACK_RESULT_CONTINUE, + + // Indicates to the caller that the callbacks should stop immediately. Stop = AAUDIO_CALLBACK_RESULT_STOP, }; + /** + * The result of an operation. All except the `OK` result indicates that an error occurred. + * The `Result` can be converted into a human readable string using `convertToText`. + */ enum class Result : aaudio_result_t { OK, ErrorBase = AAUDIO_ERROR_BASE, @@ -110,6 +170,9 @@ namespace oboe { ErrorClosed, }; + /** + * The sharing mode of the audio stream. + */ enum class SharingMode : aaudio_sharing_mode_t { /** @@ -126,18 +189,30 @@ namespace oboe { Shared = AAUDIO_SHARING_MODE_SHARED, }; + /** + * The performance mode of the audio stream. + */ enum class PerformanceMode : aaudio_performance_mode_t { - // No particular performance needs. Default. + /** + * No particular performance needs. Default. + */ None = AAUDIO_PERFORMANCE_MODE_NONE, - // Extending battery life is most important. + /** + * Extending battery life is most important. + */ PowerSaving = AAUDIO_PERFORMANCE_MODE_POWER_SAVING, - // Reducing latency is most important. + /** + * Reducing latency is most important. + */ LowLatency = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY }; + /** + * The underlying audio API used by the audio stream. + */ enum class AudioApi : int32_t { /** * Try to use AAudio. If not available then use OpenSL ES. @@ -163,13 +238,13 @@ namespace oboe { #endif /** - * The Usage attribute expresses "why" you are playing a sound, what is this sound used for. + * The Usage attribute expresses *why* you are playing a sound, what is this sound used for. * This information is used by certain platforms or routing policies * to make more refined volume or routing decisions. * * Note that these match the equivalent values in AudioAttributes in the Android Java API. * - * Added in API level 28. + * This attribute only has an effect on Android API 28+. */ enum class Usage : aaudio_usage_t { /** @@ -238,16 +313,16 @@ namespace oboe { /** - * The CONTENT_TYPE attribute describes "what" you are playing. + * The ContentType attribute describes *what* you are playing. * It expresses the general category of the content. This information is optional. - * But in case it is known (for instance {@link #AAUDIO_CONTENT_TYPE_MOVIE} for a - * movie streaming service or {@link #AAUDIO_CONTENT_TYPE_SPEECH} for + * But in case it is known (for instance {@link Movie} for a + * movie streaming service or {@link Speech} for * an audio book application) this information might be used by the audio framework to * enforce audio focus. * * Note that these match the equivalent values in AudioAttributes in the Android Java API. * - * Added in API level 28. + * This attribute only has an effect on Android API 28+. */ enum ContentType : aaudio_content_type_t { @@ -280,7 +355,7 @@ namespace oboe { * * Note that these match the equivalent values in MediaRecorder.AudioSource in the Android Java API. * - * Added in API level 28. + * This attribute only has an effect on Android API 28+. */ enum InputPreset : aaudio_input_preset_t { /** @@ -311,13 +386,16 @@ namespace oboe { Unprocessed = CONSTANT_API_P(9, AAUDIO_INPUT_PRESET_UNPROCESSED), }; + /** + * This attribute can be used to allocate a session ID to the audio stream. + * + * This attribute only has an effect on Android API 28+. + */ enum SessionId { /** * Do not allocate a session ID. * Effects cannot be used with this stream. * Default. - * - * Added in API level 28. */ None = CONSTANT_API_P(-1, AAUDIO_SESSION_ID_NONE), @@ -327,12 +405,20 @@ namespace oboe { * Note that the use of this flag may result in higher latency. * * Note that this matches the value of AudioManager.AUDIO_SESSION_ID_GENERATE. - * - * Added in API level 28. */ Allocate = CONSTANT_API_P(0, AAUDIO_SESSION_ID_ALLOCATE), }; + /** + * The channel count of the audio stream. The underlying type is `int32_t`. + * Use of this enum is convenient to avoid "magic" + * numbers when specifying the channel count. + * + * For example, you can write + * `builder.setChannelCount(ChannelCount::Stereo)` + * rather than `builder.setChannelCount(2)` + * + */ enum ChannelCount : int32_t { /** * Audio channel count definition, use Mono or Stereo @@ -352,31 +438,35 @@ namespace oboe { #undef CONSTANT_API_P + /** + * On API 16 to 25 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and + * framesPerBurst are not known by the native code. + * On API 17+ these values should be obtained from the AudioManager using this code: + * + * 
                                    
+        // Note that this technique only works for built-in speakers and headphones.
+        AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
+        String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
+        int defaultSampleRate = Integer.parseInt(sampleRateStr);
+        String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
+        int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
+
                                    + * + * It can then be passed down to Oboe through JNI. + * + * AAudio will get the optimal framesPerBurst from the HAL and will ignore this value. + */ class DefaultStreamValues { public: - /** - * On API 16 to 25 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and - * framesPerBurst are not known by the native code. - * On API 17+ these values should be obtained from the AudioManager using this code: - * - * 
                                    
-            // Note that this technique only works for built-in speakers and headphones.
-            AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
-            String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
-            int defaultSampleRate = Integer.parseInt(sampleRateStr);
-            String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
-            int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
-
                                    - * - * It can then be passed down to Oboe through JNI. - * - * AAudio will get the optimal framesPerBurst from the HAL and will ignore this value. - */ + /** The default sample rate to use when opening new audio streams */ static int32_t SampleRate; + /** The default frames per burst to use when opening new audio streams */ static int32_t FramesPerBurst; + /** The default channel count to use when opening new audio streams */ static int32_t ChannelCount; + }; diff --git a/include/oboe/LatencyTuner.h b/include/oboe/LatencyTuner.h index 7b879ba57..84889b1e4 100644 --- a/include/oboe/LatencyTuner.h +++ b/include/oboe/LatencyTuner.h @@ -25,9 +25,8 @@ namespace oboe { /** - * This can be used to dynamically tune the latency of an output stream. - * It adjusts the bufferSize based on the number of underruns. - * The bufferSize is the portion of the total bufferCapacity that is used to store data. + * LatencyTuner can be used to dynamically tune the latency of an output stream. + * It adjusts the stream's bufferSize by monitoring the number of underruns. * * This only affects the latency associated with the first level of buffering that is closest * to the application. It does not affect low latency in the HAL, or touch latency in the UI. @@ -41,6 +40,12 @@ namespace oboe { */ class LatencyTuner { public: + + /** + * Construct a new LatencyTuner object which will act on the given audio stream + * + * @param stream the stream who's latency will be tuned + */ explicit LatencyTuner(AudioStream &stream); /** diff --git a/include/oboe/ResultWithValue.h b/include/oboe/ResultWithValue.h index a198803dd..edc125e43 100644 --- a/include/oboe/ResultWithValue.h +++ b/include/oboe/ResultWithValue.h @@ -23,21 +23,61 @@ namespace oboe { +/** + * A ResultWithValue can store both the result of an operation (either OK or an error) and a value. + * + * It has been designed for cases where the caller needs to know whether an operation succeeded and, + * if it did, a value which was obtained during the operation. + * + * For example, when reading from a stream the caller needs to know the result of the read operation + * and, if it was successful, how many frames were read. Note that ResultWithValue can be evaluated + * as a boolean so it's simple to check whether the result is OK. + * + * + * ResultWithValue resultOfRead = myStream.read(&buffer, numFrames, timeoutNanoseconds); + * + * if (resultOfRead){ + * LOGD("Frames read: %d", resultOfRead.value()); + * } else { + * LOGD("Error reading from stream: %s", resultOfRead.error()); + * } + * + */ template class ResultWithValue { public: + + /** + * Construct a ResultWithValue containing an error result. + * + * @param error The error + */ ResultWithValue(oboe::Result error) : mValue{} , mError(error) {} + /** + * Construct a ResultWithValue containing an OK result and a value. + * + * @param value the value to store + */ explicit ResultWithValue(T value) : mValue(value) , mError(oboe::Result::OK) {} + /** + * Get the result. + * + * @return the result + */ oboe::Result error() const { return mError; } + /** + * Get the value + * @return + */ T value() const { return mValue; } @@ -96,6 +136,9 @@ class ResultWithValue { const oboe::Result mError; }; +/** + * If the result is `OK` then return the value, otherwise return a human-readable error message. + */ template std::ostream& operator<<(std::ostream &strm, const ResultWithValue &result) { if (!result) { diff --git a/include/oboe/Utilities.h b/include/oboe/Utilities.h index 29a9b6da0..29700fdb1 100644 --- a/include/oboe/Utilities.h +++ b/include/oboe/Utilities.h @@ -23,7 +23,22 @@ namespace oboe { +/** + * Convert an array of floats to an array of 16-bit integers. + * + * @param source the input array. + * @param destination the output array. + * @param numSamples the number of values to convert. + */ void convertFloatToPcm16(const float *source, int16_t *destination, int32_t numSamples); + +/** + * Convert an array of 16-bit integers to an array of floats. + * + * @param source the input array. + * @param destination the output array. + * @param numSamples the number of values to convert. + */ void convertPcm16ToFloat(const int16_t *source, float *destination, int32_t numSamples); /** @@ -37,11 +52,11 @@ int32_t convertFormatToSizeInBytes(AudioFormat format); * This is intended for developers to use when debugging. * It is not for displaying to users. * - * @param enum value @see common/Utilities.cpp for concrete implementations + * @param input object to convert from. @see common/Utilities.cpp for concrete implementations * @return text representation of an Oboe enum value. */ template -const char * convertToText(FromType); +const char * convertToText(FromType input); /** * Return the version of the SDK that is currently running. diff --git a/include/oboe/Version.h b/include/oboe/Version.h index 3c65b07e3..cbad28ae6 100644 --- a/include/oboe/Version.h +++ b/include/oboe/Version.h @@ -51,6 +51,9 @@ namespace oboe { +/** + * Oboe versioning object + */ struct Version { /** * This is incremented when we make breaking API changes. Based loosely on https://semver.org/.