Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Players → Store Player

AI-generated

Summary

Store a radio player configuration

Inputs

  • authentication — Authentication method (OAuth2 or API Key)
  • path_radio_product_id (required) — The unique identifier (ID) of the radio product to request.
  • body_display_name (required) — Name used to display in the player.
  • body_name (required) — Name of the player (not used in the player).
  • body_stations (required) — List of stations used in the super player.
  • body_type (required) — Type of player.
  • body_background_color — Specify the background color used in the player.
  • body_button_color — Specify the button color used in the player.
  • body_domains — Specify the domains allow accessing to the player.
  • body_facebook_link — Specify the Facebook link used in Facebook embed.
  • body_height — Specify the height in px for display the player.
  • body_history_display — Specify the history display used in the player.
  • body_history_hold — Specify if the maximum number of song displayed in history.
  • body_is_auto_start — Specify if the auto start is enabled.
  • body_is_cover — Specify if the cover will be displayed.
  • body_is_direct_control — Is the player in direct control mode ?
  • body_is_embed — Specify if the embed url will be displayed int the player.
  • body_is_facebook_embed — Specify if the Facebook embed url will be displayed int the player.
  • body_is_history_clickable — Specify if the history could be clickable in history.
  • body_is_history_time_display — Specify if the time will be displayed in history.
  • body_is_hls_buffered — Specify if the player start at the beginning and buffer hls streams.
  • body_is_listeners — Specify if listeners information is displayed.
  • body_is_listeners_hold — Specify if listeners hold is used.
  • body_is_logo — Specify if the logo Infomaniak is displayed.
  • body_is_metadata_display — Specify if the metadata title and artist will be visible.
  • body_is_spectrum — Specify if the spectrum will be displayed.
  • body_is_station_thumbnail — Specify if the station thumbnail will be displayed.
  • body_is_twitter_embed — Specify if the Twitter embed url will be displayed int the player.
  • body_language — Specify the language used in the player.
  • body_listeners_hold — Specify listeners hold for listeners information.
  • body_secondary_color — Specify the secondary color used in the player.
  • body_twitter_account — Specify the Twitter account will be used in Twitter embed.
  • body_twitter_backlink — Specify the Twitter backlink used in Twitter embed.
  • body_twitter_hashtag — Specify the Twitter hashtag used in Twitter embed.
  • body_volume — Specify the default volume in the player.
  • body_width — Specify the width in px for display the player.
  • returnFullResponse — Return the full response body instead of just success indicator.

Output shape

a player object containing the stored configuration

Returns the created player record; may include an ID and echoed fields.

Examples

Example 1: Create a new player with default settings

authentication=oauth2, path_radio_product_id=12345, body_name='MyRadio', body_type='1', returnFullResponse=true

Example 2: Update player with custom colors and embed

path_radio_product_id=12345, body_is_embed=true, body_background_color='#ff0000', body_button_color='#00ff00', returnFullResponse=false

Example 3: Create player with full response and history

path_radio_product_id=67890, body_history_display='overlay', body_is_history_clickable=true, returnFullResponse=true

Links

Discussion