Add serverside livestreaming docs#115
Merged
Merged
Conversation
czerwiukk
reviewed
May 28, 2025
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| Now, you can connect peer normally to the room as described in our [React Native](/react-native/connecting) and [React](/react/connecting) docs. |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| Now, you can connect peer normally to the room as described in our [React Native](/react-native/connecting) and [React](/react/connecting) docs. | |
| Now, you can connect the peer normally to the room as described in our [React Native](/react-native/connecting) and [React](/react/connecting) docs. |
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| Now you can connect viewer to the livestream as described in our [React Native] and [React] docs. |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| Now you can connect viewer to the livestream as described in our [React Native] and [React] docs. | |
| Now you can connect the viewer to the livestream as described in our [React Native] and [React] docs. |
| Now you can connect viewer to the livestream as described in our [React Native] and [React] docs. | ||
|
|
||
| :::info | ||
| Viewers connect using [WHEP](https://blog.swmansion.com/introducing-react-native-whip-whep-ac9e5588d4da) standard, allowing the use of any player that supports the WHEP standard. |
Member
There was a problem hiding this comment.
suggestion (blocking): I would link to something different here, and specify that there is React Native whip/whep for the mobile ecosystem.
Contributor
Author
There was a problem hiding this comment.
something different... like RFC?
Member
There was a problem hiding this comment.
something like our article would be the best, but it's yet to be created :p
Member
There was a problem hiding this comment.
imo lets not waste time here and approach this incrementally
| <TabItem value="ts" label="Typescript"> | ||
|
|
||
| ```ts | ||
| // createdRoom ... previously created room |
Member
There was a problem hiding this comment.
issue (blocking): I would include the required part of the previous snippet with createdRoom init.
Contributor
Author
There was a problem hiding this comment.
It could suggest that you can do it twice, create one room for peer and another for viewer. What do you think?
|
|
||
| ### Viewers | ||
|
|
||
| To view the streamed content you need to obtain viewer token that can be generated using [Server SDKs](/production/server). |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| To view the streamed content you need to obtain viewer token that can be generated using [Server SDKs](/production/server). | |
| To view the streamed content you need to obtain a viewer token that can be generated using [Server SDKs](/production/server). |
| - Compatible with WHEP standard | ||
| <!-- * TODO: compatibility with WHIP --> | ||
|
|
||
| ## How Do I Use It? |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| ## How Do I Use It? | |
| ## How do I use it? |
| Main differences: | ||
|
|
||
| - Livestream rooms are 20% cheaper than regular rooms | ||
| - Livestream rooms allows for greater scalability |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| - Livestream rooms allows for greater scalability | |
| - Livestream rooms allow for greater scalability |
|
|
||
| # Live streaming | ||
|
|
||
| For live streaming purposes we suggest using livestream rooms specifically optimized for this use case. |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| For live streaming purposes we suggest using livestream rooms specifically optimized for this use case. | |
| For livestreaming purposes, we suggest using livestream rooms specifically optimized for this use case. |
Contributor
Author
There was a problem hiding this comment.
I think it's correct
|
|
||
| ### Streamer | ||
|
|
||
| To create a livestream room, you must set the `roomType` field to `broadcaster` when creating a room using our [Server SDKs](/production/server). Then you have to create one peer that will be used to stream your content. |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| To create a livestream room, you must set the `roomType` field to `broadcaster` when creating a room using our [Server SDKs](/production/server). Then you have to create one peer that will be used to stream your content. | |
| To create a livestream room, you must set the `roomType` field to `broadcaster` when creating a room using our [Server SDKs](/production/server). Then you have to create a peer that will be used to stream your content. |
|
|
||
| ### Viewers | ||
|
|
||
| To view the streamed content you need to obtain viewer token that can be generated using [Server SDKs](/production/server). |
Member
There was a problem hiding this comment.
nitpick (blocking):
Suggested change
| To view the streamed content you need to obtain viewer token that can be generated using [Server SDKs](/production/server). | |
| To view the streamed content, you need to obtain viewer token that can be generated using [Server SDKs](/production/server). |
Karolk99
force-pushed
the
livestreaming-docs
branch
from
f985045 to
239d2c6
Compare
Karolk99
force-pushed
the
livestreaming-docs
branch
from
19aaa5e to
e0de89e
Compare
czerwiukk
approved these changes
May 30, 2025
| Now you can connect viewer to the livestream as described in our [React Native] and [React] docs. | ||
|
|
||
| :::info | ||
| Viewers connect using [WHEP](https://blog.swmansion.com/introducing-react-native-whip-whep-ac9e5588d4da) standard, allowing the use of any player that supports the WHEP standard. |
Member
There was a problem hiding this comment.
imo lets not waste time here and approach this incrementally
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
3 participants
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.
Description
Closes FCE-1488
Adds server-side livestreaming documentation.
Things worth doing before merging this PR:
createBroadcastViewerTokentocreateLivestreamViewerTokeninjs-server-sdk