INinfomaniak
V3 > Player

Update player details.

Changed on

Updates details of a specified player based on the parameters.

put/2/vod/players/{player}

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/2/vod/players/{player}
  • Auth
    HTTP bearer

Path parameters

playerstring required

Request body

ads_categorystring

<note><strong>vast</strong>: The advertisement is from a vast</note><note><strong>video</strong>: The advertisement is from a video</note><note><strong>none</strong>: There is no advertisement</note>

airplayboolean
audio_volumenumber double

The volume of the audio for the Player

auto_hide_controlsboolean

Indicates whether controls should automatically hide for the Player

auto_startboolean

Indicates whether media should start automatically for the Player

chromecastboolean

Indicates whether Chromecast is enabled for the Player

control_active_colorstring

Controlbar color

control_colorstring

Control color

controlbar_colorstring

Active control color

defaultboolean

Indicates whether the Player is set as default

default_speednumber double nullable

The default speed of playback for the Player

descriptionstring nullable

a string free of XSS payloads

enable_embed_codeboolean

Indicates whether embed code is enabled for the Player

enable_facebookboolean

Indicates whether Facebook sharing is enabled for the Player

enable_linkedinboolean
enable_twitterboolean

Indicates whether Twitter sharing is enabled for the Player

enable_whatsappboolean
encoding_change_enabledboolean

Indicates whether encoding change is enabled for the Player

encoding_limitboolean

The encoding limit for the Player

facebook_back_linkstring nullable

A public resolvable url

force_media_ratioboolean

Indicates whether media ratio is enforced for the Player

force_subtitles_activatedboolean
force_subtitles_typestring

<note><strong>lang_navigator</strong>: The subtitles will try to match the browser lang</note><note><strong>lang_manager</strong>: Force the subtitles will try to match the manager lang</note>

geoip_imagestring nullable

The GeoIP image associated with the Player

has_logoboolean
heightnumber double

The height of Player

interrupt_imagestring nullable

The interrupt image associated with the Player

is360boolean

Indicates whether the Player supports 360-degree videos

is_defaultboolean

Indicates if the Player is the default one when sharing

logo_anchorstring

The anchor of the overlay logo<note><strong>top_left</strong>: Positioned at the top-left corner</note><note><strong>top_right</strong>: Positioned at the top-right corner</note><note><strong>bottom_left</strong>: Positioned at the bottom-left corner</note><note><strong>bottom_right</strong>: Positioned at the bottom-right corner</note><note><strong>center</strong>: Positioned at the center of the container or screen</note><note><strong>none</strong>: Not positioned on the container or screen</note>

logo_imagestring nullable

The logo image associated with the Player

logo_margin_horizontalnumber double nullable

The horizontal margin of the Player logo

logo_margin_verticalnumber double nullable

The vertical margin of the Player logo

logo_percentagenumber double nullable

The size percentage of the Player logo

media_thumbnail_anchor'left' | 'top' nullable

The media thumbnail anchor<note><strong>top</strong>: Positioned on top</note><note><strong>left</strong>: Positioned on the left side</note>

namestring

a string free of XSS payloads

player_end_screen_typestring

<note><strong>pause_and_replay</strong>: We will show pause and replay buttons</note><note><strong>auto_loop</strong>: The video will automatically loop</note><note><strong>suggest_more_media</strong>: Will suggest many video as ending screen</note><note><strong>suggest_next_media</strong>: Will suggest one video as ending screen</note>

preferred_playback_strategystring

The preferred playback strategy (may not be enforced)<note><strong>hls</strong>: Apple HTTP Live Streaming</note><note><strong>dash</strong>: Dynamic Adaptive Streaming over HTTP</note><note><strong>single</strong>: Single bitrate</note><note><strong>best</strong>: Playback strategy selecting the best available quality dynamically</note>

preferred_playback_strategy_activatedboolean
preload_imagestring nullable

