@bitmovin/api-sdk/dist/encoding/encodings/streams/sprites/SpritesApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import Sprite from '../../../../models/Sprite';
import PaginationResponse from '../../../../models/PaginationResponse';
import { SpriteListQueryParams, SpriteListQueryParamsBuilder } from './SpriteListQueryParams';
/**
 * SpritesApi - object-oriented interface
 * @export
 * @class SpritesApi
 * @extends {BaseAPI}
 */
export default class SpritesApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add Sprite
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {Sprite} sprite The Sprite to be added
     * @throws {BitmovinError}
     * @memberof SpritesApi
     */
    create(encodingId: string, streamId: string, sprite?: Sprite): Promise<Sprite>;
    /**
     * @summary Delete Sprite
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} spriteId Id of the sprite.
     * @throws {BitmovinError}
     * @memberof SpritesApi
     */
    delete(encodingId: string, streamId: string, spriteId: string): Promise<BitmovinResponse>;
    /**
     * @summary Sprite Details
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} spriteId Id of the sprite configuration.
     * @throws {BitmovinError}
     * @memberof SpritesApi
     */
    get(encodingId: string, streamId: string, spriteId: string): Promise<Sprite>;
    /**
     * @summary List Sprites
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SpritesApi
     */
    list(encodingId: string, streamId: string, queryParameters?: SpriteListQueryParams | ((q: SpriteListQueryParamsBuilder) => SpriteListQueryParamsBuilder)): Promise<PaginationResponse<Sprite>>;
}