> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tenbyte.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Player

> Updates the configuration or metadata of a specific video player within a library.
This endpoint allows partial updates, so only the fields provided in the request are modified.



## OpenAPI

````yaml https://raw.githubusercontent.com/vidinfra/open-api-docs/refs/heads/main/openapi.json put /libraries/{libraryId}/players/{playerId}
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers:
  - url: https://api.tenbyte.io/v1/vidinfra
    description: Production server
security:
  - bearer: []
tags:
  - name: Library
  - name: Folder
  - name: Video
  - name: Subtitle
  - name: Video Thumbnails
  - name: Transcoding Profiles
  - name: Player Themes
  - name: Video Chapter
  - name: Webhook Endpoints
  - name: Webhook Deliveries
  - name: Security
  - name: Video Multipart Upload
  - name: Webhook
  - name: Migration Jobs
paths:
  /libraries/{libraryId}/players/{playerId}:
    put:
      tags:
        - Player Themes
      summary: Update Player
      description: >-
        Updates the configuration or metadata of a specific video player within
        a library.

        This endpoint allows partial updates, so only the fields provided in the
        request are modified.
      parameters:
        - name: libraryId
          in: path
          description: Unique identifier of the library.
          required: true
          example: 314221a1-3cbf-4d3c-846e-f6c22bc43064
          schema:
            type: string
        - name: playerId
          in: path
          description: Unique identifier of the targeted player resource.
          required: true
          example: a7f590b4-3fd7-42a4-82bb-a7cfa6aa9d04
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    Name of the player configuration used to identify it within
                    your account.
                language:
                  type: string
                  description: >-
                    Default language code for captions and UI elements (e.g.,
                    'en', 'es').
                font_family:
                  type: string
                  description: Font family used for captions and player interface text.
                custom_html_head:
                  type: string
                  description: >-
                    Custom HTML or script snippets to include in the <head>
                    section of the player (e.g., analytics tags).
                custom_html_footer:
                  type: string
                  description: >-
                    Custom HTML or script snippets to include before the closing
                    </body> tag.
                playback_speeds:
                  type: array
                  items:
                    oneOf:
                      - type: number
                      - type: integer
                  description: >-
                    List of playback speed options available to users (e.g.,
                    0.5x, 1x, 2x).
                is_beta_enabled:
                  type: boolean
                  description: Enables beta or experimental player features for testing.
                is_default:
                  type: boolean
                  description: >-
                    Marks this player as the default configuration for all
                    videos.
                enable_resumable_position:
                  type: boolean
                  description: >-
                    Allows viewers to continue watching from their last playback
                    position.
                appearance:
                  type: object
                  properties:
                    primary_color:
                      type: string
                      description: >-
                        Primary accent color of the player interface, used for
                        buttons and progress bars.
                    caption_font_color:
                      type: string
                      description: Text color of captions in HEX format (e.g., '#FFFFFF').
                    caption_background_color:
                      type: string
                      description: Background color displayed behind caption text.
                    font_size:
                      type: integer
                      description: Base font size for player UI elements.
                    caption_font_size:
                      type: integer
                      description: Font size used specifically for captions or subtitles.
                  description: >-
                    Defines appearance settings including colors and text sizes
                    for the player.
                controls:
                  type: object
                  properties:
                    backward:
                      type: boolean
                      description: Enables the backward seek button for rewinding playback.
                    forward:
                      type: boolean
                      description: >-
                        Enables the forward seek button for fast-forwarding
                        playback.
                    airplay:
                      type: boolean
                      description: Enables AirPlay streaming support for Apple devices.
                    big_play_button:
                      type: boolean
                      description: >-
                        Displays the large central play button overlay before
                        playback starts.
                    captions:
                      type: boolean
                      description: Shows or hides the captions toggle button.
                    chromecast:
                      type: boolean
                      description: >-
                        Enables Chromecast streaming support for compatible
                        devices.
                    current_time:
                      type: boolean
                      description: Displays the current playback time indicator.
                    duration:
                      type: boolean
                      description: Displays the total duration of the video.
                    fullscreen:
                      type: boolean
                      description: Enables fullscreen mode toggle control.
                    mute:
                      type: boolean
                      description: Shows the mute/unmute audio control button.
                    picture_in_picture:
                      type: boolean
                      description: >-
                        Enables Picture-in-Picture mode for multitasking
                        playback.
                    play_pause:
                      type: boolean
                      description: Shows the play/pause toggle button in the control bar.
                    progress:
                      type: boolean
                      description: Displays the progress bar showing playback position.
                    settings:
                      type: boolean
                      description: >-
                        Displays the settings menu for quality, captions, and
                        speed options.
                    volume:
                      type: boolean
                      description: >-
                        Shows the volume control slider for adjusting audio
                        level.
                  description: >-
                    Defines the visibility and functionality of player control
                    buttons and features.
            example:
              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
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      created_by:
                        type: string
                      updated_by:
                        type: string
                      font_family:
                        type: string
                      name:
                        type: string
                      language:
                        type: string
                      custom_html:
                        type: string
                      playback_speeds:
                        type: array
                        items:
                          oneOf:
                            - type: number
                            - type: integer
                      appearance:
                        type: object
                        properties:
                          primary_color:
                            type: string
                          caption_font_color:
                            type: string
                          caption_background_color:
                            type: string
                          logo:
                            type: string
                          logo_destination_url:
                            type: string
                          font_size:
                            type: integer
                          caption_font_size:
                            type: integer
                        required:
                          - primary_color
                          - caption_font_color
                          - caption_background_color
                          - logo
                          - logo_destination_url
                          - font_size
                          - caption_font_size
                      controls:
                        type: object
                        properties:
                          backward:
                            type: boolean
                          forward:
                            type: boolean
                          cast:
                            type: boolean
                          big_play_button:
                            type: boolean
                          captions:
                            type: boolean
                          chapters:
                            type: boolean
                          current_time:
                            type: boolean
                          duration:
                            type: boolean
                          fullscreen:
                            type: boolean
                          mute:
                            type: boolean
                          picture_in_picture:
                            type: boolean
                          play_pause:
                            type: boolean
                          progress:
                            type: boolean
                          settings:
                            type: boolean
                          volume:
                            type: boolean
                          hide_branding:
                            type: boolean
                          preload:
                            type: boolean
                          controls_visible:
                            type: boolean
                          enable_download_button:
                            type: boolean
                          loop:
                            type: boolean
                        required:
                          - backward
                          - forward
                          - cast
                          - big_play_button
                          - captions
                          - chapters
                          - current_time
                          - duration
                          - fullscreen
                          - mute
                          - picture_in_picture
                          - play_pause
                          - progress
                          - settings
                          - volume
                          - hide_branding
                          - preload
                          - controls_visible
                          - enable_download_button
                          - loop
                      organization_id:
                        type: string
                      id:
                        type: string
                      library_id:
                        type: string
                      is_beta_enabled:
                        type: boolean
                      is_default:
                        type: boolean
                      enable_resumable_position:
                        type: boolean
                    required:
                      - created_at
                      - updated_at
                      - created_by
                      - updated_by
                      - font_family
                      - name
                      - language
                      - custom_html
                      - playback_speeds
                      - appearance
                      - controls
                      - organization_id
                      - id
                      - library_id
                      - is_beta_enabled
                      - is_default
                      - enable_resumable_position
                  message:
                    type: string
                  success:
                    type: boolean
                required:
                  - data
                  - message
                  - success
              example:
                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
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                required:
                  - message
                  - success
              example:
                message: Invalid Request
                success: false
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  success:
                    type: boolean
                required:
                  - code
                  - message
                  - success
              example:
                code: auth_type_not_found
                message: >-
                  Could not determine authentication type from request. Please
                  provide a valid Authorization header or X-API-Key header.
                success: false
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                required:
                  - message
                  - success
              example:
                message: Resource not found
                success: false
          headers: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        code:
                          type: string
                        message:
                          type: string
                  success:
                    type: boolean
                required:
                  - message
                  - errors
                  - success
              example:
                message: Invalid Request
                errors:
                  - field: field_name
                    code: validation_required
                    message: This field is required
                success: false
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                required:
                  - message
                  - success
              example:
                message: Internal server error
                success: false
          headers: {}
      deprecated: false
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````