Skip to content

feat(realtimekit): add mobile platforms for building your own UI#29476

Open
thisisamank wants to merge 1 commit intoproductionfrom
ak/build-your-own-ui
Open

feat(realtimekit): add mobile platforms for building your own UI#29476
thisisamank wants to merge 1 commit intoproductionfrom
ak/build-your-own-ui

Conversation

@thisisamank
Copy link
Copy Markdown
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions
Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/realtime/ @cloudflare/pcx-technical-writing, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare

Copy link
Copy Markdown
Contributor

@harshs-dyte harshs-dyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, small nits.

Comment on lines 812 to +820
:::note
You must include `rtk-notifications`, `rtk-participants-audio`, and `rtk-dialog-manager`. If you leave them out, features like settings toggles and notifications won’t work, and you won’t hear other participants in the session.
The `RtkEventSelfListener` class provides observer methods for building reactive custom UIs:

- `observeSelfVideo(update:)` — video state changes
- `observeSelfAudio(update:)` — microphone state changes
- `observeSelfRemoved(update:)` — participant removed from meeting
- `observeSelfMeetingEndForAll(update:)` — meeting ended for all participants
- `observeMeetingReconnectionState(update:)` — reconnection state changes
:::
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this belongs in a note, seems inconsistent with the content put in this position for other platforms. Maybe just skip it?

Comment on lines +1230 to 1232
:::caution
When building without `RtkMeeting`, you must manage state transitions yourself. Listen for `roomJoined`, `roomLeft`, and socket events on the meeting object, and call `setStates` to update `storeStates.meeting` between `idle`, `setup`, `waiting`, `joined`, and `ended`.
:::
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be moved up to a more prominent location? This is important information buried at the bottom of a table which will not get enough eyeballs IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants