Release Notes

RealtimeKit Web Core 2.0.1

Fixes

• Fixed ES5 builds containing VERSION_PLACEHOLDER in the bundle instead of the actual SDK version.
• Fixed SDK initialization failure when the initial socket connection attempt failed, which also prevented plugin store creation. The SDK now retries store creation based on the socket connection state.

RealtimeKit Web Core 2.0.0

Compatibility: Works best with RealtimeKit Web UI Kit 2.0.0 or later.

This is a major breaking release. Several deprecated APIs have been removed and the plugin APIs have been completely redesigned. Review the migration guide below carefully before upgrading.

Plugin APIs complete redesign

Plugins are no longer fetched from the server automatically. You now provide plugin configurations at SDK init time via defaults.plugins.

Before (v1.x):

// plugins were loaded via API in SDK internally
const meeting = await RealtimeKitClient.init({
  authToken,
});

// Server-hosted plugins were auto-populated
const plugin = meeting.plugins.all.get(pluginId);

// Plugin rendered in an iframe managed by the SDK
plugin.addPluginView(iframeElement, 'plugin-main');

// Permissions checked via meeting.self.permissions.plugins.canStart / canClose

After (v2.0):

A plugin component is any HTMLElement. You can use a custom element, a framework component mounted to a container, or an iframe. The following example embeds a collaborative text editor as a plugin:

const editor = document.createElement('iframe');
editor.src = 'https://rustpad.io/#WKLJaD';
editor.style.width = '100%';
editor.style.height = '100%';
editor.style.border = 'none';

const meeting = await RealtimeKitClient.init({
  authToken,
  defaults: {
    plugins: [
      {
        id: 'collaborative-editor', // SDK prefixes this with {meetingId}: to create the namespaced plugin.id
        name: 'Collaborative Editor',
        icon: 'https://example.com/editor.png',
        permissions: {
          canActivate: true,
          canDeactivate: true,
        },
        component: editor,
      },
    ],
  },
});

// Plugin is registered and available
const plugin = meeting.plugins.all.get(pluginId);

// Activate  state is synced across all participants
await plugin.activate();

For a complete guide on building custom plugins, refer to Build your own plugins. If you need to record plugin content, you must build a custom recording app.

Key changes:

• New type exports: ClientPluginConfig, ClientPluginPermissions.
• Plugin id is now namespaced: the SDK prefixes your provided id with {meetingId}: to create the internal pluginId.
• Plugin activation and deactivation state is now synced via a collaborative store (__rtk_plugins__) instead of dedicated socket messages.
• Plugins now have a component property (any HTMLElement) instead of iframe-based rendering via addPluginView.
• Per-plugin permissions (plugin.permissions.canActivate / plugin.permissions.canDeactivate) replace the old global meeting.self.permissions.plugins.canStart / meeting.self.permissions.plugins.canClose.

Removed plugin APIs:

• plugin.addPluginView(iframe, viewId) pass an HTMLElement as component in ClientPluginConfig instead.
• plugin.removePluginView(viewId) handled automatically by the UI Kit.
• plugin.enable() use plugin.activate().
• plugin.disable() use plugin.deactivate().
• plugin.sendIframeEvent() removed. Communicate directly with your component.
• plugin.baseURL removed. Plugins are no longer server-hosted.
• plugin.picture use plugin.icon.
• plugin.description, plugin.organizationId, plugin.tags, plugin.type, plugin.staggered, plugin.private, plugin.published, plugin.createdAt, plugin.updatedAt removed. No longer applicable.
• plugin.config (PluginConfig) removed. No plugin manifest concept.
• meeting.self.permissions.plugins.canStart use plugin.permissions.canActivate.
• meeting.self.permissions.plugins.canClose use plugin.permissions.canDeactivate.
• modules.devTools.plugins (local dev plugin config) use defaults.plugins with a component pointing to your local element.

Removed deprecated APIs

Client:

• meeting.joinRoom() use meeting.join().
• meeting.leaveRoom() use meeting.leave().

Chat:

