Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Players → Create A Player

AI-generated

Summary

Create a player in Infomaniak Streaming Video

Inputs

  • authentication —
  • path_channel (required) — The unique identifier (ID) of the channel to request.
  • query_account_id (required) — The account identifier
  • queryParameters —
  • body_ads_enabled (required) —
  • body_allow_full_screen (required) —
  • body_auto_hide_controls (required) —
  • body_auto_start (required) —
  • body_buffer (required) —
  • body_chromecast (required) —
  • body_control_active_color (required) — a CSS hex color string (e.g. #fff or #ffffff)
  • body_control_color (required) — a CSS hex color string (e.g. #fff or #ffffff)
  • body_controlbar_color (required) — a CSS hex color string (e.g. #fff or #ffffff)
  • body_countdown (required) —
  • body_enable_embed_code (required) —
  • body_enable_facebook (required) —
  • body_enable_twitter (required) —
  • body_extract_preload_img (required) —
  • body_facebook_player_embed (required) —
  • body_height (required) —
  • body_is360 (required) —
  • body_name (required) — a strict string (no HTML/PHP tags or HTML entities allowed)
  • body_ratio (required) —
  • body_show_controls (required) —
  • body_show_controls_during_ads (required) —
  • body_show_viewers (required) —
  • body_show_viewers_only_after (required) —
  • body_sound_enabled (required) —
  • body_sound_percentage (required) —
  • body_time_before_hide_cb (required) —
  • body_use_geo_ip_img (required) — a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL
  • body_use_interrupt_img (required) — a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL
  • body_use_preload_img (required) — a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL
  • body_use_restrict_img (required) — a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL
  • body_width (required) —
  • bodyParameters —
  • returnFullResponse —

Output shape

a created player record

If returnFullResponse is true, the full API response is returned; otherwise the operation resolves with a success status. Errors follow the standard Infomaniak error envelope.

Examples

Example 1: Create a player with basic settings

authentication: oauth2; path_channel: 123; body_name: 'My Channel'; body_ratio: '16:9'; returnFullResponse: false

Example 2: Create a player with custom colors and description

authentication: apiKey; path_channel: 456; body_control_active_color: '#00ff00'; body_control_color: '#00ff00'; body_controlbar_color: '#00ff00'; body_description: 'Demo player'; returnFullResponse: true

Links

Discussion