@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
83 lines (82 loc) • 3.13 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import DefaultApi from './default/DefaultApi';
import CustomdataApi from './customdata/CustomdataApi';
import StreamsApi from './streams/StreamsApi';
import MediaApi from './media/MediaApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import HlsManifest from '../../../models/HlsManifest';
import StartManifestRequest from '../../../models/StartManifestRequest';
import Task from '../../../models/Task';
import PaginationResponse from '../../../models/PaginationResponse';
import { HlsManifestListQueryParams, HlsManifestListQueryParamsBuilder } from './HlsManifestListQueryParams';
/**
* HlsApi - object-oriented interface
* @export
* @class HlsApi
* @extends {BaseAPI}
*/
export default class HlsApi extends BaseAPI {
default: DefaultApi;
customdata: CustomdataApi;
streams: StreamsApi;
media: MediaApi;
constructor(configuration: Configuration);
/**
* @summary Create Custom HLS Manifest
* @param {HlsManifest} hlsManifest The Custom HLS Manifest to be created.
* @throws {BitmovinError}
* @memberof HlsApi
*/
create(hlsManifest?: HlsManifest): Promise<HlsManifest>;
/**
* @summary Delete HLS Manifest
* @param {string} manifestId Id of the HLS Manifest.
* @throws {BitmovinError}
* @memberof HlsApi
*/
delete(manifestId: string): Promise<BitmovinResponse>;
/**
* @summary HLS Manifest Details
* @param {string} manifestId Id of the HLS Manifest.
* @throws {BitmovinError}
* @memberof HlsApi
*/
get(manifestId: string): Promise<HlsManifest>;
/**
* @summary Manifest Start Details
* @param {string} manifestId ID of the manifest
* @throws {BitmovinError}
* @memberof HlsApi
*/
getStartRequest(manifestId: string): Promise<StartManifestRequest>;
/**
* @summary List HLS Manifests
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof HlsApi
*/
list(queryParameters?: HlsManifestListQueryParams | ((q: HlsManifestListQueryParamsBuilder) => HlsManifestListQueryParamsBuilder)): Promise<PaginationResponse<HlsManifest>>;
/**
* @summary Start HLS manifest generation
* @param {string} manifestId Id of the HLS Manifest.
* @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
* @throws {BitmovinError}
* @memberof HlsApi
*/
start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
/**
* @summary HLS manifest generation status
* @param {string} manifestId Id of the HLS Manifest.
* @throws {BitmovinError}
* @memberof HlsApi
*/
status(manifestId: string): Promise<Task>;
/**
* @summary Stop HLS manifest generation
* @param {string} manifestId Id of the HLS Manifest.
* @throws {BitmovinError}
* @memberof HlsApi
*/
stop(manifestId: string): Promise<BitmovinResponse>;
}