Update player

Update player

curl --request PATCH \
  --url https://api.vidbeo.com/v2/players/{PLAYER_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aspectratio": "16:9",
  "autoplay": false,
  "colour": "#ff0000",
  "controls": false,
  "buttons": "play,progress,fullscreen",
  "dnt": false,
  "keyboard": false,
  "loop": false,
  "name": "Example",
  "muted": false,
  "playsinline": false,
  "preload": false,
  "quality": "highest",
  "title": false,
  "track": "en-US"
}
'

import requests

url = "https://api.vidbeo.com/v2/players/{PLAYER_ID}"

payload = {
    "aspectratio": "16:9",
    "autoplay": False,
    "colour": "#ff0000",
    "controls": False,
    "buttons": "play,progress,fullscreen",
    "dnt": False,
    "keyboard": False,
    "loop": False,
    "name": "Example",
    "muted": False,
    "playsinline": False,
    "preload": False,
    "quality": "highest",
    "title": False,
    "track": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    aspectratio: '16:9',
    autoplay: false,
    colour: '#ff0000',
    controls: false,
    buttons: 'play,progress,fullscreen',
    dnt: false,
    keyboard: false,
    loop: false,
    name: 'Example',
    muted: false,
    playsinline: false,
    preload: false,
    quality: 'highest',
    title: false,
    track: 'en-US'
  })
};

fetch('https://api.vidbeo.com/v2/players/{PLAYER_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vidbeo.com/v2/players/{PLAYER_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'aspectratio' => '16:9',
    'autoplay' => false,
    'colour' => '#ff0000',
    'controls' => false,
    'buttons' => 'play,progress,fullscreen',
    'dnt' => false,
    'keyboard' => false,
    'loop' => false,
    'name' => 'Example',
    'muted' => false,
    'playsinline' => false,
    'preload' => false,
    'quality' => 'highest',
    'title' => false,
    'track' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vidbeo.com/v2/players/{PLAYER_ID}"

	payload := strings.NewReader("{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vidbeo.com/v2/players/{PLAYER_ID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vidbeo.com/v2/players/{PLAYER_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "aspectratio": "16:9",
    "autoplay": false,
    "colour": "#ff0000",
    "controls": false,
    "buttons": "play,progress,fullscreen",
    "dnt": false,
    "keyboard": false,
    "loop": false,
    "name": "Example",
    "muted": false,
    "playsinline": false,
    "preload": false,
    "quality": "highest",
    "title": false,
    "track": "en-US",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

{
  "success": false,
  "result": {},
  "links": {},
  "errors": [
    {
      "message": "Not found"
    }
  ]
}

PATCH

players

{PLAYER_ID}

Update player

curl --request PATCH \
  --url https://api.vidbeo.com/v2/players/{PLAYER_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aspectratio": "16:9",
  "autoplay": false,
  "colour": "#ff0000",
  "controls": false,
  "buttons": "play,progress,fullscreen",
  "dnt": false,
  "keyboard": false,
  "loop": false,
  "name": "Example",
  "muted": false,
  "playsinline": false,
  "preload": false,
  "quality": "highest",
  "title": false,
  "track": "en-US"
}
'

import requests

url = "https://api.vidbeo.com/v2/players/{PLAYER_ID}"

payload = {
    "aspectratio": "16:9",
    "autoplay": False,
    "colour": "#ff0000",
    "controls": False,
    "buttons": "play,progress,fullscreen",
    "dnt": False,
    "keyboard": False,
    "loop": False,
    "name": "Example",
    "muted": False,
    "playsinline": False,
    "preload": False,
    "quality": "highest",
    "title": False,
    "track": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    aspectratio: '16:9',
    autoplay: false,
    colour: '#ff0000',
    controls: false,
    buttons: 'play,progress,fullscreen',
    dnt: false,
    keyboard: false,
    loop: false,
    name: 'Example',
    muted: false,
    playsinline: false,
    preload: false,
    quality: 'highest',
    title: false,
    track: 'en-US'
  })
};

