Function allMembers

allMembers<
    TParticipantSummary extends
        AllMembersParticipantLike = AllMembersParticipantLike,
    TParticipant extends AllMembersParticipantLike = AllMembersParticipantLike,
    TRequest extends AllMembersRequestLike = AllMembersRequestLike,
    TCoHostResponsibility = unknown,
    TWaitingRoomParticipant = unknown,
    TConsumeSocket = unknown,
    TSocket = Socket<DefaultEventsMap, DefaultEventsMap>,
    TOnScreenChangesParameters = OnScreenChangesParameters,
    TConnectIpsParameters = ConnectIpsParameters,
    TConnectLocalIpsParameters = ConnectLocalIpsParameters,
    TReorderStreamsParameters = ReorderStreamsParameters<
        Stream,
        Participant,
        unknown,
    >,
    TAllParameters = TOnScreenChangesParameters & TConnectIpsParameters & TConnectLocalIpsParameters & TReorderStreamsParameters,
>(
    options: AllMembersOptions<
        TParticipantSummary,
        TParticipant,
        TRequest,
        TCoHostResponsibility,
        TWaitingRoomParticipant,
        TConsumeSocket,
        TSocket,
        TOnScreenChangesParameters,
        TConnectIpsParameters,
        TConnectLocalIpsParameters,
        TReorderStreamsParameters,
        TAllParameters,
    >,
): Promise<void>
Reconciles the authoritative member list with local UI state and receiver-domain setup.
Type Parameters
- TParticipantSummary extends AllMembersParticipantLike = AllMembersParticipantLike
- TParticipant extends AllMembersParticipantLike = AllMembersParticipantLike
- TRequest extends AllMembersRequestLike = AllMembersRequestLike
- TCoHostResponsibility = unknown
- TWaitingRoomParticipant = unknown
- TConsumeSocket = unknown
- TSocket = Socket<DefaultEventsMap, DefaultEventsMap>
- TOnScreenChangesParameters = OnScreenChangesParameters
- TConnectIpsParameters = ConnectIpsParameters
- TConnectLocalIpsParameters = ConnectLocalIpsParameters
- TReorderStreamsParameters = ReorderStreamsParameters<Stream, Participant, unknown>
- TAllParameters = TOnScreenChangesParameters & TConnectIpsParameters & TConnectLocalIpsParameters & TReorderStreamsParameters
Parameters
- options: AllMembersOptions<
      TParticipantSummary,
      TParticipant,
      TRequest,
      TCoHostResponsibility,
      TWaitingRoomParticipant,
      TConsumeSocket,
      TSocket,
      TOnScreenChangesParameters,
      TConnectIpsParameters,
      TConnectLocalIpsParameters,
      TReorderStreamsParameters,
      TAllParameters,
  >
  Member payload, host metadata, and receiver connection helpers.
Returns Promise<void>
Resolves once participant state, requests, and receiver sockets are synchronized.
Example
```
await allMembers({
  members,
  requestss,
  coHoste: 'host-2',
  coHostRes,
  parameters,
  consume_sockets,
  apiUserName: 'api-user',
  apiKey: 'api-key',
  apiToken: 'api-token',
});
```
- Defined in methods/socketReceive/allMembers.ts:259

Function allMembers

Type Parameters

Parameters

Returns Promise<void>

Example

Settings