This repository has been archived by the owner on Aug 30, 2024. It is now read-only.
Re-do read me structure #18
Merged
Conversation
This file contains 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
tommydolby
approved these changes
Jun 8, 2023
|
|
||
| Please see [the events package readme](./events/README.md) for information on how to run the app locally. | ||
| The following steps will quickly get you started testing the Dolby.io Communications APIs capabilities. |
There was a problem hiding this comment.
Don't this need line IMO
|
|
||
| As you browse through the source code and documents, you might come across some of these terms | ||
|
|
||
| * **A host** is a participant with additional permissions to manage the conference and other participants. |
There was a problem hiding this comment.
While technically true, I think it'd be more useful to describe the actions a host can do such as send/receive audio/video, screen sharing, starting the stream etc.
Also, should we replace usages of "conference" with "event"?
There was a problem hiding this comment.
I mean you're right - I copied them from our solutions guide. Let me amend them
|
|
||
| * **A host** is a participant with additional permissions to manage the conference and other participants. | ||
| * **A viewer** is a participant who can only receive video and audio stream from the conference. | ||
| * A **proxy-app-server** is an intermediary API server that communicates with the Dolby.io Communications Platform in order to provide functionality such as RTS/RTMP/HLS streaming or consuming web-hook data. You can see our sample implementation [here](./backend). |
There was a problem hiding this comment.
proxy-app-server - do we actually use this exact term (hyphens included) anywhere?
There was a problem hiding this comment.
Nope, I've unhyphenated it. We do refer to Proxy App Server a fair bit.
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Co-authored-by: tommydolby <125934604+tommydolby@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.