Sign in
Players

Update a player

This endpoint allows you to update a player.

put/1/videos/{channel}/players/{player}

Path parameters

channelinteger required

The unique identifier (ID) of the channel to request.

playerinteger required

The unique identifier (ID) of the player to request.

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

account_idinteger required

Account identifier

The account identifier

Request body

ads_enabledboolean required
ads_urlstring

a strict string (no HTML/PHP tags or HTML entities allowed)

allow_full_screenboolean required
auto_hide_controlsboolean required
auto_startboolean required
buffernumber double required
chromecastboolean required
control_active_colorstring required

a CSS hex color string (e.g. #fff or #ffffff)

control_colorstring required

a CSS hex color string (e.g. #fff or #ffffff)

controlbar_colorstring required

a CSS hex color string (e.g. #fff or #ffffff)

countdownboolean required
countdown_daysstring

a strict string (no HTML/PHP tags or HTML entities allowed)

countdown_hoursstring

a strict string (no HTML/PHP tags or HTML entities allowed)

countdown_minutesstring

a strict string (no HTML/PHP tags or HTML entities allowed)

countdown_secondsstring

a strict string (no HTML/PHP tags or HTML entities allowed)

countdown_txtstring

a strict string (no HTML/PHP tags or HTML entities allowed)

descriptionstring nullable

a strict string (no HTML/PHP tags or HTML entities allowed)

enable_embed_codeboolean required
enable_facebookboolean required
enable_twitterboolean required
extract_preload_imgboolean required
facebook_back_linkstring

a strict string (no HTML/PHP tags or HTML entities allowed)

facebook_player_embedboolean required
geo_ip_imgstring nullable

a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

heightinteger required
interrupt_imgstring nullable

a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

is360boolean required
logo_anchor'"bottom left"' | '"bottom right"' | '"top left"' | '"top right"'
logo_imgstring nullable

a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

logo_margin_leftinteger
logo_margin_topinteger
logo_percentagenumber double
namestring required

a strict string (no HTML/PHP tags or HTML entities allowed)

preload_imgstring nullable

a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

ratio'"16:9"' | '"4:3"' | '"custom"' required
restrict_imgstring nullable

a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

show_controlsboolean required
show_controls_during_adsboolean required
show_logostring
show_viewersboolean required
show_viewers_afterinteger nullable
show_viewers_only_afterboolean required
sound_enabledboolean required
sound_percentageinteger required
stereo_projection360'"left-right"' | '"none"' | '"top-bottom"' nullable
time_before_hide_cbinteger required
titlestring nullable

a strict string (no HTML/PHP tags or HTML entities allowed)

twitter_back_linkstring

a strict string (no HTML/PHP tags or HTML entities allowed)

twitter_relatedstring

a strict string (no HTML/PHP tags or HTML entities allowed)

twitter_viastring

a strict string (no HTML/PHP tags or HTML entities allowed)

use_geo_ip_imgboolean required
use_interrupt_imgboolean required
use_preload_imgboolean required
use_restrict_imgboolean required
widthinteger required

Example request

{
  "ads_url": "\"Hello world ! 😊\"",
  "control_active_color": "\"#1a2b3c\"",
  "control_color": "\"#1a2b3c\"",
  "controlbar_color": "\"#1a2b3c\"",
  "countdown_days": "\"Hello world ! 😊\"",
  "countdown_hours": "\"Hello world ! 😊\"",
  "countdown_minutes": "\"Hello world ! 😊\"",
  "countdown_seconds": "\"Hello world ! 😊\"",
  "countdown_txt": "\"Hello world ! 😊\"",
  "description": "\"Hello world ! 😊\"",
  "facebook_back_link": "\"Hello world ! 😊\"",
  "geo_ip_img": "\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" or \"https://storage5.infomaniak.com/...\"",
  "interrupt_img": "\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" or \"https://storage5.infomaniak.com/...\"",
  "logo_img": "\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" or \"https://storage5.infomaniak.com/...\"",
  "name": "\"Hello world ! 😊\"",
  "preload_img": "\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" or \"https://storage5.infomaniak.com/...\"",
  "restrict_img": "\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...\" or \"https://storage5.infomaniak.com/...\"",
  "title": "\"Hello world ! 😊\"",
  "twitter_back_link": "\"Hello world ! 😊\"",
  "twitter_related": "\"Hello world ! 😊\"",
  "twitter_via": "\"Hello world ! 😊\""
}

Response

OK

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

Result of the HTTP request

Example response

{
  "result": "success",
  "data": {
    "name": "MyRadioPlayer",
    "width": 1280,
    "height": 720,
    "logo_img": "https://static.infomaniak.ch/configvideo/video-streaming-v2/private/{channel}/players/{player}/logo.png",
    "logo_percentage": 50,
    "logo_margin_top": 50,
    "logo_margin_left": 50,
    "control_color": "#FFFFFF",
    "controlbar_color": "#000000",
    "control_active_color": "#0098FF",
    "interrupt_img": "https://static.infomaniak.ch/configvideo/video-streaming-v2/private/{channel}/players/{player}/interrupted.png",
    "restrict_img": "https://static.infomaniak.ch/configvideo/video-streaming-v2/private/{channel}/players/{player}/unauthorized.png",
    "facebook_back_link": "my-lovely-stream.ch",
    "twitter_via": "MyAccount",
    "twitter_back_link": "my-lovely-stream.ch",
    "twitter_related": "infomaniak video live",
    "sound_percentage": 50,
    "channel": {
      "id": "1",
      "channel_id": 69001
    },
    "integrations": [
      {
        "type": "hls",
        "url": "https://maniak_tv.vedge.infomaniak.com/livecast/ik:maniak_tv/manifest.f4m",
        "stream_id": "maniak_tv"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.