Player Themes
Download SpecList all player themes
Retrieve a list of all the player themes you created, as well as details about each one.
apiKey
sortBy
string
createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format.
- Enum
-
- name
- createdAt
- updatedAt
- Example
- "createdAt"
sortOrder
string
Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.
- Enum
-
- asc
- desc
- Example
- "asc"
currentPage
int
Choose the number of search results to return per page. Minimum value: 1
- Default
- 1
- Example
- 2
pageSize
int
Results per page. Allowed values 1-100, default is 25.
- Default
- 25
- Example
- 30
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#list
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#list
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const sortBy = 'createdAt'; // createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format.
const sortOrder = 'asc'; // Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.
const currentPage = 2; // Choose the number of search results to return per page. Minimum value: 1
const pageSize = 30; // Results per page. Allowed values 1-100, default is 25.
// PlayerThemesListResponse
const playerThemes = await client.playerThemes.list({ sortBy, sortOrder, currentPage, pageSize });
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#list
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
= # str | Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
= 2 # int | Choose the number of search results to return per page. Minimum value: 1 (optional) if omitted the server will use the default value of 1
= 30 # int | Results per page. Allowed values 1-100, default is 25. (optional) if omitted the server will use the default value of 25
# example passing only required values which don't have defaults set
# and optional values
# List all players
=
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#list
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#list
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class listExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var sortBy = createdAt; // string | createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
var sortOrder = asc; // string | Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
var currentPage = 2; // int? | Choose the number of search results to return per page. Minimum value: 1 (optional) (default to 1)
var pageSize = 30; // int? | Results per page. Allowed values 1-100, default is 25. (optional) (default to 25)
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// List all players
PlayerThemesListResponse result = apiPlayerThemesInstance.list(sortBy, sortOrder, currentPage, pageSize);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.list: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#list
Response
Success
Bad Request
data
array[object (PlayerTheme)]
required
PlayerTheme
object (PlayerTheme)
name
string
The name of the player theme
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
playerId
string
required
- Example
- "pl45KFKdlddgk654dspkze"
createdAt
string
date-time
When the player was created, presented in ISO-8601 format.
- Example
- "2020-01-31T10:17:47+00:00"
updatedAt
string
date-time
When the player was last updated, presented in ISO-8601 format.
- Example
- "2020-01-31T10:18:47+00:00"
assets
object (assets)
logo
string
The name of the file containing the logo you want to use.
- Example
- "mylogo.jpg"
link
string
The path to the file containing your logo.
- Example
- "path/to/my/logo/mylogo.jpg"
pagination
object (pagination)
required
- Example
- { "itemsTotal": 123, "pagesTotal": 7, "pageSize": 20, "currentPage": 3, "currentPageItems": 20, "links": { "first": { "rel": "first", "uri": "/videos/search?currentPage=1&pageSize=20" }, "previous": { "rel": "previous", "uri": "/videos/search?currentPage=2&pageSize=20" }, "next": { "rel": "next", "uri": "/videos/search?currentPage=4&pageSize=20" }, "last": { "rel": "last", "uri": "/videos/search?currentPage=6&pageSize=20" } } }
itemsTotal
int
Total number of items that exist.
pagesTotal
int
Number of items listed in the current page.
pageSize
int
Maximum number of item per page.
currentPage
int
The current page index.
currentPageItems
int
The number of items on the current page.
links
array[object (PaginationLink)]
required
PaginationLink
object (PaginationLink)
rel
string
uri
string
uri
type
string
A link to the error documentation.
title
string
A description of the error that occurred.
name
string
The name of the parameter that caused the error.
status
int
The HTTP status code.
problems
array[object (BadRequest)]
Returns any additional problems in the request in an array of objects.
BadRequest
object (BadRequest)
type
string
A link to the error documentation.
title
string
A description of the error that occurred.
name
string
The name of the parameter that caused the error.
status
int
The HTTP status code.
apiKey
name
string
Add a name for your player theme here.
- Max Length
- 100
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
- Default
- true
enableControls
boolean
enable/disable player controls. Default: true
- Default
- true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
- Default
- false
hideTitle
boolean
enable/disable title. Default: false
- Default
- false
forceLoop
boolean
enable/disable looping. Default: false
- Default
- false
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#create
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#create
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerThemeCreationPayload = {
text: "rgba(255, 255, 255, 1)", // RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link: "rgba(255, 255, 255, 1)", // RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover: "rgba(255, 255, 255, 1)", // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
trackPlayed: "rgba(255, 255, 255, 1)", // RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed: "rgba(255, 255, 255, 1)", // RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground: "rgba(255, 255, 255, 1)", // RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop: "rgba(255, 255, 255, 1)", // RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom: "rgba(255, 255, 255, 1)", // RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText: "rgba(255, 255, 255, 1)", // RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi: true, // enable/disable player SDK access. Default: true
enableControls: true, // enable/disable player controls. Default: true
forceAutoplay: true, // enable/disable player autoplay. Default: false
hideTitle: true, // enable/disable title. Default: false
forceLoop: true, // enable/disable looping. Default: false
};
const playerTheme = await client.playerThemes.create(playerThemeCreationPayload);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#create
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # PlayerThemeCreationPayload |
# example passing only required values which don't have defaults set
# Create a player
=
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#create
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#create
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class createExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerThemeCreationPayload = new PlayerThemeCreationPayload(); // PlayerThemeCreationPayload |
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Create a player
PlayerTheme result = apiPlayerThemesInstance.create(playerThemeCreationPayload);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.create: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#create
ApiVideoClient.apiKey =
let videoCreationPayload = PlayerThemeCreationPayload(
text = , // RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link = , // RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover = , // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
trackPlayed = , // RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed = , // RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground = , // RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop = , // RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom = , // RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText = , // RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi = true, // enable/disable player SDK access. Default: true
enableControls = true, // enable/disable player controls. Default: true
forceAutoplay = true, // enable/disable player autoplay. Default: false
hideTitle = true, // enable/disable title. Default: false
forceLoop = true // enable/disable looping. Default: false
)
PlayerThemesAPI.create(playerThemeCreationPayload: playerThemeCreationPayload) { (response, error) in
}
Response
Created
name
string
The name of the player theme
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
playerId
string
required
- Example
- "pl45KFKdlddgk654dspkze"
createdAt
string
date-time
When the player was created, presented in ISO-8601 format.
- Example
- "2020-01-31T10:17:47+00:00"
updatedAt
string
date-time
When the player was last updated, presented in ISO-8601 format.
- Example
- "2020-01-31T10:18:47+00:00"
assets
object (assets)
logo
string
The name of the file containing the logo you want to use.
- Example
- "mylogo.jpg"
link
string
The path to the file containing your logo.
- Example
- "path/to/my/logo/mylogo.jpg"
apiKey
playerId
string
required
The unique identifier for the player you want to retrieve.
- Example
- "pl45d5vFFGrfdsdsd156dGhh"
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#get
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#get
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerId = 'pl45d5vFFGrfdsdsd156dGhh'; // The unique identifier for the player you want to retrieve.
const playerTheme = await client.playerThemes.get(playerId);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#get
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | The unique identifier for the player you want to retrieve.
# example passing only required values which don't have defaults set
# Show a player
=
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#get
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#get
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class getExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerId = pl45d5vFFGrfdsdsd156dGhh; // string | The unique identifier for the player you want to retrieve.
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Show a player
PlayerTheme result = apiPlayerThemesInstance.get(playerId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.get: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#get
Response
Success
Not Found
name
string
The name of the player theme
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
playerId
string
required
- Example
- "pl45KFKdlddgk654dspkze"
createdAt
string
date-time
When the player was created, presented in ISO-8601 format.
- Example
- "2020-01-31T10:17:47+00:00"
updatedAt
string
date-time
When the player was last updated, presented in ISO-8601 format.
- Example
- "2020-01-31T10:18:47+00:00"
assets
object (assets)
logo
string
The name of the file containing the logo you want to use.
- Example
- "mylogo.jpg"
link
string
The path to the file containing your logo.
- Example
- "path/to/my/logo/mylogo.jpg"
type
string
title
string
name
string
status
int
Delete a player
Delete a player if you no longer need it. You can delete any player that you have the player ID for.
apiKey
playerId
string
required
The unique identifier for the player you want to delete.
- Example
- "pl45d5vFFGrfdsdsd156dGhh"
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#delete
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#delete
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerId = 'pl45d5vFFGrfdsdsd156dGhh'; // The unique identifier for the player you want to delete.
await client.playerThemes.delete(playerId);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#delete
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | The unique identifier for the player you want to delete.
# example passing only required values which don't have defaults set
# Delete a player
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#delete
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#delete
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class deleteExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerId = pl45d5vFFGrfdsdsd156dGhh; // string | The unique identifier for the player you want to delete.
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Delete a player
apiPlayerThemesInstance.delete(playerId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.delete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#delete
Response
No Content
Empty response
Not Found
No schema
type
string
title
string
name
string
status
int
Update a player
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.
apiKey
playerId
string
required
The unique identifier for the player.
- Example
- "pl45d5vFFGrfdsdsd156dGhh"
name
string
Add a name for your player theme here.
- Max Length
- 100
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#update
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#update
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerId = 'pl45d5vFFGrfdsdsd156dGhh'; // The unique identifier for the player.
const playerThemeUpdatePayload = {
text: "rgba(255, 255, 255, 1)", // RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link: "rgba(255, 255, 255, 1)", // RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover: "rgba(255, 255, 255, 1)", // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
trackPlayed: "rgba(255, 255, 255, 1)", // RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed: "rgba(255, 255, 255, 1)", // RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground: "rgba(255, 255, 255, 1)", // RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop: "rgba(255, 255, 255, 1)", // RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom: "rgba(255, 255, 255, 1)", // RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText: "rgba(255, 255, 255, 1)", // RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi: true, // enable/disable player SDK access. Default: true
enableControls: true, // enable/disable player controls. Default: true
forceAutoplay: true, // enable/disable player autoplay. Default: false
hideTitle: true, // enable/disable title. Default: false
forceLoop: true, // enable/disable looping. Default: false
};
const playerTheme = await client.playerThemes.update(playerId, playerThemeUpdatePayload);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#update
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | The unique identifier for the player.
= # PlayerThemeUpdatePayload |
# example passing only required values which don't have defaults set
# Update a player
=
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#update
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#update
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class updateExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerId = pl45d5vFFGrfdsdsd156dGhh; // string | The unique identifier for the player.
var playerThemeUpdatePayload = new PlayerThemeUpdatePayload(); // PlayerThemeUpdatePayload |
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Update a player
PlayerTheme result = apiPlayerThemesInstance.update(playerId, playerThemeUpdatePayload);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.update: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#update
Response
Success
Not Found
name
string
The name of the player theme
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
playerId
string
required
- Example
- "pl45KFKdlddgk654dspkze"
createdAt
string
date-time
When the player was created, presented in ISO-8601 format.
- Example
- "2020-01-31T10:17:47+00:00"
updatedAt
string
date-time
When the player was last updated, presented in ISO-8601 format.
- Example
- "2020-01-31T10:18:47+00:00"
assets
object (assets)
logo
string
The name of the file containing the logo you want to use.
- Example
- "mylogo.jpg"
link
string
The path to the file containing your logo.
- Example
- "path/to/my/logo/mylogo.jpg"
type
string
title
string
name
string
status
int
Upload a logo
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
orimage/png
. api.video recommends usingpng
images with transparent background. - The image size should be a maximum of 200px width x 100px.
- The file size should be a maximum of 100 KiB.
apiKey
playerId
string
required
The unique identifier for the player.
- Example
- "pl14Db6oMJRH6SRVoOwORacK"
file
file
required
The name of the file you want to use for your logo.
- Example
- "mylogo.jpg"
link
string
string
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.
- Example
- "https://my-company.com"
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#uploadLogo
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#uploadLogo
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerId = 'pl14Db6oMJRH6SRVoOwORacK'; // The unique identifier for the player.
const file = './company-logo.jpg'; // The name of the file you want to use for your logo.
const link = 'https://my-company.org'; // 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.
const playerTheme = await client.playerThemes.uploadLogo(playerId, file, link);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#uploadLogo
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | The unique identifier for the player.
= # file_type | The name of the file you want to use for your logo.
= # str | 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. (optional)
# example passing only required values which don't have defaults set
# Upload a logo
=
# example passing only required values which don't have defaults set
# and optional values
# Upload a logo
=
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#uploadLogo
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#uploadLogo
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class uploadLogoExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerId = pl14Db6oMJRH6SRVoOwORacK; // string | The unique identifier for the player.
var file = BINARY_DATA_HERE; // System.IO.Stream | The name of the file you want to use for your logo.
var link = link_example; // string | 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. (optional)
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Upload a logo
PlayerTheme result = apiPlayerThemesInstance.uploadLogo(playerId, file, link);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.uploadLogo: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#uploadLogo
Response
Created
Bad Request
Not Found
name
string
The name of the player theme
text
string
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
link
string
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
linkActive
string
RGBA color for the play button when hovered.
trackPlayed
string
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
trackBackground
string
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
backgroundTop
string
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
backgroundBottom
string
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string
RGBA color for title text. Default: rgba(255, 255, 255, 1)
enableApi
boolean
enable/disable player SDK access. Default: true
enableControls
boolean
enable/disable player controls. Default: true
forceAutoplay
boolean
enable/disable player autoplay. Default: false
hideTitle
boolean
enable/disable title. Default: false
forceLoop
boolean
enable/disable looping. Default: false
playerId
string
required
- Example
- "pl45KFKdlddgk654dspkze"
createdAt
string
date-time
When the player was created, presented in ISO-8601 format.
- Example
- "2020-01-31T10:17:47+00:00"
updatedAt
string
date-time
When the player was last updated, presented in ISO-8601 format.
- Example
- "2020-01-31T10:18:47+00:00"
assets
object (assets)
logo
string
The name of the file containing the logo you want to use.
- Example
- "mylogo.jpg"
link
string
The path to the file containing your logo.
- Example
- "path/to/my/logo/mylogo.jpg"
type
string
A link to the error documentation.
title
string
A description of the error that occurred.
name
string
The name of the parameter that caused the error.
status
int
The HTTP status code.
problems
array[object (BadRequest)]
Returns any additional problems in the request in an array of objects.
BadRequest
object (BadRequest)
type
string
A link to the error documentation.
title
string
A description of the error that occurred.
name
string
The name of the parameter that caused the error.
status
int
The HTTP status code.
type
string
title
string
name
string
status
int
apiKey
playerId
string
required
The unique identifier for the player.
- Example
- "pl14Db6oMJRH6SRVoOwORacK"
Request
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesApi.md#deleteLogo
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main()
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#deleteLogo
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const playerId = 'pl45d5vFFGrfdsdsd156dGhh'; // The unique identifier for the player whose logo you want to delete.
await client.playerThemes.deleteLogo(playerId);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/PlayerThemesApi.md#deleteLogo
# Enter a context with an instance of the API client
# Create an instance of the API class
=
= # str | The unique identifier for the player.
# example passing only required values which don't have defaults set
# Delete logo
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#deleteLogo
;
;
;
;
;
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#deleteLogo
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class deleteLogoExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var playerId = pl14Db6oMJRH6SRVoOwORacK; // string | The unique identifier for the player.
var apiPlayerThemesInstance = apiInstance.PlayerThemes();
try
{
// Delete logo
apiPlayerThemesInstance.deleteLogo(playerId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PlayerThemesApi.deleteLogo: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
// First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#deleteLogo
Response
No Content
Empty response
Not Found
No schema
type
string
title
string
name
string
status
int
Was this page helpful?