@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
100 lines (99 loc) • 3.88 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const BaseAPI_1 = require("../../../../common/BaseAPI");
const Mapper_1 = require("../../../../common/Mapper");
const CustomdataApi_1 = require("./customdata/CustomdataApi");
const BitmovinResponse_1 = require("../../../../models/BitmovinResponse");
const Sprite_1 = require("../../../../models/Sprite");
const PaginationResponse_1 = require("../../../../models/PaginationResponse");
const SpriteListQueryParams_1 = require("./SpriteListQueryParams");
/**
* SpritesApi - object-oriented interface
* @export
* @class SpritesApi
* @extends {BaseAPI}
*/
class SpritesApi extends BaseAPI_1.BaseAPI {
constructor(configuration) {
super(configuration);
this.customdata = new CustomdataApi_1.default(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, streamId, sprite) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId
};
return this.restClient.post('/encoding/encodings/{encoding_id}/streams/{stream_id}/sprites', pathParamMap, sprite).then((response) => {
return (0, Mapper_1.map)(response, Sprite_1.default);
});
}
/**
* @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, streamId, spriteId) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId,
sprite_id: spriteId
};
return this.restClient.delete('/encoding/encodings/{encoding_id}/streams/{stream_id}/sprites/{sprite_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
});
}
/**
* @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, streamId, spriteId) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId,
sprite_id: spriteId
};
return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/sprites/{sprite_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, Sprite_1.default);
});
}
/**
* @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, streamId, queryParameters) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId
};
let queryParams = {};
if (typeof queryParameters === 'function') {
queryParams = queryParameters(new SpriteListQueryParams_1.SpriteListQueryParamsBuilder()).buildQueryParams();
}
else if (queryParameters) {
queryParams = queryParameters;
}
return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/sprites', pathParamMap, queryParams).then((response) => {
return new PaginationResponse_1.default(response, Sprite_1.default);
});
}
}
exports.default = SpritesApi;