Skip to content
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.

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

Add standalone examples #23

Open
gavv opened this issue Jun 8, 2020 · 0 comments
Open

Add standalone examples #23

gavv opened this issue Jun 8, 2020 · 0 comments
Labels
examples Improvements or additions to usage examples good first issue Good for newcomers help wanted Contributions are welcome

Comments

@gavv
Copy link
Member

gavv commented Jun 8, 2020

We have "Quick start" section in README which shows how to use sender and receiver.

In addition, we also should add a few complete stand-alone examples, which can be compiled to executables and run from command-line.

We can start with implementing two examples:

  • Sender. A tool that generates a sine wave and sends it to remote Roc receiver.
  • Receiver. A tool that receives sound from remote sender and plays it to speakers using some sound library.

We already have a similar example for the C API: https://roc-streaming.org/toolkit/docs/api/examples.html

The C API is documented here: https://roc-streaming.org/toolkit/docs/api/reference.html
The Go bindings to it are documented here: https://pkg.go.dev/github.com/roc-streaming/roc-go/roc

The file e2e_test.go and "Quick start" section in README provide almost all the code needed for these examples, except generating sine wave and playing sound. For playing sound, we should use some cross-platform go library with simple API that would not complicate example too much.

The code of examples should be well commented and explain each step. Comments can be mostly adopted from the C examples linked above. We should also add a section to README describing what examples we have and how to run them.

@gavv gavv added the documentation Improvements or additions to documentation label Jun 8, 2020
@gavv gavv added enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Contributions are welcome labels Sep 28, 2020
@gavv gavv mentioned this issue Sep 28, 2020
8 tasks
@gavv gavv removed the hacktoberfest label Dec 3, 2020
@gavv gavv added dismissed Decided not to fix the issue for some reason examples Improvements or additions to usage examples and removed documentation Improvements or additions to documentation dismissed Decided not to fix the issue for some reason enhancement New feature or request labels May 23, 2023
@gavv gavv pinned this issue Sep 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Improvements or additions to usage examples good first issue Good for newcomers help wanted Contributions are welcome
Projects
None yet
Development

No branches or pull requests

1 participant