@bitmovin/api-sdk/dist/encoding/manifests/smooth/SmoothApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import DefaultApi from './default/DefaultApi';
import CustomdataApi from './customdata/CustomdataApi';
import RepresentationsApi from './representations/RepresentationsApi';
import ContentprotectionApi from './contentprotection/ContentprotectionApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import SmoothStreamingManifest from '../../../models/SmoothStreamingManifest';
import StartManifestRequest from '../../../models/StartManifestRequest';
import Task from '../../../models/Task';
import PaginationResponse from '../../../models/PaginationResponse';
import { SmoothStreamingManifestListQueryParams, SmoothStreamingManifestListQueryParamsBuilder } from './SmoothStreamingManifestListQueryParams';
/**
 * SmoothApi - object-oriented interface
 * @export
 * @class SmoothApi
 * @extends {BaseAPI}
 */
export default class SmoothApi extends BaseAPI {
    default: DefaultApi;
    customdata: CustomdataApi;
    representations: RepresentationsApi;
    contentprotection: ContentprotectionApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Smooth Streaming Manifest
     * @param {SmoothStreamingManifest} smoothStreamingManifest The Custom Smooth Streaming Manifest to be created.
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    create(smoothStreamingManifest?: SmoothStreamingManifest): Promise<SmoothStreamingManifest>;
    /**
     * @summary Delete Smooth Streaming Manifest
     * @param {string} manifestId Id of the Smooth Streaming Manifest.
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    delete(manifestId: string): Promise<BitmovinResponse>;
    /**
     * @summary Smooth Streaming Manifest Details
     * @param {string} manifestId Id of the Smooth Streaming Manifest.
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    get(manifestId: string): Promise<SmoothStreamingManifest>;
    /**
     * @summary Manifest Start Details
     * @param {string} manifestId Id of the manifest
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    getStartRequest(manifestId: string): Promise<StartManifestRequest>;
    /**
     * @summary List Smooth Streaming Manifests
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    list(queryParameters?: SmoothStreamingManifestListQueryParams | ((q: SmoothStreamingManifestListQueryParamsBuilder) => SmoothStreamingManifestListQueryParamsBuilder)): Promise<PaginationResponse<SmoothStreamingManifest>>;
    /**
     * @summary Start Smooth Streaming manifest generation
     * @param {string} manifestId Id of the Smooth Streaming Manifest.
     * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
    /**
     * @summary Smooth Streaming manifest generation status
     * @param {string} manifestId Id of the Smooth Streaming Manifest.
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    status(manifestId: string): Promise<Task>;
    /**
     * @summary Stop Smooth Streaming manifest generation
     * @param {string} manifestId Id of the Smooth Streaming Manifest.
     * @throws {BitmovinError}
     * @memberof SmoothApi
     */
    stop(manifestId: string): Promise<BitmovinResponse>;
}