/** * @api.video/nodejs-client * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. * * The version of the OpenAPI document: 1 * * * NOTE: This class is auto generated. * Do not edit the class manually. */ import HttpClient, { ApiResponseHeaders } from '../HttpClient'; import PlayerTheme from '../model/PlayerTheme'; import PlayerThemeCreationPayload from '../model/PlayerThemeCreationPayload'; import PlayerThemeUpdatePayload from '../model/PlayerThemeUpdatePayload'; import PlayerThemesListResponse from '../model/PlayerThemesListResponse'; import { Readable } from 'stream'; /** * no description */ export default class PlayerThemesApi { private httpClient; constructor(httpClient: HttpClient); /** * Create a player for your video, and customise it. * Create a player * @param playerThemeCreationPayload */ create(playerThemeCreationPayload?: PlayerThemeCreationPayload): Promise; /** * Create a player for your video, and customise it. * Create a player * @param playerThemeCreationPayload */ createWithResponseHeaders(playerThemeCreationPayload?: PlayerThemeCreationPayload): Promise<{ headers: ApiResponseHeaders; body: PlayerTheme; }>; /** * Retreive a player theme by player id. * Retrieve a player * @param playerId The unique identifier for the player you want to retrieve. */ get(playerId: string): Promise; /** * Retreive a player theme by player id. * Retrieve a player * @param playerId The unique identifier for the player you want to retrieve. */ getWithResponseHeaders(playerId: string): Promise<{ headers: ApiResponseHeaders; body: PlayerTheme; }>; /** * 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. * Update a player * @param playerId The unique identifier for the player. * @param playerThemeUpdatePayload */ update(playerId: string, playerThemeUpdatePayload?: PlayerThemeUpdatePayload): Promise; /** * 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. * Update a player * @param playerId The unique identifier for the player. * @param playerThemeUpdatePayload */ updateWithResponseHeaders(playerId: string, playerThemeUpdatePayload?: PlayerThemeUpdatePayload): Promise<{ headers: ApiResponseHeaders; body: PlayerTheme; }>; /** * Delete a player if you no longer need it. You can delete any player that you have the player ID for. * Delete a player * @param playerId The unique identifier for the player you want to delete. */ delete(playerId: string): Promise; /** * Delete a player if you no longer need it. You can delete any player that you have the player ID for. * Delete a player * @param playerId The unique identifier for the player you want to delete. */ deleteWithResponseHeaders(playerId: string): Promise<{ headers: ApiResponseHeaders; body: void; }>; /** * Retrieve a list of all the player themes you created, as well as details about each one. * List all player themes * @param {Object} searchParams * @param { 'name' | 'createdAt' | 'updatedAt' } searchParams.sortBy createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. * @param { 'asc' | 'desc' } searchParams.sortOrder Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. * @param { number } searchParams.currentPage Choose the number of search results to return per page. Minimum value: 1 * @param { number } searchParams.pageSize Results per page. Allowed values 1-100, default is 25. */ list(args?: { sortBy?: 'name' | 'createdAt' | 'updatedAt'; sortOrder?: 'asc' | 'desc'; currentPage?: number; pageSize?: number; }): Promise; /** * Retrieve a list of all the player themes you created, as well as details about each one. * List all player themes * @param {Object} searchParams * @param { 'name' | 'createdAt' | 'updatedAt' } searchParams.sortBy createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. * @param { 'asc' | 'desc' } searchParams.sortOrder Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. * @param { number } searchParams.currentPage Choose the number of search results to return per page. Minimum value: 1 * @param { number } searchParams.pageSize Results per page. Allowed values 1-100, default is 25. */ listWithResponseHeaders({ sortBy, sortOrder, currentPage, pageSize, }?: { sortBy?: 'name' | 'createdAt' | 'updatedAt'; sortOrder?: 'asc' | 'desc'; currentPage?: number; pageSize?: number; }): Promise<{ headers: ApiResponseHeaders; body: PlayerThemesListResponse; }>; /** * 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`. api.video recommends using `png` 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. * Upload a logo * @param playerId The unique identifier for the player. * @param file The name of the file you want to use for your logo. * @param 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. */ uploadLogo(playerId: string, file: string | Readable | Buffer, link?: string): Promise; /** * 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`. api.video recommends using `png` 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. * Upload a logo * @param playerId The unique identifier for the player. * @param file The name of the file you want to use for your logo. * @param 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. */ uploadLogoWithResponseHeaders(playerId: string, file: string | Readable | Buffer, link?: string): Promise<{ headers: ApiResponseHeaders; body: PlayerTheme; }>; /** * Delete the logo associated to a player. * Delete logo * @param playerId The unique identifier for the player. */ deleteLogo(playerId: string): Promise; /** * Delete the logo associated to a player. * Delete logo * @param playerId The unique identifier for the player. */ deleteLogoWithResponseHeaders(playerId: string): Promise<{ headers: ApiResponseHeaders; body: void; }>; }