Skip to content

iter_list_participants

iter_list_participants(
    stage_arn: StageArn,
    session_id: StageSessionId,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    filter_by_user_id: Optional[UserId] = None,
    filter_by_published: Optional[Published] = None,
    filter_by_state: Optional[ParticipantState] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxParticipantResults] = None,
    filter_by_recording_state: Optional[
        ParticipantRecordingFilterByRecordingState
    ] = None,
) -> Iterator[ListParticipantsResponse]
Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def iter_list_participants(
    self,
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    session_id: "capo_ivs_realtime.types.stage_session_id.StageSessionId",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    filter_by_user_id: Optional["capo_ivs_realtime.types.user_id.UserId"] = None,
    filter_by_published: Optional[
        "capo_ivs_realtime.types.published.Published"
    ] = None,
    filter_by_state: Optional[
        "capo_ivs_realtime.types.participant_state.ParticipantState"
    ] = None,
    next_token: Optional[
        "capo_ivs_realtime.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_ivs_realtime.types.max_participant_results.MaxParticipantResults"
    ] = None,
    filter_by_recording_state: Optional[
        "capo_ivs_realtime.types.participant_recording_filter_by_recording_state.ParticipantRecordingFilterByRecordingState"
    ] = None,
) -> "Iterator[capo_ivs_realtime.types.list_participants_response.ListParticipantsResponse]":
    _token = next_token
    while True:
        _response = self.list_participants(
            stage_arn,
            session_id,
            config_overrides=config_overrides,
            filter_by_user_id=filter_by_user_id,
            filter_by_published=filter_by_published,
            filter_by_state=filter_by_state,
            next_token=_token,
            max_results=max_results,
            filter_by_recording_state=filter_by_recording_state,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break