Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Players → Update A Player

AI-generated

Summary

Updates an existing Infomaniak streaming player configuration.

Inputs

  • authentication (required) — OAuth2 or API Key authentication method.
  • path_channel (required) — The unique identifier (ID) of the channel.
  • path_player (required) — The unique identifier (ID) of the player to update.
  • query_account_id (required) — The account identifier.
  • queryParameters — Additional query parameters to include in the request.
  • body_ads_enabled (required) — Enable or disable ads for the player.
  • body_allow_full_screen (required) — Allow the player to go full screen.
  • body_auto_hide_controls (required) — Automatically hide playback controls.
  • body_auto_start (required) — Start playback automatically when the player loads.
  • body_buffer (required) — Buffer duration in seconds.
  • body_chromecast (required) — Enable Chromecast support.
  • body_control_active_color (required) — CSS hex color for active control elements (e.g. #fff).
  • body_control_color (required) — CSS hex color for standard control elements (e.g. #fff).
  • body_controlbar_color (required) — CSS hex color for the control bar (e.g. #fff).
  • body_countdown (required) — Enable a countdown timer before playback starts.
  • body_enable_embed_code (required) — Enable the embed code for the player.
  • body_enable_facebook (required) — Enable Facebook sharing options.
  • body_enable_twitter (required) — Enable Twitter sharing options.
  • body_extract_preload_img (required) — Extract and use a preload image.
  • body_facebook_player_embed (required) — Enable Facebook-specific player embedding.
  • body_height (required) — The height of the player in pixels.
  • body_is360 (required) — Enable 360-degree video playback.
  • body_name (required) — The name of the player (no HTML/PHP tags allowed).
  • body_ratio (required) — Video aspect ratio (16:9, 4:3, or custom).
  • body_show_controls (required) — Show playback controls.
  • body_show_controls_during_ads (required) — Show controls during ad playback.
  • body_show_viewers (required) — Show the number of current viewers.
  • body_show_viewers_only_after (required) — Show viewer count only after a specified time.
  • body_sound_enabled (required) — Enable audio output.
  • body_sound_percentage (required) — Default sound volume percentage.
  • body_time_before_hide_cb (required) — Time in seconds before the control bar hides.
  • body_use_geo_ip_img (required) — Use a Geo IP detection image.
  • body_use_interrupt_img (required) — Use an interrupt (pause) image.
  • body_use_preload_img (required) — Use a preload image.
  • body_use_restrict_img (required) — Use a restricted access image.
  • body_width (required) — The width of the player in pixels.
  • bodyParameters — Additional body fields for advanced configuration (e.g. ads URL, description, logos).
  • returnFullResponse — Return the full API response object instead of just the data.

Output shape

A single item (if returnFullResponse is false) or the full API response (if true).

The operation modifies an existing player resource on the Infomaniak platform.

Examples

Example 1: Update an existing player to enable auto-start and set a 16:9 aspect ratio.

Set body_auto_start to true, body_ratio to '16:9', and set required IDs (path_channel, path_player, query_account_id).

Example 2: Add a custom logo to a player using a Base64 image.

Set body_logo_img to a Base64 string, body_show_logo to true, and configure body_logo_anchor and body_logo_margin_*.

Links

Discussion