gamesheet_sdk.admin.games.broadcasters module¶
Broadcaster operations for games.
- gamesheet_sdk.admin.games.broadcasters.list_broadcasters(session)[source]¶
Return the list of valid broadcasters.
Fetches the current list of broadcaster services from the BFF API. The returned broadcaster keys can be used when creating or updating scheduled games.
- Parameters:
session (Session) – An authenticated
Session.- Returns:
A list of
Broadcasterobjects.- Return type:
- Raises:
AuthenticationError – If the server returns 401 or 403.
GameSheetError – For any other non-2xx response.
- gamesheet_sdk.admin.games.broadcasters.validate_broadcaster_key(session, broadcaster)[source]¶
Validate a broadcaster key and return the correctly-cased version.
Fetches the list of valid broadcasters and performs a case-insensitive match. Returns the broadcaster key with the correct casing as stored in the API.
- Parameters:
- Returns:
The correctly-cased broadcaster key.
- Return type:
- Raises:
GameSheetError – If the broadcaster key is not valid.