@bitmovin/api-sdk/dist/encoding/manifests/dash/DashApi.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 PeriodsApi from './periods/PeriodsApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import DashManifest from '../../../models/DashManifest';
import StartManifestRequest from '../../../models/StartManifestRequest';
import Task from '../../../models/Task';
import PaginationResponse from '../../../models/PaginationResponse';
import { DashManifestListQueryParams, DashManifestListQueryParamsBuilder } from './DashManifestListQueryParams';
/**
 * DashApi - object-oriented interface
 * @export
 * @class DashApi
 * @extends {BaseAPI}
 */
export default class DashApi extends BaseAPI {
    default: DefaultApi;
    customdata: CustomdataApi;
    periods: PeriodsApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Custom DASH Manifest
     * @param {DashManifest} dashManifest The Custom DASH Manifest to be created.
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    create(dashManifest?: DashManifest): Promise<DashManifest>;
    /**
     * @summary Delete DASH Manifest
     * @param {string} manifestId UUID of the DASH Manifest to be deleted
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    delete(manifestId: string): Promise<BitmovinResponse>;
    /**
     * @summary DASH Manifest Details
     * @param {string} manifestId UUID of the DASH Manifest
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    get(manifestId: string): Promise<DashManifest>;
    /**
     * @summary Manifest Start Details
     * @param {string} manifestId Id of the manifest
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    getStartRequest(manifestId: string): Promise<StartManifestRequest>;
    /**
     * @summary List DASH Manifests
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    list(queryParameters?: DashManifestListQueryParams | ((q: DashManifestListQueryParamsBuilder) => DashManifestListQueryParamsBuilder)): Promise<PaginationResponse<DashManifest>>;
    /**
     * @summary Start DASH manifest generation
     * @param {string} manifestId Id of the DASH Manifest.
     * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
    /**
     * @summary DASH manifest generation status
     * @param {string} manifestId Id of the DASH Manifest.
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    status(manifestId: string): Promise<Task>;
    /**
     * @summary Stop DASH manifest generation
     * @param {string} manifestId Id of the DASH Manifest.
     * @throws {BitmovinError}
     * @memberof DashApi
     */
    stop(manifestId: string): Promise<BitmovinResponse>;
}