StreamApi

Created by EndpointFactory.createStreamApi - never constructed by SDK users.

Creates a new Stream Room in the given Context and returns the new Stream Room's ID. A random 256-bit room key is generated client-side and encrypted separately for each listed user with ECIES using their public key - the server stores only the encrypted per-user key entries and cannot read the key. privateMeta is encrypted client-side with the room key; publicMeta is stored unencrypted on the server. Entry point of the publish/receive workflows: follow with joinStreamRoom before creating or subscribing to streams. Adjust members or metadata later with updateStreamRoom.

Params

Replaces the member lists, metadata and (optionally) the encryption key of an existing Stream Room. The room key list is re-encrypted for the new user set (ECIES on each user's public key). With forceGenerateNewKey a fresh room key is generated and redistributed, so removed users cannot decrypt media or data sent after the update. The update is a full replacement, not a diff - fetch the current state with getStreamRoom, modify it, and pass the Stream Room's version back so concurrent modifications are detected. Set forceGenerateNewKey whenever you remove users.

Params

Lists the Stream Rooms of a Context that the user is a member of, one page at a time. Downloads the Stream Room records from the Bridge and decrypts each privateMeta client-side with the corresponding room key. Typically the first StreamApi call after connecting - pick a Stream Room from the result and enter it with joinStreamRoom.

Params

Joins a Stream Room so this connection can publish or receive its streams. Establishes the room's encrypted Event channel over the Bridge, through which the room key and per-stream keys are synchronized to this client. Required before createStream / publishStream on the publish path and before createSubscriberStream on the receive path; leave the room with leaveStreamRoom.

Params

Leaves a Stream Room, tearing down this connection's membership of its Event channel. The client stops receiving the room's key updates and events; any published streams should be stopped first with unpublishStream. Last step of the publish workflow after unpublishStream; rejoin later with joinStreamRoom.

Params

Fetches a single Stream Room with its metadata, member lists and version. Downloads the Stream Room record from the Bridge and decrypts privateMeta client-side with the user's copy of the room key; publicMeta arrives as stored, unencrypted. Use it to display Stream Room details or to obtain the current version required by updateStreamRoom.

Params

Permanently deletes a Stream Room together with its encrypted key entries. The server removes the Stream Room record and its encrypted per-user key entries - there is no undo. Requires management rights to the Stream Room (see the managers list of createStreamRoom / updateStreamRoom). To merely revoke access, keep the room and remove users with updateStreamRoom instead.

Params

Creates a local Stream handle for publishing media or data in the given Stream Room and returns the handle. Only a local, in-memory Stream entry is created - nothing reaches the server or peers yet. Stage tracks with addStreamTrack / removeStreamTrack, then push the changes with publishStream / updateStream. Follows joinStreamRoom on the publish path; next call addStreamTrack per track and finally publishStream.

Params

Lists the streams currently published by all members in the given Stream Room. Fetches the room's live stream roster from the Bridge - these are remote streams produced by published peers, not the local handles created with createStream. Use it to discover which remote streams exist before selecting some to receive with createSubscriberStream.

Params

Lists the participants of the given Stream Room, along with the stream subscriptions each of them currently has and, if they are publishing, the descriptor of their published stream.

Params

Stages a media track (or data channel) on a local Stream handle and returns its track ID. The track is recorded only in an in-memory map - it reaches the server and peers, and starts being AES-256-GCM encrypted in the E2EE worker, only after publishStream (or updateStream for an already-published stream). Call once per track between createStream and publishStream; pass createDataChannel to stage a data channel whose ID is later used with sendData.

Params

Marks a previously staged media track for removal from a Stream handle. The matching track is only flagged in the in-memory map; the removal reaches peers when updateStream renegotiates the published stream (or it is simply dropped before the first publishStream). Use it to drop a track from a stream; apply the change with updateStream for an already-published stream.

Params

Publishes the Stream with its currently staged tracks, making it visible to other Stream Room members. Fetches per-publish TURN credentials, negotiates an outbound WebRTC peer connection with the Bridge's Janus media server, and wires the E2EE worker into the RTCRtpSender pipeline so every outgoing media frame is AES-256-GCM encrypted (with the frame header as additional authenticated data). Only tracks staged via addStreamTrack are sent. Core call of the publish workflow after createStream and addStreamTrack; stage further track changes and apply them with updateStream, stop publishing with unpublishStream, and send data-channel bytes with sendData.

Params

Applies staged track additions and removals to an already-published Stream. Refreshes the TURN credentials and renegotiates the existing WebRTC peer connection, adding senders for newly staged tracks and removing the ones flagged by removeStreamTrack; the E2EE worker keeps encrypting outgoing frames with AES-256-GCM across the renegotiation. Call after staging more addStreamTrack / removeStreamTrack changes on a stream already sent with publishStream.

Params

Stops publishing the Stream and tears down its outbound peer connection. Notifies the Bridge to drop the stream, closes the sender RTCPeerConnection, and discards the handle's staged tracks and state - the stream stops being visible to other members. Follows publishStream when you are done streaming; leave the room afterwards with leaveStreamRoom.

Params

Creates a subscriber stream that receives the selected remote streams (and optionally specific tracks) in the Stream Room, and returns its handle. Fetches TURN credentials and negotiates an inbound WebRTC peer connection with the Janus media server for the chosen streams; incoming media frames are decrypted with AES-256-GCM in the E2EE worker wired into the RTCRtpReceiver pipeline. The returned SubscriberStreamHandle identifies this subscriber stream for later updateSubscriberStream / removeSubscriberStream calls. Entry point of the receive workflow after joinStreamRoom; register a callback with addRemoteStreamListener to obtain the arriving tracks, then adjust the set with updateSubscriberStream or tear it down with removeSubscriberStream.

Params

Adds and removes subscriptions on an existing subscriber stream in one call, without recreating it from scratch. Tells the Bridge to start delivering the added streams and stop the removed ones over the subscriber stream's existing inbound peer connection; the E2EE worker continues decrypting frames for the streams that remain subscribed. Use it to adjust the set established by createSubscriberStream (e.g. follow the active speaker); to tear the whole subscriber stream down use removeSubscriberStream.

Params

Removes a subscriber stream, stopping delivery of all the remote streams it received. Tells the Bridge to drop the subscriber stream; its inbound tracks end and the E2EE worker stops decrypting their frames. The inbound peer connection is torn down by the WebRTC layer when the last subscriber stream in the room is removed. Use it to stop receiving streams created via createSubscriberStream; to change rather than drop the set, prefer updateSubscriberStream.

Params

Registers a callback that fires when a subscribed remote track arrives in the Stream Room. The listener is invoked from the inbound RTCPeerConnection's track event after the E2EE worker has been wired in to decrypt the stream's frames; the delivered MediaStreamTrack already carries decrypted media. Register it on the receive path, normally right after createSubscriberStream, so the tracks selected there surface through onRemoteStreamTrack.

Params

Subscribes this connection to Stream Room events matching the given subscription queries. Registers the subscriptions on the Bridge over the connection's event channel; matching events are then pushed by the server and surface through EndpointFactory.getEventQueue(). Required order: buildSubscriptionQuery (one query per event-type/selector pair) → subscribeFor(queries) → consume events from the event queue → unsubscribeFrom when no longer needed.

Params

Cancels Stream Room event subscriptions previously created on this connection, so the server stops pushing the matching events. Subscriptions also end implicitly when the connection is closed; call this only to stop receiving a subset of events while keeping the connection alive.

Params

Builds a subscription-query string describing one class of Stream Room events (e.g. "all stream events in Stream Room X"). The query is assembled locally by the WASM core in the server's expected format - nothing is sent yet; pass the result to subscribeFor to activate it.

Params

Reads the current audio-level statistics for the session's local and remote audio. Your local mic is measured directly from its track (a consistent reading in every browser); remote levels come from native WebRTC statistics, so a remote stream is simply omitted when the browser or SFU exposes no level for it. Pull-based, not a subscription: each call does one fresh read and returns immediately. Poll it on whatever interval suits your UI (e.g. every 200-500ms) to drive speaking indicators or volume meters; call it once the session is established via publishStream or createSubscriberStream. Each entry in levels is identified by streamId: your own local microphone is reported under streamId === -1, and each remote publisher under its own (non-negative) stream ID from listStreams. A stream only appears once it has reported a level, and drops out after prolonged silence - so the local entry is absent in a subscribe-only session and may briefly disappear between utterances; treat a missing entry as "not speaking." Per entry, emaRms is the smoothed level in dBFS (roughly -70 when quiet up to ~0 when loud) and activeUntil is the timestamp until which the stream counts as actively speaking (compare it against Date.now()).

Tunes the active-speaker detection used by readAudioStats - pass any subset of the fields; omitted ones keep their current value. Takes effect immediately, from the next readAudioStats call.

Params

Sends binary data to remote participants over a published Stream's WebRTC data channel. The bytes are encrypted natively by StreamApiLow into a sequenced wire frame and sent over the data channel; the sequence number strictly increases per data track for replay protection. Requires a data track staged with createDataChannel via addStreamTrack and a stream already sent with publishStream.

Params