Player API

Create a player theme

This endpoint is used to create a player for your video, and customize it.

Note:

main_color, text_color, control_bar_background_color, menu_item_background_hover, text_track_color, text_track_background, and menu_background_color must be provided in rgba format (e.g., rgba(255, 0, 0, 1)).

control_bar_height, progress_bar_height, and progress_bar_circle_size must be provided in px format (e.g., 20px).

When creating a player, the is_default field is set to false by default. You can update this field to true using the API update endpoint.

POSThttps://api.aiozstream.network/api/players

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

name The name of the player theme. If you don't provide a name, the player will be named 'default-player-theme'.

theme.main_color The main color of the player.

theme.text_color The color of the player's text.

theme.control_bar_background_color The background color of the player's control bar.

theme.menu_background_color The background color of the player's menu.

theme.menu_item_background_hover The background color of the player's menu items when hovered over.

theme.control_bar_height The height of the player's control bar.

theme.progress_bar_height The height of the player's progress bar.

theme.progress_bar_circle_size The size of the player's progress bar circle.

theme.text_track_color The text track color.

theme.text_track_background The text track background.

Response

201: Created

curl --location 'https://api.aiozstream.network/api/players' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <YOUR_JWT_TOKEN>' \
--data '{
    "name": "your player name",
    "theme": {
        "main_color": "string",
        "text_color": "string",
        "control_bar_background_color": "string",
        "menu_background_color": "string",
        "menu_item_background_hover": "string",
        "text_track_color": "string",
        "text_track_background": "string",
        "control_bar_height": "string",
        "progress_bar_height": "string",
        "progress_bar_circle_size": "string"
    }
}'

List all player themes

Retrieve a list of all the player themes you created, as well as details about each one.

GEThttps://api.aiozstream.network/api/players

Query

offset The number of records to skip before starting to return the results (default: 0)

limit The maximum number of records to return in a query (default: 25, max: 100)

sort_by Field to sort by (options: created_at, name). Defaults to created_at.

order_by Sort direction (options: asc, desc). Defaults to asc.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

search Only support search by name.

Response

200: OK

curl --location 'https://api.aiozstream.network/api/players' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--data ''

Delete player theme

Delete a player if you no longer need it. You can delete any player that you have the player ID for. Notice if player is used in any video, it will not be deleted

DELETEhttps://api.aiozstream.network/api/players/:id

Parameters

id* The unique identifier of the Player Id to be deleted.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location --request DELETE 'https://api.aiozstream.network/api/players/{player_theme_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--data ''

Retrieve a player theme

Retreive a player theme by player id.

GEThttps://api.aiozstream.network/api/players/:id

Parameters

id* The unique identifier of the Player Id to be deleted.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location 'https://api.aiozstream.network/api/players/{player_theme_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--data ''

Update a player theme

Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN. This endpoint is used to Create a player for your video, and customise it.

Note:

Setting a new player as is_default: true will automatically set all other players' is_default field to false.

PATCHhttps://api.aiozstream.network/api/players/:id

Parameters

id* The unique identifier of the Player Id to be deleted.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

name

theme.main_color The main color of the player.

theme.text_color The color of the player's text.

theme.control_bar_background_color The background color of the player's control bar.

theme.menu_background_color The background color of the player's menu.

theme.menu_item_background_hover The background color of the player's menu items when hovered over.

theme.control_bar_height The height of the player's control bar.

theme.progress_bar_height The height of the player's progress bar.

theme.progress_bar_circle_size The size of the player's progress bar circle.

theme.text_track_color The text track color.

theme.text_track_background The text track background.

controls.enable_api Enable the player's API. True to enable, false to disable.

controls.enable_controls Enable the player's controls. True to enable, false to disable.

controls.force_loop Enable the player's force loop. True to enable, false to disable.

controls.force_autoplay Enable the player's auto loop. True to enable, false to disable.

controls.hide_title Enable the player's title. True to enable, false to disable.

is_default Make a player theme default. True to enable, false to disable.

Response

200: OK

curl --location --request PATCH 'https://api.aiozstream.network/api/players/{player_theme_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "theme": {
        "main_color": "string",
        "text_color": "string",
        "control_bar_background_color": "string",
        "menu_background_color": "string",
        "menu_item_background_hover": "string",
        "text_track_color": "string",
        "text_track_background": "string",        
        "control_bar_height": "string",
        "progress_bar_height": "string",
        "progress_bar_circle_size": "string"
    },
    "controls": {
        "enable_api": false,
        "enable_controls": true,
        "force_autoplay": true,
        "hide_title": false,
        "force_loop": false
    },
    "is_default": true
}'

Upload logo for player theme

Upload an image file as a logo for your player. The image should fit within these constraints:

The image mime type must be image/jpeg or image/png. Recommends using png images with transparent background.

The file size should be a maximum of 100 KiB.

The image size should be a maximum of 200px width x 100px.

POSThttps://api.aiozstream.network/api/players/:id/logo

Parameters

id* The Id of player theme to upload logo.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

file* The name of the file you want to use for your logo.

logo_link A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address.

Response

200: OK

curl --location 'https://api.aiozstream.network/api/players/{player_theme_id}/logo' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--form 'link="https://google.com/"' \
--form 'file=@"/path_to_your_image"'

Delete a logo for player theme

Delete the logo associated to a player.

DELETEhttps://api.aiozstream.network/api/players/{player_theme_id}/logo

Parameters

id* The ID of player theme to delete logo.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location --request DELETE 'https://api.aiozstream.network/api/players/{logo_id}/logo' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--data ''

Add player theme to video

Add a player theme to a video. You can add a player theme to a video by providing the player theme ID and the video ID.

POSThttps://api.aiozstream.network/api/players/add-player

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

video's id* Video id.

player's id* Player id.

Response

200: OK

curl --location 'https://api.aiozstream.network/api/players/add-player' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
   "video_id": "string", 
   "player_theme_id": "string" 
}'

PreviousWebhooks NextAnalytics