Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Option > Simulcast → Return Simulcast

AI-generated

Summary

Create or update a simulcast channel and return its configuration.

Inputs

  • authentication — Method of authentication (OAuth2 or API Key).
  • path_channel (required) — The unique identifier (ID) of the channel to request.
  • path_simulcast_platform (required) — The simulcast platform to use (e.g., youtube, facebook).
  • query_account_id (required) — The account identifier.
  • body_additional_config (required) — Additional configuration for the simulcast request.
  • body_application_instance (required) — A simple string identifier for the target platform (weak validation).
  • body_application_name (required) — Protocol name (e.g., rtmp, sip).
  • body_enabled (required) — Enable or disable the simulcast.
  • body_name (required) — Name of the simulcast.
  • returnFullResponse — When true, the full response payload is returned; otherwise only success/failure is indicated.

Output shape

a simulcast object representing the created or updated channel

Fields reflect the supplied configuration; may include additional server‑generated attributes.

Examples

Example 1: Create a YouTube simulcast for channel ID 12345

Authentication: API Key; path_channel: 12345; path_simulcast_platform: youtube; query_account_id: 10; body_additional_config: {}; body_application_instance: youtube; body_application_name: rtmp; body_enabled: true; body_name: live; returnFullResponse: true

Example 2: Enable a Facebook simulcast with custom timeout

Authentication: OAuth2; path_channel: 6789; path_simulcast_platform: facebook; query_account_id: 5; body_additional_config: {"timeout":30}; body_application_instance: facebook; body_application_name: api; body_enabled: true; body_name: fb-live; returnFullResponse: false

Example 3: Disable an existing simulcast

Authentication: API Key; path_channel: 1122; path_simulcast_platform: youtube; query_account_id: 2; body_additional_config: {}; body_application_instance: youtube; body_application_name: rtmp; body_enabled: false; body_name: disabled-stream; returnFullResponse: true

Links

Discussion