Clarify <endPoint> and <streamName> usage, improve guidance and style #34
Conversation
jobl
commented
Jun 21, 2025
jobl
commented
- Rewrote sections explaining how to specify and
- Added clearer examples for both hostname and full URL use cases
- Restyled to use GitHub-flavored Markdown for better rendering
- Enhanced readability and consistency across the documentation
…ance and style - Rewrote sections explaining how to specify <endPoint> and <streamName> - Added clearer examples for both hostname and full URL use cases - Restyled to use GitHub-flavored Markdown for better rendering - Enhanced readability and consistency across the documentation
There was a problem hiding this comment.
I think it's better now. We could even go simpler by removing the streamName and iceServer fields, which would make clear that those fields are optional :
streamName: <streamName>,
iceServer: {
urls: ['turn:' + <endPoint> + ':3478?transport=tcp', 'turn:' + <endPoint> + ':3478'],
username: 'ceeblue', credential: 'ceeblue'
}If we want to, we can remove the 4 lines, then say that alternatively the user can :
- Use the
<host>+<streamName>format (which must be extracted from the URL), - Add the
iceServerfield.
Yes, I've re-thought it only on And then for player part, show how pass the |
| > - Relaying adds latency. | ||
| > - TURN over TCP/TLS doesn’t handle congested networks well, video can freeze or slow down. | ||
| > | ||
| > Use TURN wisely, it should be your last resort. |
There was a problem hiding this comment.
I have a doubt regarding this because TURN is enabled by default, maybe we could explain it
| > See the type `Params` in the file [Connect.ts from web-utils](https://github.com/CeeblueTV/web-utils/blob/main/src/Connect.ts) for more details about the parameters of connection. | ||
| > [!IMPORTANT] | ||
| > | ||
| > Given this URL: `wss://example.com/webrtc/in+aa3221a5-a715-4215-9e9d-711f2c9cfc45`\ |
There was a problem hiding this comment.
Is it ok to expose the Ceeblue stream ID format?
