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

Documentation #36

Open
ghost opened this issue Dec 4, 2018 · 19 comments · May be fixed by #607
Open

Documentation #36

ghost opened this issue Dec 4, 2018 · 19 comments · May be fixed by #607
Assignees
Projects

Comments

@ghost
Copy link

ghost commented Dec 4, 2018

without documentation It makes it difficult to work with it

At least one of the methods is a documentary, such as the sound of the camera switch between two cameras and set the default camera setting or send a message

@cloudwebrtc
Copy link
Member

cloudwebrtc commented Dec 5, 2018

Thanks for your suggestion. we currently focusing on the main feature development, and will add the documentation later.

@deep01code
Copy link

thanks for the great work, I just would like to see at least some comments in the demo project where I can understand how things work.

@progge-sol
Copy link

+1

@pickledbrill
Copy link

is the documentation still work in progress? It's kinda hard to follow the demo project to do the implementation.

@Doetheman
Copy link

I can document your work if we sit down and chat what each method does lol It is very hard to assist or use this project for my team project.

@coder-with-a-bushido
Copy link

+1

@the-thirteenth-fox
Copy link

+1

@cloudwebrtc cloudwebrtc added this to To Do: in V1.0 Oct 18, 2020
@stale
Copy link

stale bot commented Feb 7, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Feb 7, 2021
@stale stale bot closed this as completed Feb 14, 2021
V1.0 automation moved this from To Do: to Done Feb 14, 2021
@0ttik
Copy link

0ttik commented Mar 5, 2021

+1

@cloudwebrtc cloudwebrtc reopened this Mar 5, 2021
@stale stale bot removed the wontfix label Mar 5, 2021
@akashrajkn
Copy link

Thank you for the library :)

Are there plans to document this repo?
I could follow some of it using the flutter-webrtc-demo . But it is quite time consuming. It would really go a long way if you provide some documentation.

@aryanvikash
Copy link

+1

@ShohidulProgrammer
Copy link

Thanks for your suggestion. we currently focusing on the main feature development, and will add the documentation later.

you can make a video tutorial on youtube.

@cloudwebrtc
Copy link
Member

#607 WIP

@cloudwebrtc cloudwebrtc linked a pull request Jun 24, 2021 that will close this issue
@malaxmimdkm
Copy link

malaxmimdkm commented Jul 31, 2021

Thanks for your suggestion. we currently focusing on the main feature development, and will add the documentation later.

@cloudwebrtc
Please add docs and add new features in Future, if developers don't know how to use Flutter WebRTC, There is no benefit in add new features,

Please add Documentation

@temaivanoff
Copy link

2021

@cloudwebrtc
Copy link
Member

The new docs repo:
https://github.com/flutter-webrtc/docs

Page preview:
https://flutter-webrtc.netlify.app/

@Arjunraj-k
Copy link

Any update on documentation?, Its really hard to understand and implement without proper documentation. Almost all examples are of just making a video call work, how about handling errors or states ? how about switching cameras, audio devices, muting etc? can we handle call waiting?. Im clueless here, can anyone help?

@jakobleck
Copy link

Agree that this is still an important issue. Because it implements the same WebRTC specifications, functionality can be very much the same in other languages/implementations, thus the doc https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API can be a highly useful resource.
Nevertheless, documentation for the flutter package itself, especially (but clearly not exclusively) where it does not agree with other common implementations, is urgently needed!

@hoang99tm
Copy link

Please add documents about features of the package. I found docs of the feature but I didn't receive more info except name of the package.

@cloudwebrtc cloudwebrtc unpinned this issue Mar 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
V1.0
  
Done
Development

Successfully merging a pull request may close this issue.