diff --git a/_audio_stream_8h_source.html b/_audio_stream_8h_source.html index b31c3519c..6220bc81b 100644 --- a/_audio_stream_8h_source.html +++ b/_audio_stream_8h_source.html @@ -166,252 +166,252 @@
186 StreamState *nextState,
187 int64_t timeoutNanoseconds) = 0;
188
-
-
201 virtual ResultWithValue<int32_t> setBufferSizeInFrames(int32_t /* requestedFrames */) {
-
202 return Result::ErrorUnimplemented;
-
203 }
+
+
208 virtual ResultWithValue<int32_t> setBufferSizeInFrames(int32_t /* requestedFrames */) {
+
209 return Result::ErrorUnimplemented;
+
210 }
-
204
-
-
217 virtual ResultWithValue<int32_t> getXRunCount() {
-
218 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
-
219 }
+
211
+
+
224 virtual ResultWithValue<int32_t> getXRunCount() {
+
225 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
+
226 }
-
220
-
224 virtual bool isXRunCountSupported() const = 0;
-
225
-
-
231 int32_t getFramesPerBurst() const {
-
232 return mFramesPerBurst;
-
233 }
+
227
+
231 virtual bool isXRunCountSupported() const = 0;
+
232
+
+
238 int32_t getFramesPerBurst() const {
+
239 return mFramesPerBurst;
+
240 }
-
234
-
242 int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); }
-
243
-
250 int32_t getBytesPerSample() const;
-
251
-
258 virtual int64_t getFramesWritten();
-
259
-
266 virtual int64_t getFramesRead();
-
267
-
-
295 virtual ResultWithValue<double> calculateLatencyMillis() {
-
296 return ResultWithValue<double>(Result::ErrorUnimplemented);
-
297 }
+
241
+
249 int32_t getBytesPerFrame() const { return mChannelCount * getBytesPerSample(); }
+
250
+
257 int32_t getBytesPerSample() const;
+
258
+
265 virtual int64_t getFramesWritten();
+
266
+
273 virtual int64_t getFramesRead();
+
274
+
+
302 virtual ResultWithValue<double> calculateLatencyMillis() {
+
303 return ResultWithValue<double>(Result::ErrorUnimplemented);
+
304 }
-
298
-
-
320 virtual Result getTimestamp(clockid_t /* clockId */,
-
321 int64_t* /* framePosition */,
-
322 int64_t* /* timeNanoseconds */) {
-
323 return Result::ErrorUnimplemented;
-
324 }
+
305
+
+
327 virtual Result getTimestamp(clockid_t /* clockId */,
+
328 int64_t* /* framePosition */,
+
329 int64_t* /* timeNanoseconds */) {
+
330 return Result::ErrorUnimplemented;
+
331 }
-
325
-
346 virtual ResultWithValue<FrameTimestamp> getTimestamp(clockid_t /* clockId */);
-
347
-
348 // ============== I/O ===========================
-
-
361 virtual ResultWithValue<int32_t> write(const void* /* buffer */,
-
362 int32_t /* numFrames */,
-
363 int64_t /* timeoutNanoseconds */ ) {
-
364 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
-
365 }
+
332
+
353 virtual ResultWithValue<FrameTimestamp> getTimestamp(clockid_t /* clockId */);
+
354
+
355 // ============== I/O ===========================
+
+
368 virtual ResultWithValue<int32_t> write(const void* /* buffer */,
+
369 int32_t /* numFrames */,
+
370 int64_t /* timeoutNanoseconds */ ) {
+
371 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
+
372 }
-
366
-
-
379 virtual ResultWithValue<int32_t> read(void* /* buffer */,
-
380 int32_t /* numFrames */,
-
381 int64_t /* timeoutNanoseconds */) {
-
382 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
-
383 }
+
373
+
+
386 virtual ResultWithValue<int32_t> read(void* /* buffer */,
+
387 int32_t /* numFrames */,
+
388 int64_t /* timeoutNanoseconds */) {
+
389 return ResultWithValue<int32_t>(Result::ErrorUnimplemented);
+
390 }
-
384
-
390 virtual AudioApi getAudioApi() const = 0;
391
-
-
397 bool usesAAudio() const {
-
398 return getAudioApi() == AudioApi::AAudio;
-
399 }
+
397 virtual AudioApi getAudioApi() const = 0;
+
398
+
+
404 bool usesAAudio() const {
+
405 return getAudioApi() == AudioApi::AAudio;
+
406 }
-
400
-
-
409 virtual void *getUnderlyingStream() const {
-
410 return nullptr;
-
411 }
-
-
412
-
417 virtual void updateFramesWritten() = 0;
-
418
-
423 virtual void updateFramesRead() = 0;
-
424
-
425 /*
-
426 * Swap old callback for new callback.
-
427 * This not atomic.
-
428 * This should only be used internally.
-
429 * @param dataCallback
-
430 * @return previous dataCallback
-
431 */
-
432 AudioStreamDataCallback *swapDataCallback(AudioStreamDataCallback *dataCallback) {
-
433 AudioStreamDataCallback *previousCallback = mDataCallback;
-
434 mDataCallback = dataCallback;
-
435 return previousCallback;
-
436 }
-
437
-
438 /*
-
439 * Swap old callback for new callback.
-
440 * This not atomic.
-
441 * This should only be used internally.
-
442 * @param errorCallback
-
443 * @return previous errorCallback
-
444 */
-
445 AudioStreamErrorCallback *swapErrorCallback(AudioStreamErrorCallback *errorCallback) {
-
446 AudioStreamErrorCallback *previousCallback = mErrorCallback;
-
447 mErrorCallback = errorCallback;
-
448 return previousCallback;
-
449 }
-
450
-
454 ResultWithValue<int32_t> getAvailableFrames();
-
455
-
470 ResultWithValue<int32_t> waitForAvailableFrames(int32_t numFrames,
-
471 int64_t timeoutNanoseconds);
-
472
-
-
476 virtual oboe::Result getLastErrorCallbackResult() const {
-
477 return mErrorCallbackResult;
-
478 }
+
407
+
+
416 virtual void *getUnderlyingStream() const {
+
417 return nullptr;
+
418 }
+
419
+
424 virtual void updateFramesWritten() = 0;
+
425
+
430 virtual void updateFramesRead() = 0;
+
431
+
432 /*
+
433 * Swap old callback for new callback.
+
434 * This not atomic.
+
435 * This should only be used internally.
+
436 * @param dataCallback
+
437 * @return previous dataCallback
+
438 */
+
439 AudioStreamDataCallback *swapDataCallback(AudioStreamDataCallback *dataCallback) {
+
440 AudioStreamDataCallback *previousCallback = mDataCallback;
+
441 mDataCallback = dataCallback;
+
442 return previousCallback;
+
443 }
+
444
+
445 /*
+
446 * Swap old callback for new callback.
+
447 * This not atomic.
+
448 * This should only be used internally.
+
449 * @param errorCallback
+
450 * @return previous errorCallback
+
451 */
+
452 AudioStreamErrorCallback *swapErrorCallback(AudioStreamErrorCallback *errorCallback) {
+
453 AudioStreamErrorCallback *previousCallback = mErrorCallback;
+
454 mErrorCallback = errorCallback;
+
455 return previousCallback;
+
456 }
+
457
+
461 ResultWithValue<int32_t> getAvailableFrames();
+
462
+
477 ResultWithValue<int32_t> waitForAvailableFrames(int32_t numFrames,
+
478 int64_t timeoutNanoseconds);
479
-
480
-
481 int32_t getDelayBeforeCloseMillis() const {
-
482 return mDelayBeforeCloseMillis;
-
483 }
-
484
-
-
499 void setDelayBeforeCloseMillis(int32_t delayBeforeCloseMillis) {
-
500 mDelayBeforeCloseMillis = delayBeforeCloseMillis;
-
501 }
+
+
483 virtual oboe::Result getLastErrorCallbackResult() const {
+
484 return mErrorCallbackResult;
+
485 }
-
502
-
-
526 void setPerformanceHintEnabled(bool enabled) {
-
527 mPerformanceHintEnabled = enabled;
-
528 }
+
486
+
487
+
488 int32_t getDelayBeforeCloseMillis() const {
+
489 return mDelayBeforeCloseMillis;
+
490 }
+
491
+
+
506 void setDelayBeforeCloseMillis(int32_t delayBeforeCloseMillis) {
+
507 mDelayBeforeCloseMillis = delayBeforeCloseMillis;
+
508 }
-
529
-
-
536 bool isPerformanceHintEnabled() {
-
537 return mPerformanceHintEnabled;
-
538 }
+
509
+
+
533 void setPerformanceHintEnabled(bool enabled) {
+
534 mPerformanceHintEnabled = enabled;
+
535 }
-
539
-
540protected:
-
541
-
-
551 bool wasErrorCallbackCalled() {
-
552 return mErrorCallbackCalled.exchange(true);
-
553 }
+
536
+
+
543 bool isPerformanceHintEnabled() {
+
544 return mPerformanceHintEnabled;
+
545 }
-
554
-
561 virtual Result waitForStateTransition(StreamState startingState,
-
562 StreamState endingState,
-
563 int64_t timeoutNanoseconds);
-
564
-
-
572 virtual DataCallbackResult onDefaultCallback(void* /* audioData */, int /* numFrames */) {
-
573 return DataCallbackResult::Stop;
-
574 }
+
546
+
547protected:
+
548
+
+
558 bool wasErrorCallbackCalled() {
+
559 return mErrorCallbackCalled.exchange(true);
+
560 }
-
575
-
584 DataCallbackResult fireDataCallback(void *audioData, int numFrames);
-
585
-
-
589 bool isDataCallbackEnabled() {
-
590 return mDataCallbackEnabled;
-
591 }
+
561
+
568 virtual Result waitForStateTransition(StreamState startingState,
+
569 StreamState endingState,
+
570 int64_t timeoutNanoseconds);
+
571
+
+
579 virtual DataCallbackResult onDefaultCallback(void* /* audioData */, int /* numFrames */) {
+
580 return DataCallbackResult::Stop;
+
581 }
+
582
+
591 DataCallbackResult fireDataCallback(void *audioData, int numFrames);
592
-
-
597 void setDataCallbackEnabled(bool enabled) {
-
598 mDataCallbackEnabled = enabled;
-
599 }
+
+
596 bool isDataCallbackEnabled() {
+
597 return mDataCallbackEnabled;
+
598 }
+
+
599
+
+
604 void setDataCallbackEnabled(bool enabled) {
+
605 mDataCallbackEnabled = enabled;
+
606 }
-
600
-
605 void calculateDefaultDelayBeforeCloseMillis();
-
606
-
-
610 void sleepBeforeClose() {
-
611 if (mDelayBeforeCloseMillis > 0) {
-
612 usleep(mDelayBeforeCloseMillis * 1000);
-
613 }
-
614 }
+
607
+
612 void calculateDefaultDelayBeforeCloseMillis();
+
613
+
+
617 void sleepBeforeClose() {
+
618 if (mDelayBeforeCloseMillis > 0) {
+
619 usleep(mDelayBeforeCloseMillis * 1000);
+
620 }
+
621 }
-
615
-
619 virtual void beginPerformanceHintInCallback() {}
-
620
-
625 virtual void endPerformanceHintInCallback(int32_t numFrames) {}
-
626
-
630 virtual void closePerformanceHint() {}
-
631
-
632 /*
-
633 * Set a weak_ptr to this stream from the shared_ptr so that we can
-
634 * later use a shared_ptr in the error callback.
-
635 */
-
636 void setWeakThis(std::shared_ptr<oboe::AudioStream> &sharedStream) {
-
637 mWeakThis = sharedStream;
-
638 }
-
639
-
640 /*
-
641 * Make a shared_ptr that will prevent this stream from being deleted.
+
622
+
626 virtual void beginPerformanceHintInCallback() {}
+
627
+
632 virtual void endPerformanceHintInCallback(int32_t numFrames) {}
+
633
+
637 virtual void closePerformanceHint() {}
+
638
+
639 /*
+
640 * Set a weak_ptr to this stream from the shared_ptr so that we can
+
641 * later use a shared_ptr in the error callback.
642 */
-
643 std::shared_ptr<oboe::AudioStream> lockWeakThis() {
-
644 return mWeakThis.lock();
+
643 void setWeakThis(std::shared_ptr<oboe::AudioStream> &sharedStream) {
+
644 mWeakThis = sharedStream;
645 }
646
-
647 std::weak_ptr<AudioStream> mWeakThis; // weak pointer to this object
-
648
-
655 std::atomic<int64_t> mFramesWritten{};
-
656
-
663 std::atomic<int64_t> mFramesRead{};
-
664
-
665 std::mutex mLock; // for synchronizing start/stop/close
-
666
-
667 oboe::Result mErrorCallbackResult = oboe::Result::OK;
-
668
-
673 int32_t mFramesPerBurst = kUnspecified;
-
674
-
675 // Time to sleep in order to prevent a race condition with a callback after a close().
-
676 // Two milliseconds may be enough but 10 msec is even safer.
-
677 static constexpr int kMinDelayBeforeCloseMillis = 10;
-
678 int32_t mDelayBeforeCloseMillis = kMinDelayBeforeCloseMillis;
-
679
-
680private:
+
647 /*
+
648 * Make a shared_ptr that will prevent this stream from being deleted.
+
649 */
+
650 std::shared_ptr<oboe::AudioStream> lockWeakThis() {
+
651 return mWeakThis.lock();
+
652 }
+
653
+
654 std::weak_ptr<AudioStream> mWeakThis; // weak pointer to this object
+
655
+
662 std::atomic<int64_t> mFramesWritten{};
+
663
+
670 std::atomic<int64_t> mFramesRead{};
+
671
+
672 std::mutex mLock; // for synchronizing start/stop/close
+
673
+
674 oboe::Result mErrorCallbackResult = oboe::Result::OK;
+
675
+
680 int32_t mFramesPerBurst = kUnspecified;
681
-
682 // Log the scheduler if it changes.
-
683 void checkScheduler();
-
684 int mPreviousScheduler = -1;
-
685
-
686 std::atomic<bool> mDataCallbackEnabled{false};
-
687 std::atomic<bool> mErrorCallbackCalled{false};
+
682 // Time to sleep in order to prevent a race condition with a callback after a close().
+
683 // Two milliseconds may be enough but 10 msec is even safer.
+
684 static constexpr int kMinDelayBeforeCloseMillis = 10;
+
685 int32_t mDelayBeforeCloseMillis = kMinDelayBeforeCloseMillis;
+
686
+
687private:
688
-
689 std::atomic<bool> mPerformanceHintEnabled{false}; // set only by app
-
690};
+
689 // Log the scheduler if it changes.
+
690 void checkScheduler();
+
691 int mPreviousScheduler = -1;
+
692
+
693 std::atomic<bool> mDataCallbackEnabled{false};
+
694 std::atomic<bool> mErrorCallbackCalled{false};
+
695
+
696 std::atomic<bool> mPerformanceHintEnabled{false}; // set only by app
+
697};
-
691
-
-
696 struct StreamDeleterFunctor {
-
697 void operator()(AudioStream *audioStream) {
-
698 if (audioStream) {
-
699 audioStream->close();
-
700 }
-
701 delete audioStream;
-
702 }
-
703 };
+
698
+
+
703 struct StreamDeleterFunctor {
+
704 void operator()(AudioStream *audioStream) {
+
705 if (audioStream) {
+
706 audioStream->close();
+
707 }
+
708 delete audioStream;
+
709 }
+
710 };
-
704} // namespace oboe
+
711} // namespace oboe
-
705
-
706#endif /* OBOE_STREAM_H_ */
+
712
+
713#endif /* OBOE_STREAM_H_ */
oboe::AudioStreamBase
Definition AudioStreamBase.h:30
oboe::AudioStreamBase::mChannelCount
int32_t mChannelCount
Definition AudioStreamBase.h:250
oboe::AudioStreamBase::mDataCallback
AudioStreamDataCallback * mDataCallback
Definition AudioStreamBase.h:240
@@ -420,57 +420,57 @@
oboe::AudioStreamDataCallback
Definition AudioStreamCallback.h:34
oboe::AudioStreamErrorCallback
Definition AudioStreamCallback.h:101
oboe::AudioStream
Definition AudioStream.h:44
-
oboe::AudioStream::mFramesPerBurst
int32_t mFramesPerBurst
Definition AudioStream.h:673
+
oboe::AudioStream::mFramesPerBurst
int32_t mFramesPerBurst
Definition AudioStream.h:680
oboe::AudioStream::pause
virtual Result pause(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
-
oboe::AudioStream::mFramesRead
std::atomic< int64_t > mFramesRead
Definition AudioStream.h:663
+
oboe::AudioStream::mFramesRead
std::atomic< int64_t > mFramesRead
Definition AudioStream.h:670
oboe::AudioStream::waitForStateChange
virtual Result waitForStateChange(StreamState inputState, StreamState *nextState, int64_t timeoutNanoseconds)=0
-
oboe::AudioStream::onDefaultCallback
virtual DataCallbackResult onDefaultCallback(void *, int)
Definition AudioStream.h:572
-
oboe::AudioStream::setDataCallbackEnabled
void setDataCallbackEnabled(bool enabled)
Definition AudioStream.h:597
-
oboe::AudioStream::usesAAudio
bool usesAAudio() const
Definition AudioStream.h:397
+
oboe::AudioStream::onDefaultCallback
virtual DataCallbackResult onDefaultCallback(void *, int)
Definition AudioStream.h:579
+
oboe::AudioStream::setDataCallbackEnabled
void setDataCallbackEnabled(bool enabled)
Definition AudioStream.h:604
+
oboe::AudioStream::usesAAudio
bool usesAAudio() const
Definition AudioStream.h:404
oboe::AudioStream::getAudioApi
virtual AudioApi getAudioApi() const =0
-
oboe::AudioStream::getFramesPerBurst
int32_t getFramesPerBurst() const
Definition AudioStream.h:231
+
oboe::AudioStream::getFramesPerBurst
int32_t getFramesPerBurst() const
Definition AudioStream.h:238
oboe::AudioStream::flush
virtual Result flush(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
oboe::AudioStream::requestStart
virtual Result requestStart()=0
-
oboe::AudioStream::calculateLatencyMillis
virtual ResultWithValue< double > calculateLatencyMillis()
Definition AudioStream.h:295
-
oboe::AudioStream::read
virtual ResultWithValue< int32_t > read(void *, int32_t, int64_t)
Definition AudioStream.h:379
+
oboe::AudioStream::calculateLatencyMillis
virtual ResultWithValue< double > calculateLatencyMillis()
Definition AudioStream.h:302
+
oboe::AudioStream::read
virtual ResultWithValue< int32_t > read(void *, int32_t, int64_t)
Definition AudioStream.h:386
oboe::AudioStream::isXRunCountSupported
virtual bool isXRunCountSupported() const =0
oboe::AudioStream::getBytesPerSample
int32_t getBytesPerSample() const
-
oboe::AudioStream::getXRunCount
virtual ResultWithValue< int32_t > getXRunCount()
Definition AudioStream.h:217
+
oboe::AudioStream::getXRunCount
virtual ResultWithValue< int32_t > getXRunCount()
Definition AudioStream.h:224
oboe::AudioStream::updateFramesRead
virtual void updateFramesRead()=0
oboe::AudioStream::getState
virtual StreamState getState()=0
oboe::AudioStream::release
virtual Result release()
Definition AudioStream.h:90
-
oboe::AudioStream::closePerformanceHint
virtual void closePerformanceHint()
Definition AudioStream.h:630
-
oboe::AudioStream::getBytesPerFrame
int32_t getBytesPerFrame() const
Definition AudioStream.h:242
-
oboe::AudioStream::sleepBeforeClose
void sleepBeforeClose()
Definition AudioStream.h:610
+
oboe::AudioStream::closePerformanceHint
virtual void closePerformanceHint()
Definition AudioStream.h:637
+
oboe::AudioStream::getBytesPerFrame
int32_t getBytesPerFrame() const
Definition AudioStream.h:249
+
oboe::AudioStream::sleepBeforeClose
void sleepBeforeClose()
Definition AudioStream.h:617
oboe::AudioStream::updateFramesWritten
virtual void updateFramesWritten()=0
oboe::AudioStream::open
virtual Result open()
Definition AudioStream.h:67
-
oboe::AudioStream::beginPerformanceHintInCallback
virtual void beginPerformanceHintInCallback()
Definition AudioStream.h:619
+
oboe::AudioStream::beginPerformanceHintInCallback
virtual void beginPerformanceHintInCallback()
Definition AudioStream.h:626
oboe::AudioStream::requestFlush
virtual Result requestFlush()=0
oboe::AudioStream::requestPause
virtual Result requestPause()=0
oboe::AudioStream::requestStop
virtual Result requestStop()=0
-
oboe::AudioStream::mFramesWritten
std::atomic< int64_t > mFramesWritten
Definition AudioStream.h:655
+
oboe::AudioStream::mFramesWritten
std::atomic< int64_t > mFramesWritten
Definition AudioStream.h:662
oboe::AudioStream::waitForStateTransition
virtual Result waitForStateTransition(StreamState startingState, StreamState endingState, int64_t timeoutNanoseconds)
-
oboe::AudioStream::getUnderlyingStream
virtual void * getUnderlyingStream() const
Definition AudioStream.h:409
+
oboe::AudioStream::getUnderlyingStream
virtual void * getUnderlyingStream() const
Definition AudioStream.h:416
oboe::AudioStream::AudioStream
AudioStream(const AudioStreamBuilder &builder)
-
oboe::AudioStream::getLastErrorCallbackResult
virtual oboe::Result getLastErrorCallbackResult() const
Definition AudioStream.h:476
+
oboe::AudioStream::getLastErrorCallbackResult
virtual oboe::Result getLastErrorCallbackResult() const
Definition AudioStream.h:483
oboe::AudioStream::close
virtual Result close()
-
oboe::AudioStream::isPerformanceHintEnabled
bool isPerformanceHintEnabled()
Definition AudioStream.h:536
-
oboe::AudioStream::wasErrorCallbackCalled
bool wasErrorCallbackCalled()
Definition AudioStream.h:551
+
oboe::AudioStream::isPerformanceHintEnabled
bool isPerformanceHintEnabled()
Definition AudioStream.h:543
+
oboe::AudioStream::wasErrorCallbackCalled
bool wasErrorCallbackCalled()
Definition AudioStream.h:558
oboe::AudioStream::getAvailableFrames
ResultWithValue< int32_t > getAvailableFrames()
-
oboe::AudioStream::setBufferSizeInFrames
virtual ResultWithValue< int32_t > setBufferSizeInFrames(int32_t)
Definition AudioStream.h:201
+
oboe::AudioStream::setBufferSizeInFrames
virtual ResultWithValue< int32_t > setBufferSizeInFrames(int32_t)
Definition AudioStream.h:208
oboe::AudioStream::getFramesWritten
virtual int64_t getFramesWritten()
oboe::AudioStream::fireDataCallback
DataCallbackResult fireDataCallback(void *audioData, int numFrames)
oboe::AudioStream::waitForAvailableFrames
ResultWithValue< int32_t > waitForAvailableFrames(int32_t numFrames, int64_t timeoutNanoseconds)
-
oboe::AudioStream::getTimestamp
virtual Result getTimestamp(clockid_t, int64_t *, int64_t *)
Definition AudioStream.h:320
-
oboe::AudioStream::write
virtual ResultWithValue< int32_t > write(const void *, int32_t, int64_t)
Definition AudioStream.h:361
-
oboe::AudioStream::setPerformanceHintEnabled
void setPerformanceHintEnabled(bool enabled)
Definition AudioStream.h:526
-
oboe::AudioStream::isDataCallbackEnabled
bool isDataCallbackEnabled()
Definition AudioStream.h:589
+
oboe::AudioStream::getTimestamp
virtual Result getTimestamp(clockid_t, int64_t *, int64_t *)
Definition AudioStream.h:327
+
oboe::AudioStream::write
virtual ResultWithValue< int32_t > write(const void *, int32_t, int64_t)
Definition AudioStream.h:368
+
oboe::AudioStream::setPerformanceHintEnabled
void setPerformanceHintEnabled(bool enabled)
Definition AudioStream.h:533
+
oboe::AudioStream::isDataCallbackEnabled
bool isDataCallbackEnabled()
Definition AudioStream.h:596
oboe::AudioStream::stop
virtual Result stop(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
oboe::AudioStream::getFramesRead
virtual int64_t getFramesRead()
oboe::AudioStream::calculateDefaultDelayBeforeCloseMillis
void calculateDefaultDelayBeforeCloseMillis()
oboe::AudioStream::start
virtual Result start(int64_t timeoutNanoseconds=kDefaultTimeoutNanos)
-
oboe::AudioStream::setDelayBeforeCloseMillis
void setDelayBeforeCloseMillis(int32_t delayBeforeCloseMillis)
Definition AudioStream.h:499
-
oboe::AudioStream::endPerformanceHintInCallback
virtual void endPerformanceHintInCallback(int32_t numFrames)
Definition AudioStream.h:625
+
oboe::AudioStream::setDelayBeforeCloseMillis
void setDelayBeforeCloseMillis(int32_t delayBeforeCloseMillis)
Definition AudioStream.h:506
+
oboe::AudioStream::endPerformanceHintInCallback
virtual void endPerformanceHintInCallback(int32_t numFrames)
Definition AudioStream.h:632
oboe::AudioStream::getTimestamp
virtual ResultWithValue< FrameTimestamp > getTimestamp(clockid_t)
oboe::ResultWithValue
Definition ResultWithValue.h:47
oboe
Definition AudioStream.h:31
@@ -482,7 +482,7 @@
oboe::kDefaultTimeoutNanos
constexpr int64_t kDefaultTimeoutNanos
Definition AudioStream.h:39
oboe::kUnspecified
constexpr int32_t kUnspecified
Definition Definitions.h:31
oboe::DataCallbackResult
DataCallbackResult
Definition Definitions.h:160
-
oboe::StreamDeleterFunctor
Definition AudioStream.h:696
+
oboe::StreamDeleterFunctor
Definition AudioStream.h:703
diff --git a/_full_duplex_stream_8h_source.html b/_full_duplex_stream_8h_source.html index b94d9f20c..7ffbd2f1d 100644 --- a/_full_duplex_stream_8h_source.html +++ b/_full_duplex_stream_8h_source.html @@ -331,8 +331,8 @@
oboe::AudioStreamDataCallback
Definition AudioStreamCallback.h:34
oboe::AudioStream
Definition AudioStream.h:44
oboe::AudioStream::requestStart
virtual Result requestStart()=0
-
oboe::AudioStream::read
virtual ResultWithValue< int32_t > read(void *, int32_t, int64_t)
Definition AudioStream.h:379
-
oboe::AudioStream::getBytesPerFrame
int32_t getBytesPerFrame() const
Definition AudioStream.h:242
+
oboe::AudioStream::read
virtual ResultWithValue< int32_t > read(void *, int32_t, int64_t)
Definition AudioStream.h:386
+
oboe::AudioStream::getBytesPerFrame
int32_t getBytesPerFrame() const
Definition AudioStream.h:249
oboe::AudioStream::requestStop
virtual Result requestStop()=0
oboe::AudioStream::getAvailableFrames
ResultWithValue< int32_t > getAvailableFrames()
oboe::FullDuplexStream
Definition FullDuplexStream.h:50
diff --git a/classoboe_1_1_audio_stream.html b/classoboe_1_1_audio_stream.html index 2de624c5c..a1b741dbc 100644 --- a/classoboe_1_1_audio_stream.html +++ b/classoboe_1_1_audio_stream.html @@ -1430,6 +1430,8 @@

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().

+

This should only be used with Output streams. It will be ignored for Input streams because they are generally kept as empty as possible.

+

For OpenSL ES, this method only has an effect on output stream that do NOT use a callback. The blocking writes goes into a buffer in Oboe and the size of that buffer is controlled by this method.

Parameters
requestedFramesrequested number of frames that can be filled without blocking