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

C API example outdated #267

Closed
lars18th opened this issue Feb 2, 2018 · 5 comments
Closed

C API example outdated #267

lars18th opened this issue Feb 2, 2018 · 5 comments
Milestone

Comments

@lars18th
Copy link
Contributor

lars18th commented Feb 2, 2018

Hi,

I like to start to include the srt library in one C project. So, I'm checking the apps/testcapi.c example. However, this file is outdated. It doesn't compile. I can prepare a simple patch for fix the compilation; however it still doesn't run (because a crash dump).

My suggestion, if you agree, it's this:

  • Create a new directory examples for put in it C and C++ API examples.
  • Move the apps/testcapi.c to examples/testcapi.c and add a simple build script and a readme.
  • Upgrade the example to a more detailed source. For example, using the proposed Test C API server #21
  • Add to the compilation of the package the testing of these examples, but only for checks linking to the libsrt.so/a (remove after end).
  • Improve the documentation about how to use the library in C and C++ projects.

What you think?

@ethouris
Copy link
Collaborator

ethouris commented Feb 2, 2018

I'm currently working on that and yes, that's a correct suggestion. I think there will be also more examples, some simple programs that users can play with.

@ethouris
Copy link
Collaborator

ethouris commented Feb 8, 2018

#270 Is provided with fixes in the testapi.c file; it's also moved to "examples" directory.

Test for linking should be well enough done when linking the official applications.

The documentation should be provided in docs/API.md file.

@lars18th
Copy link
Contributor Author

lars18th commented Feb 9, 2018

Hi @ethouris ,

Good work! However, some conflicts exist. I do a comment in the PR regarding lost changes in the movement of source files. #270 (comment)

I'll review in more detail in the next days.

@lars18th
Copy link
Contributor Author

The update it's in the PR #276

@maxsharabayko
Copy link
Collaborator

Closed with PR #276 merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants