Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Players → Return A Player

AI-generated

Summary

Return a player by specifying channel and player IDs with optional authentication and query parameters.

Inputs

  • authentication — Method of authentication to use, either OAuth2 or API Key.
  • path_channel (required) — The unique identifier (ID) of the channel to request.
  • path_player (required) — The unique identifier (ID) of the player to request.
  • query_account_id (required) — The account identifier.
  • queryParameters — Additional query parameters; optional field to load extra resource data.
  • returnFullResponse — When true, the full API response is returned; otherwise only the player object is returned.

Output shape

a player object (or full API response when returnFullResponse true)

The returned object contains the player's details; returning the full response includes headers and additional metadata.

Examples

Example 1: Retrieve a specific player within a channel using API Key authentication.

authentication=apiKey&path_channel=123&path_player=456&query_account_id=789

Example 2: Fetch a player with extra data and return the complete response.

authentication=oauth2&path_channel=1&path_player=2&query_parameters={"with":"subtitles"}&returnFullResponse=true

Links

Discussion