• meeting.chat.getMessagesByUser(userId) use meeting.chat.fetchPublicMessages() with appropriate filters.
• meeting.chat.getMessagesByType(type) use meeting.chat.fetchPublicMessages() with appropriate filters.
• meeting.chat.getMessages(timestamp, size, reversed) use meeting.chat.fetchPublicMessages() or meeting.chat.fetchPrivateMessages().
• meeting.chat.searchMessages(query, filters) use meeting.chat.fetchPublicMessages() or meeting.chat.fetchPrivateMessages().
• meeting.chat.pinned (getter) use meeting.chat.fetchPinnedMessages().

Permissions (meeting.self.permissions):

• permissions.produceVideo use permissions.canProduceVideo.
• permissions.produceAudio use permissions.canProduceAudio.
• permissions.produceScreenshare use permissions.canProduceScreenshare.
• permissions.waitingRoomType use permissions.waitingRoomBehaviour.
• permissions.canChangeParticipantRole use permissions.canChangeParticipantPermissions.
• permissions.canChangeTheme removed (always returned false).
• permissions.canPresent check individual canProduceAudio, canProduceVideo, canProduceScreenshare.
• permissions.requestProduce check individual media permissions for CAN_REQUEST values.
• permissions.acceptPresentRequests use permissions.acceptStageRequests.
• permissions.maxScreenShareCount use meeting.self.config.maxScreenShareCount.
• PermissionPreset.fromResponse() use PermissionPreset.init().
• PermissionPreset.default() use PermissionPreset.init().

Participants:

• meeting.participants.disableAudio(participantId) use meeting.participants.joined.get(participantId).disableAudio().
• meeting.participants.disableVideo(participantId) use meeting.participants.joined.get(participantId).disableVideo().
• meeting.participants.kick(participantId) call kick on the participant directly.
• participant.clientSpecificId use participant.customParticipantId.

Connected Meetings:

• meeting.connectedMeetings.supportsConnectedMeetings removed. Permission checks are now granular via meeting.self.permissions.connectedMeetings.

Enhancements

• Faster reconnection: Socket-only disconnects (where WebRTC transports remain healthy) now skip full transport re-setup. Producers are re-registered and existing consumers are remapped, significantly reducing reconnection time.
• Participants stay visible during reconnection: Participant tiles remain in the grid during a socket blip instead of disappearing and reappearing, providing a seamless experience.
• Double audio fix: Fixed an issue where other participants could hear double audio from a reconnected participant, caused by stale producers not being cleaned up.
• Socket reconnection resilience: Socket now supports up to 50 reconnection attempts with exponential backoff and jitter (up from 10), providing up to approximately four minutes of retry coverage when the internet is down.
• Store improvements: StoreManager now supports refresh(name) to re-fetch store data from the server, and reserved store names (__rtk_plugins__) are protected from user creation.

Fixes

• Fixed socket failing to reconnect if left disconnected for 30 seconds.

RealtimeKit Web Core 1.5.1

Compatibility: Works best with RealtimeKit Web UI Kit 1.2.0 or later.

Features

• Added a dedicated error code 0014 for media (WebRTC) connection failures during room join, making it easier to distinguish media failures from socket and signaling failures.

Enhancements

• Init and join failures from Client.init() and meeting.join() now surface specific error codes and descriptive messages instead of generic or stacked errors.
• Telemetry logs are now compressed using gzip when the browser supports the CompressionStream API, achieving approximately a 10:1 compression ratio. Older browsers and React Native fall back to uncompressed JSON with smaller batch sizes.

Fixes

• Fixed a regex-based issue where the Safari video middleware flag was incorrectly removed, potentially breaking video processing on Safari.
• Fixed an issue where ClientError objects were wrapped inside each other when the SDK retried failed API requests. This caused nested error messages, duplicate onError callbacks, and redundant window error events.

Removed APIs

• Removed the third-party flag service. meeting.__internals__.features is now deprecated and will be removed in a future release.

RealtimeKit Web Core 1.4.0

Compatibility: Works best with RealtimeKit Android Core 2.0.0+ and RealtimeKit iOS Core 2.0.0+.

Features

• Added meeting.__internals__.authToken to expose authentication token, enabling better integration between Web Core and UI Kit for future features and enhancements.

