allMembersRest | MediaSFU Shared

Reconciles incremental member updates, consume-domain setup, and room media settings.

Type Parameters

TParticipantSummary extends AllMembersRestParticipantLike = AllMembersRestParticipantLike
TParticipant extends AllMembersRestParticipantLike = AllMembersRestParticipantLike
TRequest extends AllMembersRestRequestLike = AllMembersRestRequestLike
TCoHostResponsibility = unknown
TConsumeSocket = unknown
TSocket = Socket<DefaultEventsMap, DefaultEventsMap>
TOnScreenChangesParameters = OnScreenChangesParameters
TConnectIpsParameters = ConnectIpsParameters
TReorderStreamsParameters = ReorderStreamsParameters<Stream, Participant, unknown>
TConnectLocalIpsParameters = ConnectLocalIpsParameters
TAllParameters = TOnScreenChangesParameters & TConnectIpsParameters & TReorderStreamsParameters & TConnectLocalIpsParameters

Parameters

options: AllMembersRestOptions<
    TParticipantSummary,
    TParticipant,
    TRequest,
    TCoHostResponsibility,
    TConsumeSocket,
    TSocket,
    TOnScreenChangesParameters,
    TConnectIpsParameters,
    TReorderStreamsParameters,
    TConnectLocalIpsParameters,
    TAllParameters,
>
Member payload, room settings, and receiver connection helpers.

Returns Promise<void>

Resolves once participant state, co-host state, and settings are synchronized.

Example

await allMembersRest({
  members,
  settings,
  coHoste,
  coHostRes,
  parameters,
  consume_sockets,
  apiUserName: 'api-user',
  apiKey: 'api-key',
  apiToken: 'api-token',
});

Function allMembersRest

Type Parameters

Parameters

Returns Promise<void>

Example

Settings