Add a source capture host example and sync the documentation - #117
Closed
chrisuthe wants to merge 1 commit into
Closed
Add a source capture host example and sync the documentation#117chrisuthe wants to merge 1 commit into
chrisuthe wants to merge 1 commit into
Conversation
chrisuthe
force-pushed
the
source-role/06-example-docs
branch
from
September 1, 2026 02:32
8f828e6 to
09cc38b
Compare
This file contains hidden or 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
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.
Part 6/6 of the source@v1 stack (tracker: #95).
What it adds:
examples/source_client(captures the default PortAudio input and streams it, with an Opus switch) and the documentation sync — integration guide, internals, CLAUDE.md, README.How it's used: build with examples on and run it against a Sendspin server; the README in the example folder has the details.
Note for maintainers: this also adds one clarifying sentence to
docs/conventions.md— an example that exists solely to demonstrate one role may gate its whole CMake target on that role's option (an#ifdefleaving a do-nothing binary is dead code, not a guard). Flagged here for explicit sign-off; drop it if you prefer the rule implicit.