Nurama Developers
Events

Receive collab:region-create

Audio/video region created on the waveform/timeline.

server → client on the collab channel. Socket.IO event name: collab:region-create.

Audio/video region created on the waveform/timeline.

Client -> server -> all other sockets in the same /chat/{chatId} namespace. The server spreads the client payload and 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.

Payload: collab:region-create

Payload of the 'collab:region-create' socket event.

PropertyTypeRequiredDescription
regionIdstringno
startTimenumberno
endTimenumberno
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.

On this page