Nurama Developers
Events

Emit collab:presentation-sync

Which item the presenter is showing, and which page of it, broadcast to the other members.

client → server on the collab channel. Socket.IO event name: collab:presentation-sync.

Which item the presenter is showing, and which page of it, broadcast to the other members.

Only the current presenter socket may broadcast; other senders receive collab:presentation-sync:rejected instead and nothing is relayed. Client -> server -> all other sockets in the same namespace. The server sanitises the client payload (tracks are capped and trimmed to identity fields only — never file URLs, so each follower re-fetches the asset under its own rights), then appends the authenticated user identity (userId, displayName, color, avatarUrl), the annotationColor assigned on collab:join and a timestamp; client supplied values for those keys are overwritten. The sanitised result is cached as the namespace presentation state and replayed to late joiners on collab:presenter-state.

Payload: collab:presentation-sync

Payload of the 'collab:presentation-sync' socket event.

PropertyTypeRequiredDescription
tracksobject[]noThe presented queue, in order. Capped server-side.
currentTrackIdstring | nullnoThe track currently on screen, or null when the queue is empty.
pageinteger | nullno1-based page of a paged item (documents), or null.
pageCountinteger | nullno
userIdstringnoAuthenticated user ID (server supplied, cannot be spoofed).
displayNamestring | nullnoDisplay name (falls back to first + last name).
colorstring | nullnoThe user's profile colour.
avatarUrlstring | nullnokeyPath of the user's avatar thumbnail file, if any.
annotationColorstringnoAnnotation colour assigned to this user for the collab session.
timestampintegernoServer time in milliseconds since epoch when the event was relayed.

tracks (items)

PropertyTypeRequiredDescription
idstringnoAsset ID; the follower re-fetches the asset itself through the API.
namestringno
mediaType"image" | "video" | "audio" | "3d" | "document"no
thumbUrlstring | nullno

On this page