Fixes

• Proactively fixed an issue where participants with simulcast turned on would not be able to turn on their camera or microphone due to SDP failures in Chrome version 148+.

Enhancements

• SDK now uses *.realtime.cloudflare.com base URI internally instead of the legacy dyte.io base URI.
• Refactored error handling to properly catch and display error codes for SDK initialization failures, room join failures, and other errors.

RealtimeKit Web Core 1.3.0

Features

• Simulcast support is now available to all RealtimeKit clients. Configure it per participant in Preset via the RealtimeKit dashboard, Preset API using the config.media.video.simulcast field, or while initializing the SDK.
• Added 4K UHD video support in media production (configurable in Preset and API). Falls back to the maximum supported resolution if the camera does not support 4K.

RealtimeKit Web Core 1.2.5

Compatibility: Works best with RealtimeKit Web UI Kit 1.1.1 or later.

Enhancements

• Implemented retry limits for ICE connection failures to prevent indefinite connection attempts and improve reliability.
• Improved error handling for room join operations to provide more descriptive and actionable error messages.
• Room join errors are now thrown consistently when network connectivity is blocked by firewalls or when TURN servers are unreachable.

Fixes

• Fixed an issue in Connected Meetings where peer IDs were not regenerated when switching between rooms. Peer IDs are now correctly assigned per room session.

RealtimeKit Web Core 1.2.4

Compatibility: Works best with RealtimeKit Web UI Kit 1.1.0 or later.

New APIs

Added chat pagination support with the following methods:

• meeting.chat.fetchPinnedMessages - Fetch pinned messages from server.
• meeting.chat.fetchPublicMessages - Fetch public messages from server.
• meeting.chat.fetchPrivateMessages - Fetch private messages from server.

Enhancements

• Added JSDoc comments to all public-facing methods and classes for improved developer suggestions.
• Chat message operations (edit, delete, pin) are now available to all RealtimeKit clients without additional configuration.
• pinMessage and unpinMessage events on meeting.chat now emit reliably.
• Message pinning (meeting.chat.pin and meeting.chat.unpin) is now available to all participants.

Removed APIs

Removed non-operational chat channel APIs to streamline the RealtimeKit SDK. Meeting chat (meeting.chat) remains fully operational.

• Removed meeting.self.permissions.chatChannel.
• Removed meeting.self.permissions.chatMessage. Use meeting.self.permissions.chatPublic and meeting.self.permissions.chatPrivate instead.
• Removed meeting.chat.channels.
• Removed meeting.chat.sendMessageToChannel.
• Removed meeting.chat.markLastReadMessage.
• Removed events: channelMessageUpdate, channelCreate, and channelUpdate from meeting.chat.

API changes

• The following methods no longer accept a third optional channelId parameter:
  • meeting.chat.editTextMessage(messageId, message)
  • meeting.chat.editImageMessage(messageId, imageFile)
  • meeting.chat.editFileMessage(messageId, file)
  • meeting.chat.editMessage(messageId, messagePayload)
  • meeting.chat.deleteMessage(messageId)

Deprecations

The following methods are deprecated due to scalability limitations (limited to 1,000 recent messages):

• meeting.chat.messages - Only fetches recent messages and new messages after joining.
• meeting.chat.getMessagesByUser - Use new fetch methods for scalable message retrieval.
• meeting.chat.getMessagesByType - Use new fetch methods for scalable message retrieval.
• meeting.chat.getMessages - Use meeting.chat.fetchPublicMessages or meeting.chat.fetchPrivateMessages instead.
• meeting.chat.pinned - Use meeting.chat.fetchPinnedMessages instead.
• meeting.chat.searchMessages - Use meeting.chat.fetchPublicMessages or meeting.chat.fetchPrivateMessages instead.

Known limitations

• Pinned messages are not supported for private chats.

RealtimeKit Web Core 1.2.3

Fixes

• Fixed an issue where users who joined a meeting with audio and video disabled and then initiated tab screen sharing would experience SDP corruption upon stopping the screen share, preventing subsequent actions such as enabling audio or video.

  Error thrown:

  InvalidAccessError: Failed to execute 'setRemoteDescription' on 'RTCPeerConnection': Failed to set remote answer sdp: Failed to set remote audio description send parameters for m-section with mid='<N>'
  

