INinfomaniak
Players

Store player

This endpoint allows you to store a player.

post/1/radios/{radio_product_id}/players

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/radios/{radio_product_id}/players
  • Auth
    HTTP bearer

Path parameters

radio_product_idinteger required

The unique identifier (ID) of the radio product to request.

Request body

background_colorstring

Specify the background color used in the player

button_colorstring

Specify the button color used in the player

display_namestring required

Specify the name uses to display in the player

domainsstring

Specify the domains allow accessing to the player

facebook_linkstring

Specify the Facebook link used in Facebook embed

heightstring

Specify the height in px for display the player

history_display'none' | 'overlay' | 'split' | 'under'

Specify the history display used in the player

history_holdinteger

Specify if the maximum number of song displayed in history

is_auto_startboolean

Specify if the auto start is enabled

is_coverboolean

Specify if the cover will be displayed

is_direct_controlboolean

Is the player in direct control mode ?

is_embedboolean

Specify if the embed url will be displayed int the player

is_facebook_embedboolean

Specify if the Facebook embed url will be displayed int the player

is_history_clickableboolean

Specify if the history could be clickable in history

is_history_time_displayboolean

Specify if the time will be displayed in history

is_hls_bufferedboolean

Specify if the player start at the beginning and buffer hls streams

is_listenersboolean

Specify if listeners information is displayed

is_listeners_holdboolean

Specify if listeners hold is used

is_logoboolean

Specify if the logo Infomaniak is displayed

is_metadata_displayboolean

Specify if the metadata title and artist will be visible

is_spectrumboolean

Specify if the spectrum will be displayed

is_station_thumbnailboolean

Specify if the station thumbnail will be displayed

is_twitter_embedboolean

Specify if the Twitter embed url will be displayed int the player

language'de' | 'en' | 'es' | 'fr' | 'it'

Specify the language used in the player

listeners_holdinteger

Specify listeners hold for listeners information

namestring required

Specify the name of the player, it is not used in the player

secondary_colorstring

Specify the secondary color used in the player

twitter_accountstring

Specify the Twitter account will be used in Twitter embed

twitter_backlinkstring

Specify the Twitter backlink used in Twitter embed

twitter_hashtagstring

Specify the Twitter hashtag used in Twitter embed

type1 | 2 | 3 | 4 | 5 required

Specify the type of player

volumeinteger

Specify the default volume in the player

widthstring

Specify the width in px for display the player

Example request

{
  "background_color": "202020",
  "button_color": "FFFFFF",
  "display_name": "Radio Player",
  "domains": "infomaniak.ch,myradio.ch",
  "facebook_link": "myradio.ch",
  "height": "144.00",
  "history_display": "split",
  "name": "MyPlayer",
  "secondary_color": "0098FF",
  "twitter_account": "MyAccount",
  "twitter_backlink": "myradio.ch",
  "twitter_hashtag": "radio,infomaniak",
  "width": "505.00"
}

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

databoolean

Example response

{
  "result": "success"
}

Changes

No recorded changes to this operation across all 40 revisions of this API.