Create Player

Developing

POST

/projects/{projId}/players

Create a Player for a project

📣 this endpoint Creates a player under a project . In this POST request the project ID has to be provided . All the necessary data has to be provided in the request payload

✳ list of URL parameters

project_id = 36 character in length

📢 Info message : Here URL is contructed like
POST /projects/<project_id>/players

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

projId

string

required

Example:

f32a0116-fe11-454c-8e6a-5ff4101882e5

Body Params multipart/form-data

brand_logo

file

optional

Example:

file:///Users/sohelmia/video-encoding/screenshot.png

name

string

optional

Example:

Player 2

primary_color

string

optional

Example:

#FFFFFF

custom_html

string

optional

Example:

Custom HTML

language

string

optional

Example:

font_family

string

optional

Example:

Arial

font_size

integer

optional

Example:

caption

string

optional

Example:

Sample caption

controls

string

optional

Example:

{"big_play_button":true,"play_pause_button":true,"setting_button":true,"volume_control":true,"mute_button":true,"caption_button":true,"picture_in_picture":true,"seekbar":true,"double_tap":true,"cast":true,"fullscreen":true}

settings

string

optional

Example:

{"caption":true,"video_quality":true,"speed_control":true,"video_loop":true}

is_default

integer

optional

Example:

logo_redirect_url

string

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8080/v1/projects/f32a0116-fe11-454c-8e6a-5ff4101882e5/players' \
--form 'brand_logo=@"/Users/sohelmia/video-encoding/screenshot.png"' \
--form 'name="Player 2"' \
--form 'primary_color="#FFFFFF"' \
--form 'custom_html="Custom HTML"' \
--form 'language="en"' \
--form 'font_family="Arial"' \
--form 'font_size="14"' \
--form 'caption="Sample caption"' \
--form 'controls="{\"big_play_button\":true,\"play_pause_button\":true,\"setting_button\":true,\"volume_control\":true,\"mute_button\":true,\"caption_button\":true,\"picture_in_picture\":true,\"seekbar\":true,\"double_tap\":true,\"cast\":true,\"fullscreen\":true}"' \
--form 'settings="{\"caption\":true,\"video_quality\":true,\"speed_control\":true,\"video_loop\":true}"' \
--form 'is_default="0"'

Responses

🟢200OK

application/json

Body

object {0}

Example

{"message":"Player created successfully","result":{"id":"f96c5d46-2688-4e43-ad33-9abe49bfa0cd","user_id":"10bb71cf-57e0-436d-a449-0b68ef13c731","collection_id":"00000000-0000-0000-0000-000000000000","project_id":"5eca71a3-bc93-45cf-ad6e-45be2961f921","name":"Sample Player","primary_color":"#FFFFFF","custom_html":"<p>Custom HTML</p>","language":"en","font_family":"Arial","font_size":14,"caption":"Sample Caption","controls":"Sample Controls","settings":"Sample Settings","is_default":true,"created_at":"2024-02-06T10:52:46.738652418Z","updated_at":"2024-02-06T10:52:46.738652468Z","created_by":"10bb71cf-57e0-436d-a449-0b68ef13c731","updated_by":"10bb71cf-57e0-436d-a449-0b68ef13c731"},"success":true}

🟢200OK

🟢200OK updated

🟢200OK final 2

Get all Players

Get Specific player

Create Player

Create a Player for a project#

Request

Request samples

Responses

Create a Player for a project