• Fixed an issue where awaiting RealtimeKitClient.initMedia did not return media tracks

  Example usage:

  const media = await RealtimeKitClient.initMedia({
    video : true,
    audio: true,
  });
  
  const { videoTrack, audioTrack } = media;
  

• Fixed an issue where an undefined variable caused TypeError: Cannot read properties of undefined (reading 'getValue') in media retrieval due to a race condition.

RealtimeKit Web Core 1.2.2

Fixes

• Fixed an issue where camera switching between front and rear cameras was not working on Android devices
• Fixed device selection logic to prioritize media devices more effectively
• Added PIP support for Reactions

RealtimeKit Web Core 1.2.1

Fixes

• Resolved an issue preventing default media device selection.
• Fixed SDK bundle to include browser.js instead of incorrectly shipping index.iife.js in 1.2.0.

Enhancements

• External media devices are now prioritized over internal devices when no preferred device is set.

RealtimeKit Web Core 1.2.0

Features

• Added support for configuring simulcast via initMeeting:

  initMeeting({
    overrides: {
      simulcastConfig: {
        disable: false,
        encodings: [{ scaleResolutionDownBy: 2 }],
      },
    },
  });
  

Fixes

• Resolved an issue where remote participants' video feeds were not visible during grid pagination in certain edge cases.
• Fixed a bug preventing participants from switching microphones if the first listed microphone was non-functional.

Breaking changes

• Legacy media engine support has been removed. If your organization was created before March 1, 2025 and you are upgrading to this SDK version or later, you may experience recording issues. Contact support to migrate to the new Cloudflare SFU media engine to ensure continued recording functionality.

RealtimeKit Web Core 1.1.7

Fixes

• Prevented speaker change events from being emitted when the active speaker does not change.
• Addressed a behavioral change in microphone switching on recent versions of Google Chrome.
• Added deviceInfo logs to improve debugging capabilities for React Native.
• Fixed an issue that queued multiple media consumers for the same peer, optimizing resource usage.

RealtimeKit Web Core 1.1.6

Enhancements

• Internal changes to make debugging of media consumption issues easier and faster.

RealtimeKit Web Core 1.1.5

Fixes

• Improved React Native support for AudioActivityReporter with proper audio sampling.
• Resolved issue preventing users from creating polls.
• Fixed issue where leaving a meeting took more than 20 seconds.

RealtimeKit Web Core 1.1.4

Fixes

• Livestream feature is now available to all beta users.
• Fixed Livestream stage functionality where hosts were not consuming peer videos upon participants' stage join.
• Resolved issues with viewer joins and leaves in Livestream stage.

RealtimeKit Web Core 1.1.3

Fixes

• Fixed issue where users could not enable video mid-meeting if they joined without video initially.

RealtimeKit Web Core 1.1.2

Fixes

• Fixed edge case in large meetings where existing participants could not hear or see newly joined users.

RealtimeKit Web Core 1.1.01.1.1

Features

• Added methods to toggle self tile visibility.
• Introduced broadcast functionality across connected meetings (breakout rooms).

New API

• Broadcast messages across meetings:

  meeting.participants.broadcastMessage("<message_type>", { message: "Hi" }, {
    meetingIds: ["<connected_meeting_id>"],
  });
  

Enhancements

• Reduced time to display videos of newly joined participants when joining in bulk.
• Added support for multiple meetings on the same page in RealtimeKit Core SDK.

RealtimeKit Web Core 1.0.2

Fixes

• Enhanced error handling for media operations.
• Fixed issue where active participants with audio or video were not appearing in the active participant list.

RealtimeKit Web Core 1.0.1

Fixes

• Resolved initial setup issues with Cloudflare RealtimeKit integration.
• Fixed meeting join and media connectivity issues.
• Enhanced media track handling.

RealtimeKit Web Core 1.0.0

Features

• Initial release of Cloudflare RealtimeKit with support for group calls, webinars, livestreaming, polls, and chat.