Streams

Use Cases

Use end-to-end encrypted real-time audio, video, and screen sharing for:

• Video meetings and calls: one-to-one or group conference calls for teams and clients
• Customer support and consultations: live help-desk sessions, advisory calls, and onboarding
• Telehealth: private sessions between a doctor and a patient, or an expert and a client
• Remote education and webinars: virtual classrooms, training sessions, and broadcasts
• Screen sharing and collaboration: desktop sharing for demos, pair work, and remote assistance

Rooms

The main data unit in a Stream module is a StreamRoom, which contains:

• publicMeta: decrypted metadata available to PrivMX Bridge-side integrations
• privateMeta: encrypted metadata available only to room members (learn more about public and private metadata in PrivMX)
• users and managers: lists defining who can access and manage the room
• policy: access policy for the room

Inside a joined Stream Room, users can create and publish live Streams composed of audio, video, or desktop capture tracks.

Real-Time Media Flow

Basic Stream workflow is as follows:

1. Create or get an existing Stream Room.
2. Join the Stream Room.
3. Publish local tracks or subscribe to remote streams
4. Attach a remote track listener to render incoming media.

The module also supports updating published streams, unsubscribing from remote streams, and configuring frame handling.

Events

The Stream module exposes events for both room lifecycle and media activity, including:

• Stream Room creation, update, and deletion
• users joining and leaving streams
• stream publish, update, and unpublish actions
• remote stream availability changes

Getting Started

Prerequisites

Before working with Streams, you need to have a PrivMX Bridge instance.

To install it, follow our PrivMX quick start guide.

Using Streams

Learn how to work with Streams in your chosen language:

Read More

• find out more about Streams architecture
• read Stream module glossary