The preload image associated with the Player

restrict_imagestring nullable

The restrict image associated with the Player

show_audioboolean

Indicates whether audio controls should be shown for the Player

show_controlsboolean

Indicates whether controls should be shown for the Player

show_default_logoboolean

Indicates whether the default logo should be shown for the Player

show_downloadboolean
show_durationboolean

Indicates whether the duration should be shown for the Player

show_fullscreenboolean

Indicates whether fullscreen controls should be shown for the Player

show_loopboolean

Indicates whether loop controls should be shown for the Player

show_media_infoboolean

Indicates whether media information should be shown for the Player

show_media_thumbnailboolean

Indicates whether media thumbnail should be shown for the Player

show_pipboolean
show_progressionboolean

Indicates whether progression controls should be shown for the Player

show_relatedboolean

Indicates whether related media should be shown for the Player

show_replayboolean

Indicates whether replay controls should be shown for the Player

show_speedboolean

Indicates whether speed controls should be shown for the Player

show_suggestionsboolean

Should suggestions be displayed or not

show_viewersboolean

Indicates whether viewers count should be shown for the Player

show_viewers_afterboolean

The time after which viewers count should be shown for the Player

show_viewers_only_afterboolean

The time only after which viewers count should be shown for the Player

skip_intro_activatedboolean
skip_intro_tointeger

Number of seconds to reach once the "skip intro" button is pressed, nothing will appear if value is 0

theme'chrome' | 'jwlike' | 'nuevo' | 'party' | 'pinko' | 'roundal' | 'shaka' | 'slategrey' | 'treso' nullable

The theme for the Player

theme_activatedboolean
time_before_hide_cbinteger

The time before controls should be hidden for the Player

time_skip_modestring

<note><strong>none</strong>: No rewind mode selected</note><note><strong>forward_only</strong>: Forward only mode selected</note><note><strong>rewind_only</strong>: Rewind only mode selected</note><note><strong>rewind_forward</strong>: Rewind and forward mode selected</note>

twitter_back_linkstring nullable

A public resolvable url

twitter_relatedstring[] nullable

The related Twitter account associated with the Player

twitter_viastring nullable

a string free of XSS payloads

widthnumber double

The width of Player

Example request

{
  "ads_category": "vast",
  "control_active_color": "#FFCC00",
  "control_color": "#FFCC00",
  "controlbar_color": "#FFCC00",
  "description": "\"Hello World\"",
  "facebook_back_link": "https://infomaniak.com",
  "force_subtitles_type": "lang_navigator",
  "geoip_image": "https://api.infomaniak.com/2/vod/res/players/1jhvl2uqblphl.geoip.png",
  "interrupt_image": "https://api.infomaniak.com/2/vod/res/players/1jhvl2uqblphl.interrupt.png",
  "logo_anchor": "top_left",
  "logo_image": "https://api.infomaniak.com/2/vod/res/players/1jhvl2uqblphl.logo.png",
  "media_thumbnail_anchor": "top",
  "name": "\"Hello World\"",
  "player_end_screen_type": "pause_and_replay",
  "preferred_playback_strategy": "hls",
  "preload_image": "https://api.infomaniak.com/2/vod/res/players/1jhvl2uqblphl.preload.png",
  "restrict_image": "https://api.infomaniak.com/2/vod/res/players/1jhvl2uqblphl.restrict.png",
  "suggestions": {
    "source": "1jhvl2upwoctc",
    "tags": [
      "\"Hello World\""
    ],
    "type": "similar_tags"
  },
  "theme": "Treso",
  "time_skip_mode": "none",
  "twitter_back_link": "https://infomaniak.com",
  "twitter_via": "\"Hello World\""
}

Response

OK

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

Result of the HTTP request

datastring

Example response

{
  "result": "success"
}

Changes

  • 1a0c305e7db6Revision changes
    • info

      added the new optional request property

  • f11860e74a00Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status