@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
100 lines (99 loc) • 4.14 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 SccCaption_1 = require("../../../../../../models/SccCaption");
const PaginationResponse_1 = require("../../../../../../models/PaginationResponse");
const SccCaptionListQueryParams_1 = require("./SccCaptionListQueryParams");
/**
* SccApi - object-oriented interface
* @export
* @class SccApi
* @extends {BaseAPI}
*/
class SccApi extends BaseAPI_1.BaseAPI {
constructor(configuration) {
super(configuration);
this.customdata = new CustomdataApi_1.default(configuration);
}
/**
* @summary Embed SCC captions as 608/708 into Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {SccCaption} sccCaption The SCC captions to be embedded as 607/708 into Stream
* @throws {BitmovinError}
* @memberof SccApi
*/
create(encodingId, streamId, sccCaption) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId
};
return this.restClient.post('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/scc', pathParamMap, sccCaption).then((response) => {
return (0, Mapper_1.map)(response, SccCaption_1.default);
});
}
/**
* @summary Delete SCC captions as 608/708 from Stream
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} captionsId Id of the caption.
* @throws {BitmovinError}
* @memberof SccApi
*/
delete(encodingId, streamId, captionsId) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId,
captions_id: captionsId
};
return this.restClient.delete('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/scc/{captions_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
});
}
/**
* @summary Embed SCC captions as 608/708 Details
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {string} captionsId Id of the caption.
* @throws {BitmovinError}
* @memberof SccApi
*/
get(encodingId, streamId, captionsId) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId,
captions_id: captionsId
};
return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/scc/{captions_id}', pathParamMap).then((response) => {
return (0, Mapper_1.map)(response, SccCaption_1.default);
});
}
/**
* @summary List SCC captions as 608/708 from Stream
* @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 SccApi
*/
list(encodingId, streamId, queryParameters) {
const pathParamMap = {
encoding_id: encodingId,
stream_id: streamId
};
let queryParams = {};
if (typeof queryParameters === 'function') {
queryParams = queryParameters(new SccCaptionListQueryParams_1.SccCaptionListQueryParamsBuilder()).buildQueryParams();
}
else if (queryParameters) {
queryParams = queryParameters;
}
return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/scc', pathParamMap, queryParams).then((response) => {
return new PaginationResponse_1.default(response, SccCaption_1.default);
});
}
}
exports.default = SccApi;