Update Player

Update Player

curl --request PUT \
  --url https://api.tenbyte.io/v1/stream/libraries/{libraryId}/players/{playerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Default Player Changes",
  "language": "fr",
  "font_family": "Rubik",
  "custom_html_head": "<!-- Custom analytics script -->",
  "custom_html_footer": "<footer>Powered by MyApp</footer>",
  "playback_speeds": [
    0.75,
    0.5,
    1,
    1.5,
    2
  ],
  "is_beta_enabled": true,
  "is_default": false,
  "enable_resumable_position": true,
  "appearance": {
    "primary_color": "#1D9BF0",
    "caption_font_color": "#FFFFFF",
    "caption_background_color": "#000000",
    "font_size": 14,
    "caption_font_size": 18
  },
  "controls": {
    "backward": false,
    "forward": false,
    "airplay": false,
    "big_play_button": false,
    "captions": true,
    "chromecast": false,
    "current_time": true,
    "duration": true,
    "fullscreen": true,
    "mute": true,
    "picture_in_picture": true,
    "play_pause": true,
    "progress": true,
    "settings": true,
    "volume": true
  }
}
'

{
  "data": {
    "created_at": "2025-11-10T15:30:28.534221+06:00",
    "updated_at": "2025-11-10T15:40:27.592997825+06:00",
    "created_by": "9ba29736-cc5d-4e1c-85e8-f73849914ae0",
    "updated_by": "9ba29736-cc5d-4e1c-85e8-f73849914ae0",
    "font_family": "Rubik",
    "name": "Default Player Changes",
    "language": "fr",
    "custom_html": "",
    "playback_speeds": [
      0.75,
      0.5,
      1,
      1.5,
      2
    ],
    "appearance": {
      "primary_color": "#1D9BF0",
      "caption_font_color": "#FFFFFF",
      "caption_background_color": "#000000",
      "logo": "",
      "logo_destination_url": "",
      "font_size": 14,
      "caption_font_size": 18
    },
    "controls": {
      "backward": false,
      "forward": false,
      "cast": false,
      "big_play_button": false,
      "captions": true,
      "chapters": false,
      "current_time": true,
      "duration": true,
      "fullscreen": true,
      "mute": true,
      "picture_in_picture": true,
      "play_pause": true,
      "progress": true,
      "settings": true,
      "volume": true,
      "hide_branding": false,
      "preload": false,
      "controls_visible": false,
      "enable_download_button": false,
      "loop": false
    },
    "organization_id": "a7f590b4-3fd7-42a4-82bb-a7cfa6aa9d04",
    "id": "4dbe731e-b3b4-4e6d-b291-3339fa28cc91",
    "library_id": "314221a1-3cbf-4d3c-846e-f6c22bc43064",
    "is_beta_enabled": true,
    "is_default": false,
    "enable_resumable_position": true
  },
  "message": "Player Updated Successfully",
  "success": true
}

PUT

libraries

{libraryId}

players

{playerId}

Update Player

curl --request PUT \
  --url https://api.tenbyte.io/v1/stream/libraries/{libraryId}/players/{playerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Default Player Changes",
  "language": "fr",
  "font_family": "Rubik",
  "custom_html_head": "<!-- Custom analytics script -->",
  "custom_html_footer": "<footer>Powered by MyApp</footer>",
  "playback_speeds": [
    0.75,
    0.5,
    1,
    1.5,
    2
  ],
  "is_beta_enabled": true,
  "is_default": false,
  "enable_resumable_position": true,
  "appearance": {
    "primary_color": "#1D9BF0",
    "caption_font_color": "#FFFFFF",
    "caption_background_color": "#000000",
    "font_size": 14,
    "caption_font_size": 18
  },
  "controls": {
    "backward": false,
    "forward": false,
    "airplay": false,
    "big_play_button": false,
    "captions": true,
    "chromecast": false,
    "current_time": true,
    "duration": true,
    "fullscreen": true,
    "mute": true,
    "picture_in_picture": true,
    "play_pause": true,
    "progress": true,
    "settings": true,
    "volume": true
  }
}
'

