Skip to content

docs: Update getSessionId documentation to clarify return values #2355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robertwu1 merged 1 commit into from
Mar 26, 2026
Merged

docs: Update getSessionId documentation to clarify return values #2355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion include/oboe/AudioStreamBase.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,8 @@ class AudioStreamBase {
InputPreset getInputPreset() const { return mInputPreset; }

/**
* @return the stream's session ID allocation strategy (None or Allocate).
* @return the session ID, SessionId::None, or SessionId::Allocate.
* Positive values represent the actual allocated session ID.
*/
SessionId getSessionId() const { return mSessionId; }

Expand Down
2 changes: 2 additions & 0 deletions include/oboe/Definitions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,8 @@ namespace oboe {
/**
* This attribute can be used to allocate a session ID to the audio stream.
*
* Positive values represent the actual allocated session ID.
*
* This attribute only has an effect on Android API 28+.
*/
enum SessionId {
Expand Down
Loading