fetch('https://api.vidbeo.com/v2/players/{PLAYER_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vidbeo.com/v2/players/{PLAYER_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'aspectratio' => '16:9',
    'autoplay' => false,
    'colour' => '#ff0000',
    'controls' => false,
    'buttons' => 'play,progress,fullscreen',
    'dnt' => false,
    'keyboard' => false,
    'loop' => false,
    'name' => 'Example',
    'muted' => false,
    'playsinline' => false,
    'preload' => false,
    'quality' => 'highest',
    'title' => false,
    'track' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vidbeo.com/v2/players/{PLAYER_ID}"

	payload := strings.NewReader("{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vidbeo.com/v2/players/{PLAYER_ID}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vidbeo.com/v2/players/{PLAYER_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"aspectratio\": \"16:9\",\n  \"autoplay\": false,\n  \"colour\": \"#ff0000\",\n  \"controls\": false,\n  \"buttons\": \"play,progress,fullscreen\",\n  \"dnt\": false,\n  \"keyboard\": false,\n  \"loop\": false,\n  \"name\": \"Example\",\n  \"muted\": false,\n  \"playsinline\": false,\n  \"preload\": false,\n  \"quality\": \"highest\",\n  \"title\": false,\n  \"track\": \"en-US\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "aspectratio": "16:9",
    "autoplay": false,
    "colour": "#ff0000",
    "controls": false,
    "buttons": "play,progress,fullscreen",
    "dnt": false,
    "keyboard": false,
    "loop": false,
    "name": "Example",
    "muted": false,
    "playsinline": false,
    "preload": false,
    "quality": "highest",
    "title": false,
    "track": "en-US",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

{
  "success": false,
  "result": {},
  "links": {},
  "errors": [
    {
      "message": "Not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

PLAYER_ID

string

required

ID of the player

Example:

"abcde12345abcde12345a"

Body

application/json

aspectratio

enum<string>

Its aspect ratio. Currently we only support the most common 16:9 ratio

Available options:

16:9

Example:

"16:9"

autoplay

boolean

Should the player try to play on-load (many browsers block this, though setting muted as true can help)?

Example:

false

colour

string

Its accent colour, used for the main play button

Pattern: ^#[a-zA-Z0-9]{6}$

Example:

"#ff0000"

controls

boolean

Whether controls should be shown

Example:

false

buttons

string

If you only want a subset of the controls shown, provide a comma-separated string of the ones to include

Example:

"play,progress,fullscreen"

dnt

boolean

Should the player send analytics events?

Example:

false

keyboard

boolean

Support keyboard controls

Example:

false

loop

boolean

Should the video automatically loop and restart when it ends?

Example:

false

name

string

A short name for the player

Required string length: 1 - 40

Example:

"Example"

muted

boolean

Should the video be muted on-load?

Example:

false

playsinline

boolean

If supported, should the video play inline (as opposed to immediately going fullscreen)

Example:

false

preload

boolean

If supported, should we buffer a small amount of video on-load to improve performance?

Example:

false

quality

enum<string>

We try and pick the best quality (based on the connection speed) but you can force it

Available options:

highest,

lowest

Example:

"highest"

title

boolean

Should the video title be shown on-load?

Example:

false

track

enum<string>

If subtitles are available, this sets the language of the one to show on-load

Available options:

de-DE,

en-AU,

en-GB,

en-US,

es-ES,

fr-FR,

it-IT

Example:

"en-US"

Response

Player

success

boolean

required

Example:

true

result

object

required

Show child attributes

links

object

required

Example:

{}

errors

object[]

required

Example:

[]

Delete player List services

Video API

Analytics

API keys

Audit logs

Categories

Folders

Identity providers

Invites

JWT keys

Players

Services

Stream keys

Tokens

Transcribes

Uploads

Users

Videos

Authorizations

Path Parameters

Body

Response