Clearer explanation for exclusive sharing mode #23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 8, 2017
philburk
requested changes
Dec 12, 2017
FullGuide.md
Outdated
| A stream has a sharing mode: | ||
|
|
||
| * `SharingMode::Exclusive` (available on API 26+) means the stream has exclusive access to its audio device; the device cannot be used by any other audio stream. If the audio device is already in use, it might not be possible for the stream to have exclusive access. Exclusive streams provide the lowest possible latency, but they are also more likely to get disconnected. You should close exclusive streams as soon as you no longer need them, so that other apps can access the device. | ||
| * `SharingMode::Exclusive` (available on API 26+) means the stream has exclusive access to an endpoint on its audio device; the endpoint cannot be used by any other audio stream. If the exclusive endpoint is already in use, it might not be possible for the stream to obtain access to it. Exclusive streams provide the lowest possible latency by bypassing the mixer stage, but they are also more likely to get disconnected. You should close exclusive streams as soon as you no longer need them, so that other apps can access the device. Not all audio devices provide exclusive endpoints. | ||
| * `SharingMode::Shared` allows Oboe to mix audio. Oboe mixes all the shared streams assigned to the same device. |
FullGuide.md
Outdated
| * `SharingMode::Shared` allows Oboe to mix audio. Oboe mixes all the shared streams assigned to the same device. | ||
|
|
||
| You can explicitly request the sharing mode when you create a stream, although you are not guaranteed to receive that mode. By default, | ||
| the sharing mode is `Shared`. | ||
| You can explicitly request the sharing mode when you create a stream, although you are not guaranteed to receive that mode. By default, the sharing mode is `Shared`. | ||
|
|
||
| ### Audio format | ||
|
|
There was a problem hiding this comment.
The diagram below is not exactly correct. There is generally only ONE MMAP endpoint available per device. It can be used by one EXCLUSIVE stream OR multiple SHARED streams. But not both.
So if any app opens a SHARED MMAP stream then it can prevent another app from opening an EXCLUSIVE MMAP stream.
philburk
approved these changes
Dec 12, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added the concept of an audio device endpoint. Feedback welcome.