通話

説明

---

説明

class yaylib.api.CallApi(client)

通話 API

async get_bgms() → BgmsResponse

通話のBGMを取得する

Returns:

BgmsResponse:

async get_call(call_id: int) → ConferenceCallResponse

通話を取得する

Args:

call_id (int):

Returns:

ConferenceCallResponse:

async get_call_invitable_users(call_id: int, **params) → UsersByTimestampResponse

通話に招待可能なユーザーを取得する

Args:

call_id (int): from_timestamp (int, optional):

Returns:

UsersByTimestampResponse:

async get_call_status(opponent_id: int) → CallStatusResponse

通話の状態を取得します

Args:

opponent_id (int):

Returns:

CallStatusResponse:

async get_games(**params) → GamesResponse

通話に設定可能なゲームを取得する

Args:

number (int, optional): ids (List[int], optional): from_id (int, optional):

Returns:

GamesResponse:

async get_genres(**params) → GenresResponse

通話のジャンルを取得する

Args:

number (int, optional): from (int, optional):

Returns:

GenresResponse:

async get_group_calls(**params) → PostsResponse

サークル内の通話を取得する

Args:

number (int, optional): group_category_id (int, optional): from_timestamp (int, optional): scope (str, optional):

Returns:

PostsResponse:

async get_user_active_call(user_id: int) → PostResponse

ユーザーが参加中の通話を取得する

Args:

user_id (int):

Returns:

PostResponse:

async invite_online_followings_to_call(call_id: int, **params) → Response

オンラインの友達をまとめて通話に招待します

Args:

call_id (int, optional): group_id (str, optional):

Returns:

Response:

async invite_users_to_call(call_id: int, user_ids: List[int]) → Response

通話に複数のユーザーを招待する

Args:

call_id (int): user_ids (List[int]):

Returns:

Response:

async invite_users_to_chat_call(**params) → Response

ユーザーをチャット通話に招待する

Args:

chat_room_id (int): room_id (int): room_url (str):

Returns:

Response:

async join_call(**params) → ConferenceCallResponse

通話に参加する

Args:

conference_id (int): call_sid (str, optional):

Returns:

ConferenceCallResponse:

async join_call_as_anonymous(**params) → ConferenceCallResponse

匿名で通話に参加する

Args:

conference_id (int): agora_uid (str):

Returns:

ConferenceCallResponse:

async kick_user_from_call(call_id: int, **params) → CallActionSignatureResponse

ユーザーを通話からキックする

Args:

call_id (int): uuid (int): ban (bool):

Returns:

Response:

async leave_call(**params) → Response

通話から退出する

Args:

conference_id (int): call_sid (str, optional):

Returns:

Response:

async leave_call_as_anonymous(**params) → Response

匿名で参加した通話を退出する

Args:

conference_id (int): agora_uid (str, optional):

Returns:

Response: _description_

async set_user_role(call_id: int, user_id: int, role: str) → Response

通話の参加者に役職を付与する

Args:

call_id (int): user_id (int): role (str):

Returns:

Response:

async start_call(call_id: int, **params) → Response

通話を開始する

Args:

call_id (int): joinable_by (str): game_title (str, optional): category_id (str, optional):

Returns:

Response: