---
title: "Create player."
method: POST
path: "/2/vod/channels/{channel}/players"
tags: ["V3 > Player"]
---

# Create player.

`POST /2/vod/channels/{channel}/players`

Creates a new player within the provided channel based on the parameters.

## Path parameters

- `channel` integer, required

## Request body

- object
  - `ads_category` string — <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>
  - `airplay` boolean
  - `audio_volume` number, double — The volume of the audio for the Player
  - `auto_hide_controls` boolean — Indicates whether controls should automatically hide for the Player
  - `auto_start` boolean — Indicates whether media should start automatically for the Player
  - `chromecast` boolean — Indicates whether Chromecast is enabled for the Player
  - `control_active_color` string — Controlbar color
  - `control_color` string — Control color
  - `controlbar_color` string — Active control color
  - `default` boolean — Indicates whether the Player is set as default
  - `default_speed` number, double, nullable — The default speed of playback for the Player
  - `description` string, nullable — a string free of XSS payloads
  - `enable_embed_code` boolean — Indicates whether embed code is enabled for the Player
  - `enable_facebook` boolean — Indicates whether Facebook sharing is enabled for the Player
  - `enable_linkedin` boolean
  - `enable_twitter` boolean — Indicates whether Twitter sharing is enabled for the Player
  - `enable_whatsapp` boolean
  - `encoding_change_enabled` boolean — Indicates whether encoding change is enabled for the Player
  - `encoding_limit` boolean — The encoding limit for the Player
  - `facebook_back_link` string, nullable — A public resolvable url
  - `force_media_ratio` boolean — Indicates whether media ratio is enforced for the Player
  - `force_subtitles_activated` boolean
  - `force_subtitles_type` string — <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_image` string, nullable — The GeoIP image associated with the Player
  - `has_logo` boolean
  - `height` number, double — The height of Player
  - `interrupt_image` string, nullable — The interrupt image associated with the Player
  - `is360` boolean — Indicates whether the Player supports 360-degree videos
  - `is_default` boolean — Indicates if the Player is the default one when sharing
  - `logo_anchor` string — 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_image` string, nullable — The logo image associated with the Player
  - `logo_margin_horizontal` number, double, nullable — The horizontal margin of the Player logo
  - `logo_margin_vertical` number, double, nullable — The vertical margin of the Player logo
  - `logo_percentage` number, 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>
  - `name` string, required — a string free of XSS payloads
  - `player_end_screen_type` string — <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_strategy` string — 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_activated` boolean
  - `preload_image` string, nullable — The preload image associated with the Player
  - `restrict_image` string, nullable — The restrict image associated with the Player
  - `show_audio` boolean — Indicates whether audio controls should be shown for the Player
  - `show_controls` boolean — Indicates whether controls should be shown for the Player
  - `show_default_logo` boolean — Indicates whether the default logo should be shown for the Player
  - `show_download` boolean
  - `show_duration` boolean — Indicates whether the duration should be shown for the Player
  - `show_fullscreen` boolean — Indicates whether fullscreen controls should be shown for the Player
  - `show_loop` boolean — Indicates whether loop controls should be shown for the Player
  - `show_media_info` boolean — Indicates whether media information should be shown for the Player
  - `show_media_thumbnail` boolean — Indicates whether media thumbnail should be shown for the Player
  - `show_progression` boolean — Indicates whether progression controls should be shown for the Player
  - `show_related` boolean — Indicates whether related media should be shown for the Player
  - `show_replay` boolean — Indicates whether replay controls should be shown for the Player
  - `show_speed` boolean — Indicates whether speed controls should be shown for the Player
  - `show_suggestions` boolean — Should suggestions be displayed or not
  - `show_viewers` boolean — Indicates whether viewers count should be shown for the Player
  - `show_viewers_after` boolean — The time after which viewers count should be shown for the Player
  - `show_viewers_only_after` boolean — The time only after which viewers count should be shown for the Player
  - `skip_intro_activated` boolean
  - `skip_intro_to` integer — Number of seconds to reach once the "skip intro" button is pressed, nothing will appear if value is 0
  - `suggestions` object, nullable — a list media sources to play at the end of current media
    - `len` integer
    - `not_before` integer
    - `source` string, nullable — Identifier of an existing Folder
    - `tags` string[] — The tags associated with the Player
    - `type` string — Type of media to be played after the current one<note><strong>similar_tags</strong>: Items with similar tags or metadata</note><note><strong>last_uploaded</strong>: Items sorted by the time of their last upload</note><note><strong>most_viewed</strong>: Items sorted by the number of views, descending</note><note><strong>least_viewed</strong>: Items sorted by the number of views, ascending</note><note><strong>random</strong>: Items sorted randomly</note><note><strong>alphabetical</strong>: Items sorted randomly</note>
  - `theme` 'chrome' | 'jwlike' | 'nuevo' | 'party' | 'pinko' | 'roundal' | 'shaka' | 'slategrey' | 'treso', nullable — The theme for the Player
  - `theme_activated` boolean
  - `time_before_hide_cb` integer — The time before controls should be hidden for the Player
  - `time_skip_mode` string — <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_link` string, nullable — A public resolvable url
  - `twitter_related` string[], nullable — The related Twitter account associated with the Player
  - `twitter_via` string, nullable — a string free of XSS payloads
  - `width` number, double — The width of Player

## Response `201`

Created

- object
  - `result` 'success' | 'error' | 'asynchronous', required — Result of the HTTP request
  - `data` 1527df96Player — unresolved $ref

---

[API](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools.md) · [All operations](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infomaniak/api-reference-developer-tools/revisions/158a854b0c7d/schema)