@bitmovin/api-sdk/dist/encoding/manifests/dash/periods/adaptationsets/representations/sprite/SpriteApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../common/Configuration';
import BitmovinResponse from '../../../../../../../models/BitmovinResponse';
import SpriteRepresentation from '../../../../../../../models/SpriteRepresentation';
import PaginationResponse from '../../../../../../../models/PaginationResponse';
import { SpriteRepresentationListQueryParams, SpriteRepresentationListQueryParamsBuilder } from './SpriteRepresentationListQueryParams';
/**
 * SpriteApi - object-oriented interface
 * @export
 * @class SpriteApi
 * @extends {BaseAPI}
 */
export default class SpriteApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Add Sprite Representation
     * @param {string} manifestId Id of the manifest
     * @param {string} periodId Id of the period
     * @param {string} adaptationsetId Id of the image adaptation set
     * @param {SpriteRepresentation} spriteRepresentation The Sprite representation to be added to the adaptation set. Note that the adaptation set has to be an image adaptation set.  Only supported for sprites generated with encoder version `2.76.0` or above.
     * @throws {BitmovinError}
     * @memberof SpriteApi
     */
    create(manifestId: string, periodId: string, adaptationsetId: string, spriteRepresentation?: SpriteRepresentation): Promise<SpriteRepresentation>;
    /**
     * @summary Delete Sprite Representation
     * @param {string} manifestId Id of the manifest
     * @param {string} periodId Id of the period
     * @param {string} adaptationsetId Id of the adaptation set
     * @param {string} representationId Id of the Sprite representation to be deleted
     * @throws {BitmovinError}
     * @memberof SpriteApi
     */
    delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>;
    /**
     * @summary Sprite Representation Details
     * @param {string} manifestId Id of the manifest
     * @param {string} periodId Id of the period
     * @param {string} adaptationsetId Id of the adaptation set
     * @param {string} representationId Id of the Sprite representation
     * @throws {BitmovinError}
     * @memberof SpriteApi
     */
    get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<SpriteRepresentation>;
    /**
     * @summary List all Sprite Representations
     * @param {string} manifestId Id of the manifest
     * @param {string} periodId Id of the period
     * @param {string} adaptationsetId Id of the adaptation set
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SpriteApi
     */
    list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters?: SpriteRepresentationListQueryParams | ((q: SpriteRepresentationListQueryParamsBuilder) => SpriteRepresentationListQueryParamsBuilder)): Promise<PaginationResponse<SpriteRepresentation>>;
}