Skip to content

ListParticipants

Source: src/AWS/IVSRealtime/ListParticipants.ts

List all participants in a session of the bound stage, optionally filtered by user id, publish state, connection state, or recording state.

// init
const listParticipants = yield* IVSRealtime.ListParticipants(stage);
// runtime
const { participants } = yield* listParticipants({
sessionId: "st-a1b2c3d4e5f6",
filterByPublished: true,
});