[DOCS]: Add documention for model classes#144
Open
Doominika wants to merge 32 commits intodocs/prepare-inline-documentation-for-streamsfrom
Open
[DOCS]: Add documention for model classes#144Doominika wants to merge 32 commits intodocs/prepare-inline-documentation-for-streamsfrom
Doominika wants to merge 32 commits intodocs/prepare-inline-documentation-for-streamsfrom
Conversation
…lasses' into docs/add-documention-for-model-classes
djenczewski
requested changes
Apr 24, 2026
|
|
||
| /** | ||
| * Indicates active speech detection on the track | ||
| */ |
| public String streamRoomId; | ||
|
|
||
| /** | ||
| * Identifier of the stream that was left |
Member
There was a problem hiding this comment.
Maybe like this:
Suggested change
| * Identifier of the stream that was left | |
| * Published stream identifier of the user who left |
Member
There was a problem hiding this comment.
Identifier of the stream that the user left?
| */ | ||
| public String lastModifier; | ||
| /** | ||
| * List of usernames with access to the stream room |
Member
There was a problem hiding this comment.
Suggested change
| * List of usernames with access to the stream room | |
| * List of user's IDs with access to the stream room |
Member
There was a problem hiding this comment.
- IDs of users with access to the stream room.
| */ | ||
| public List<String> users; | ||
| /** | ||
| * List of usernames with management privileges over the stream room |
Member
There was a problem hiding this comment.
Suggested change
| * List of usernames with management privileges over the stream room | |
| * List of user's IDs with management privileges over the stream room |
Member
There was a problem hiding this comment.
- IDs of users with management rights in the stream room.
filipg43
reviewed
Apr 24, 2026
| public String room; | ||
|
|
||
| /** | ||
| * List of newly available streams that can be subscribed to |
Member
There was a problem hiding this comment.
List of new streams that can be subscribed.
| import java.util.List; | ||
|
|
||
| /** | ||
| * Data describing the event that occurs when new streams become available for subscription in a stream room. |
Member
There was a problem hiding this comment.
Data describing event triggered when there are new streams available in stream room.
| * Constructs a new {@link NewStreams} instance. | ||
| * | ||
| * @param room Identifier of the stream room | ||
| * @param streams List of newly available streams that can be subscribed to |
Member
There was a problem hiding this comment.
List of new streams that can be subscribed.
| import java.util.List; | ||
|
|
||
| /** | ||
| * Data describing the event that occurs when a participant joins a StreamRoom. |
Member
There was a problem hiding this comment.
Data describing event that triggers when a participant joins a StreamRoom.
| import java.util.List; | ||
|
|
||
| /** | ||
| * Data describing the event that occurs when a participant leaves a StreamRoom. |
Member
There was a problem hiding this comment.
Data describing event that triggers when a user leaves a StreamRoom.
| * @param type Type of the track (e.g. "audio", "video", "data") | ||
| * @param mindex | ||
| * @param mid | ||
| * @param disabled Indicates if the track is disabled |
Member
There was a problem hiding this comment.
Whether the track is disabled.
| * @param type Type of the track (e.g. "audio", "video", "data") | ||
| * @param mindex | ||
| * @param mid | ||
| * @param disabled Indicates if the track is disabled |
Member
There was a problem hiding this comment.
Whether the track is disabled.
| * @param codec Codec used by the track (e.g. "opus", "VP8") | ||
| * @param description Description of the track | ||
| * @param moderated | ||
| * @param simulcast Indicates if simulcast is enabled for the track |
Member
There was a problem hiding this comment.
Whether simulcast is enabled for the track
| * @param type Type of the track (e.g. "audio", "video", "data") | ||
| * @param mindex | ||
| * @param mid | ||
| * @param disabled Indicates if the track is disabled |
Member
There was a problem hiding this comment.
Whether the track is disabled.
| * @param codec Codec used by the track (e.g. "opus", "VP8") | ||
| * @param description Description of the track | ||
| * @param moderated | ||
| * @param simulcast Indicates if simulcast is enabled for the track |
Member
There was a problem hiding this comment.
Whether simulcast is enabled for the track.
filipg43
reviewed
Apr 27, 2026
| /** | ||
| * Defines the types of events that can occur within the stream for which a client can subscribe. | ||
| * This enum lists the various actions or changes that can happen to | ||
| * stream rooms and their streams, allowing observers to be notified of specific occurrences. |
Member
There was a problem hiding this comment.
- Event types that clients can subscribe to within a stream room.
- Covers state changes across stream rooms and their individual streams.
Member
There was a problem hiding this comment.
or:
- Subscribable event types for stream rooms and their streams.
zurekz
approved these changes
Apr 27, 2026
filipg43
reviewed
Apr 27, 2026
| */ | ||
| EMPTY, | ||
| /** | ||
| * Type of event triggered when a participant joins a StreamRoom. |
Member
There was a problem hiding this comment.
* Type of event triggered when a user joins a StreamRoom.
| */ | ||
| STREAM_JOIN, | ||
| /** | ||
| * Type of event triggered when a participant leaves a StreamRoom. |
Member
There was a problem hiding this comment.
* Type of event triggered when a user leaves a StreamRoom.
| */ | ||
| STREAM_LEAVE, | ||
| /** | ||
| * Type of event triggered when a participant starts publishing a stream. |
Member
There was a problem hiding this comment.
* Type of event triggered when a user starts publishing a stream.
| */ | ||
| STREAM_PUBLISH, | ||
| /** | ||
| * Type of event triggered when a participant stops publishing a stream. |
Member
There was a problem hiding this comment.
* Type of event triggered when a user stops publishing a stream.
| import java.util.List; | ||
|
|
||
| /** | ||
| * Data received when a new participant joins the StreamRoom. |
Member
There was a problem hiding this comment.
- Data received when a new user joins the StreamRoom.
| /** | ||
| * Defines the types of events that can occur within the stream for which a client can subscribe. | ||
| * This enum lists the various actions or changes that can happen to | ||
| * stream rooms and their streams, allowing observers to be notified of specific occurrences. |
Member
There was a problem hiding this comment.
or:
- Subscribable event types for stream rooms and their streams.
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
4 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
Add inline documentation to the stream models.