{
  "data": {
    "created_at": "2025-11-10T15:30:28.534221+06:00",
    "updated_at": "2025-11-10T15:40:27.592997825+06:00",
    "created_by": "9ba29736-cc5d-4e1c-85e8-f73849914ae0",
    "updated_by": "9ba29736-cc5d-4e1c-85e8-f73849914ae0",
    "font_family": "Rubik",
    "name": "Default Player Changes",
    "language": "fr",
    "custom_html": "",
    "playback_speeds": [
      0.75,
      0.5,
      1,
      1.5,
      2
    ],
    "appearance": {
      "primary_color": "#1D9BF0",
      "caption_font_color": "#FFFFFF",
      "caption_background_color": "#000000",
      "logo": "",
      "logo_destination_url": "",
      "font_size": 14,
      "caption_font_size": 18
    },
    "controls": {
      "backward": false,
      "forward": false,
      "cast": false,
      "big_play_button": false,
      "captions": true,
      "chapters": false,
      "current_time": true,
      "duration": true,
      "fullscreen": true,
      "mute": true,
      "picture_in_picture": true,
      "play_pause": true,
      "progress": true,
      "settings": true,
      "volume": true,
      "hide_branding": false,
      "preload": false,
      "controls_visible": false,
      "enable_download_button": false,
      "loop": false
    },
    "organization_id": "a7f590b4-3fd7-42a4-82bb-a7cfa6aa9d04",
    "id": "4dbe731e-b3b4-4e6d-b291-3339fa28cc91",
    "library_id": "314221a1-3cbf-4d3c-846e-f6c22bc43064",
    "is_beta_enabled": true,
    "is_default": false,
    "enable_resumable_position": true
  },
  "message": "Player Updated Successfully",
  "success": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

libraryId

string

required

Unique identifier of the library.

playerId

string

required

Unique identifier of the targeted player resource.

Body

application/json

name

string

Name of the player configuration used to identify it within your account.

language

string

Default language code for captions and UI elements (e.g., 'en', 'es').

font_family

string

Font family used for captions and player interface text.

custom_html_head

string

Custom HTML or script snippets to include in the section of the player (e.g., analytics tags).

custom_html_footer

string

Custom HTML or script snippets to include before the closing tag.

playback_speeds

(number | integer)[]

List of playback speed options available to users (e.g., 0.5x, 1x, 2x).

is_beta_enabled

boolean

Enables beta or experimental player features for testing.

is_default

boolean

Marks this player as the default configuration for all videos.

enable_resumable_position

boolean

Allows viewers to continue watching from their last playback position.

appearance

object

Defines appearance settings including colors and text sizes for the player.

Show child attributes

appearance.primary_color

string

Primary accent color of the player interface, used for buttons and progress bars.

appearance.caption_font_color

string

Text color of captions in HEX format (e.g., '#FFFFFF').

appearance.caption_background_color

string

Background color displayed behind caption text.

appearance.font_size

integer

Base font size for player UI elements.

appearance.caption_font_size

integer

Font size used specifically for captions or subtitles.

controls

object

Defines the visibility and functionality of player control buttons and features.

Show child attributes

controls.backward

boolean

Enables the backward seek button for rewinding playback.

controls.forward

boolean

Enables the forward seek button for fast-forwarding playback.

controls.airplay

boolean

Enables AirPlay streaming support for Apple devices.

controls.big_play_button

boolean

Displays the large central play button overlay before playback starts.

controls.captions

boolean

Shows or hides the captions toggle button.

controls.chromecast

boolean

Enables Chromecast streaming support for compatible devices.

controls.current_time

boolean

Displays the current playback time indicator.

controls.duration

boolean

Displays the total duration of the video.

controls.fullscreen

boolean

Enables fullscreen mode toggle control.

controls.mute

boolean

Shows the mute/unmute audio control button.

controls.picture_in_picture

boolean

Enables Picture-in-Picture mode for multitasking playback.

controls.play_pause

boolean

Shows the play/pause toggle button in the control bar.

controls.progress

boolean

Displays the progress bar showing playback position.

controls.settings

boolean

Displays the settings menu for quality, captions, and speed options.

controls.volume

boolean

Shows the volume control slider for adjusting audio level.

Response

data

object

required

Show child attributes

data.created_at

string

required

data.updated_at

string

required

data.created_by

string

required

data.updated_by

string

required

data.font_family

string

required

data.name

string

required

data.language

string

required

data.custom_html

string

required

data.playback_speeds

(number | integer)[]

required

data.appearance

object

required

Show child attributes

data.appearance.primary_color

string

required

data.appearance.caption_font_color

string

required

data.appearance.caption_background_color

string

required

data.appearance.logo

string

required

data.appearance.logo_destination_url

string

required

data.appearance.font_size

integer

required

data.appearance.caption_font_size

integer

required

data.controls

object

required

Show child attributes

data.controls.backward

boolean

required

data.controls.forward

boolean

required

data.controls.cast

boolean

required

data.controls.big_play_button

boolean

required

data.controls.captions

boolean

required

data.controls.chapters

boolean

required

data.controls.current_time

boolean

required

data.controls.duration

boolean

required

data.controls.fullscreen

boolean

required

data.controls.mute

boolean

required

data.controls.picture_in_picture

boolean

required

data.controls.play_pause

boolean

required

data.controls.progress

boolean

required

data.controls.settings

boolean

required

data.controls.volume

boolean

required

data.controls.hide_branding

boolean

required

data.controls.preload

boolean

required

data.controls.controls_visible

boolean

required

data.controls.enable_download_button

boolean

required

data.controls.loop

boolean

required

data.organization_id

string

required

data.id

string

required

data.library_id

string

required

data.is_beta_enabled

boolean

required

data.is_default

boolean

required

data.enable_resumable_position

boolean

required

message

string

required

success

boolean

required

Player Details Delete Player

⌘I

API documentation

CDN

Vidinfra

Authorizations

Path Parameters

Body

Response