[DOCS]: Prepare inline documentation for streams#133
Open
Doominika wants to merge 60 commits intoandroid-stream-api-testingfrom
Open
[DOCS]: Prepare inline documentation for streams#133Doominika wants to merge 60 commits intoandroid-stream-api-testingfrom
Doominika wants to merge 60 commits intoandroid-stream-api-testingfrom
Conversation
…Subscriptions method
…amsSubscriptions method
…modifyRemoteStreamsSubscriptions method
…subscribeToRemoteStreams method
…moteStreamsSubscriptions method
…ionStateObserver method
…eToRemoteStreams method
…aram' into docs/prepare-inline-documentation-for-streams
…oRemoteStreams method
…teStreamsSubscriptions method
…tory class and its methods
Doominika
changed the title
djenczewski
requested changes
Apr 10, 2026
Member
djenczewski
left a comment
djenczewski
left a comment
There was a problem hiding this comment.
Add information to all methods about exceptions like PrivmxException and NativeException.
… docs/prepare-inline-documentation-for-streams # Conflicts: # privmx-endpoint-streams/android/src/main/java/com/simplito/java/privmx_endpoint/modules/stream/StreamApi.java
… package for internal classes (#142)
djenczewski
requested changes
Apr 24, 2026
Comment on lines
+498
to
+499
| * Subscribes to selected remote streams in a StreamRoom. | ||
| * Individual tracks within a stream can also be selected for subscription. |
Member
There was a problem hiding this comment.
Suggested change
| * Subscribes to selected remote streams in a StreamRoom. | |
| * Individual tracks within a stream can also be selected for subscription. | |
| * Subscribes to selected remote streams or tracks in a StreamRoom. |
filipg43
reviewed
Apr 27, 2026
| private final PeerConnectionManager pcManager; | ||
|
|
||
| /** | ||
| * Factory which provides helpers for creating WebRTC media sources and tracks. |
Member
There was a problem hiding this comment.
Factory providing helpers for creating WebRTC media sources and tracks.
| } | ||
|
|
||
| /** | ||
| * Creates a new StreamRoom within the speci fvfied Context. |
Member
There was a problem hiding this comment.
Creates a new StreamRoom within the specified Context.
| } | ||
|
|
||
| /** | ||
| * Registers an observer to receive ICE connection state changes for the given StreamRoom. |
Member
There was a problem hiding this comment.
Registers an observer to receive stream state changes for the given StreamRoom.
| * | ||
| * @param roomId ID of the StreamRoom | ||
| * @param observer callback receiving {@link PeerConnection.IceConnectionState} values | ||
| * @throws IllegalStateException thrown when no active session exists for the given room. |
Member
There was a problem hiding this comment.
thrown when there is no active session in the given stream room
| * @throws IllegalStateException when Stream with this StreamHandle doesn't exist. | ||
| * Removes a media track from a stream. | ||
| * After removing tracks, call {@link #updateStream(StreamHandle)} to propagate | ||
| * the change to other participants. |
Member
There was a problem hiding this comment.
* Removes a media track from a stream.
* After removing tracks, call {@link #updateStream(StreamHandle)} to propagate
* the change to other users.
| * | ||
| * @param streamHandle handle returned by {@link #createStream(String)} | ||
| * @return result of the update operation containing updated stream information | ||
| * @throws IllegalStateException thrown when no stream exists for the given handle. |
Member
There was a problem hiding this comment.
thrown when there is no stream with the given handle.
| * | ||
| * @param streamHandle handle returned by {@link #createStream(String)} | ||
| * @param track {@link VideoTrack} or {@link AudioTrack} to remove | ||
| * @throws IllegalStateException thrown when Stream with this StreamHandle doesn't exist. |
Member
There was a problem hiding this comment.
thrown when there is no stream with the given handle.
| * @param roomId ID of the StreamRoom | ||
| * @param observer observer implementation receiving track callbacks | ||
| * @param streamId ID of a specific remote stream to observe, or {@code null} for all streams in the given StreamRoom. | ||
| * @throws IllegalStateException thrown when no active session exists for the given room. |
Member
There was a problem hiding this comment.
thrown when there is no active session in the given stream room.
|
|
||
| /** | ||
| * Generates a subscription query string for events for the StreamRoom | ||
| * as well as its individual streams. |
Member
There was a problem hiding this comment.
- Generates a subscription query string for StreamRoom events and its individual streams.
| * Factory for creating WebRTC media sources and tracks. | ||
| * Provides methods for creating the audio and video objects needed | ||
| * to publish a stream via {@link StreamApi}. | ||
| * You do not create instances of this class directly — obtain the shared instance |
Member
There was a problem hiding this comment.
- Don't create instances of this class directly - ...
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
Prepare inline documentation for StreamApi based on PrivMX Endpoint StreamApi docs.