@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
106 lines (105 loc) • 5.06 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const BaseAPI_1 = require("../../../../../../../common/BaseAPI");
const Mapper_1 = require("../../../../../../../common/Mapper");
const BitmovinResponse_1 = require("../../../../../../../models/BitmovinResponse");
const SpriteRepresentation_1 = require("../../../../../../../models/SpriteRepresentation");
const PaginationResponse_1 = require("../../../../../../../models/PaginationResponse");
const SpriteRepresentationListQueryParams_1 = require("./SpriteRepresentationListQueryParams");
/**
* SpriteApi - object-oriented interface
* @export
* @class SpriteApi
* @extends {BaseAPI}
*/
class SpriteApi extends BaseAPI_1.BaseAPI {
constructor(configuration) {
super(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, periodId, adaptationsetId, spriteRepresentation) {
const pathParamMap = {
manifest_id: manifestId,
period_id: periodId,
adaptationset_id: adaptationsetId
};
return this.restClient.post('/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite', pathParamMap, spriteRepresentation).then((response) => {
return (0, Mapper_1.map)(response, SpriteRepresentation_1.default);
});
}
/**
* @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, periodId, adaptationsetId, representationId) {
const pathParamMap = {
manifest_id: manifestId,
period_id: periodId,
adaptationset_id: adaptationsetId,
representation_id: representationId
};
return this.restClient.delete('/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite/{representation_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
});
}
/**
* @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, periodId, adaptationsetId, representationId) {
const pathParamMap = {
manifest_id: manifestId,
period_id: periodId,
adaptationset_id: adaptationsetId,
representation_id: representationId
};
return this.restClient.get('/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite/{representation_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, SpriteRepresentation_1.default);
});
}
/**
* @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, periodId, adaptationsetId, queryParameters) {
const pathParamMap = {
manifest_id: manifestId,
period_id: periodId,
adaptationset_id: adaptationsetId
};
let queryParams = {};
if (typeof queryParameters === 'function') {
queryParams = queryParameters(new SpriteRepresentationListQueryParams_1.SpriteRepresentationListQueryParamsBuilder()).buildQueryParams();
}
else if (queryParameters) {
queryParams = queryParameters;
}
return this.restClient.get('/encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite', pathParamMap, queryParams).then((response) => {
return new PaginationResponse_1.default(response, SpriteRepresentation_1.default);
});
}
}
exports.default = SpriteApi;