Bånder
BånderDeveloper guide
On this page

Party

The Party context implements synchronized watch-party playback. Users create a party session, invite members, and watch media together with wall-clock synchronization, jitter compensation, and WebSocket-based real-time state broadcasting.

Domain Models

Model Type Purpose
SyncedPartySession Aggregate Root Party session with host, video, members, playback state, and jitter compensation
PartyMember Model A member within a party session
MemberRole Value Object (enum) Role within a party (Host, Member)
PlaybackAction Value Object (enum) Playback command (Play, Pause, Seek)
PlaybackState Value Object (enum) Current playback state (Stopped, Playing, Paused)

State value objects SyncedPartySessionState and PartyMemberState keep constructor/create/reconstitute in sync per the project's aggregate root convention.

Domain Events

Event Purpose
PartySessionCreated Emitted when a new party is created
MemberJoined Emitted when a user joins a party
PartySessionEnded Emitted when a party is closed

Commands and Handlers

Command Handler Purpose
CreatePartySessionCommand CreatePartySessionHandler Create a new party session
JoinPartySessionCommand JoinPartySessionHandler Add a member to an existing party
LeavePartySessionCommand LeavePartySessionHandler Remove a member from a party
StartPlaybackCommand StartPlaybackHandler Begin playback for all members
PausePlaybackCommand PausePlaybackHandler Pause playback for all members
SeekPlaybackCommand SeekPlaybackHandler Seek to a specific position
SyncPlaybackCommand SyncPlaybackHandler Periodic playback state synchronization
TransferHostCommand TransferHostHandler Transfer the host role to another member
EndPartySessionCommand EndPartySessionHandler Close and end a party session

Ports

Port Purpose
PartySessionPortInterface Session lifecycle operations (create, end, query)
PartyMemberPortInterface Member operations (join, leave, role transfer)

API Endpoints

REST endpoints use /api/party/sessions. Session {uuid} parameters are UUIDs, not PublicId NanoIDs. Session resources expose both uuid and the separate 21-character publicId.

Party Sessions

Method Path Controller Purpose
GET /api/party/sessions/ PartySessionController List parties
POST /api/party/sessions/ PartySessionController Create a new party
GET /api/party/sessions/{uuid} PartySessionController Get a single party session
DELETE /api/party/sessions/{uuid} PartySessionController End a party session

Party Members

Method Path Controller Purpose
POST /api/party/sessions/{uuid}/join PartySessionController Join a party
POST /api/party/sessions/{uuid}/leave PartySessionController Leave a party
GET /api/party/sessions/{uuid}/members/ PartyMemberController List party members
PATCH /api/party/sessions/{uuid}/members/me PartyMemberController Update the current member's playback preferences
POST /api/party/sessions/{uuid}/members/transfer-host PartyMemberController Transfer the host role

Playback

Method Path Controller Purpose
POST /api/party/sessions/{uuid}/sync PartySessionController Sync playback state

WebSocket

Path Controller Purpose
GET /ws/party/{sessionPublicId}/ PartyWebSocketController HTTP lookup of session details and WebSocket connection URL

The lookup takes the session's 21-character PublicId, rather than its UUID. It sits outside the default /api OpenAPI export. Playback messages and state broadcasts use the shared WebSocket runtime, not the HTTP lookup controller.

Cross-Context Dependencies

Direction Context Relationship
Depends on Shared Uses Uuid for identifiers
Depends on Transcode References video and transcode job data
Depends on Auth User identification and authentication
Depended on by Notification Party events trigger notifications

Infrastructure

Doctrine Entities

Entity Purpose
SyncedPartySessionEntity Party session persistence
PartyMemberEntity Party member persistence
PartyEventEntity Audit log of party events

Services

Service Purpose
PartySessionService Session lifecycle management
PartyMemberService Member management
PlaybackSynchronizer Wall-clock sync with jitter compensation

The Infrastructure/Playback/ directory contains the jitter compensation and synchronization logic.

WebSocket

PartyWebSocketController returns connection information. The shared WebSocketController dispatches playback commands and broadcasts events between party members.

Read this page's source