@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
53 lines (52 loc) • 2.18 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import TypeApi from './type/TypeApi';
import AudioMixApi from './audioMix/AudioMixApi';
import IngestApi from './ingest/IngestApi';
import SidecarApi from './sidecar/SidecarApi';
import ConcatenationApi from './concatenation/ConcatenationApi';
import FileApi from './file/FileApi';
import TrimmingApi from './trimming/TrimmingApi';
import SubtitlesApi from './subtitles/SubtitlesApi';
import CaptionsApi from './captions/CaptionsApi';
import DolbyAtmosApi from './dolbyAtmos/DolbyAtmosApi';
import DolbyVisionApi from './dolbyVision/DolbyVisionApi';
import InputStream from '../../../models/InputStream';
import PaginationResponse from '../../../models/PaginationResponse';
import { InputStreamListQueryParams, InputStreamListQueryParamsBuilder } from './InputStreamListQueryParams';
/**
* InputStreamsApi - object-oriented interface
* @export
* @class InputStreamsApi
* @extends {BaseAPI}
*/
export default class InputStreamsApi extends BaseAPI {
type: TypeApi;
audioMix: AudioMixApi;
ingest: IngestApi;
sidecar: SidecarApi;
concatenation: ConcatenationApi;
file: FileApi;
trimming: TrimmingApi;
subtitles: SubtitlesApi;
captions: CaptionsApi;
dolbyAtmos: DolbyAtmosApi;
dolbyVision: DolbyVisionApi;
constructor(configuration: Configuration);
/**
* @summary Input Stream Details
* @param {string} encodingId Id of the encoding.
* @param {string} inputStreamId Id of the input stream.
* @throws {BitmovinError}
* @memberof InputStreamsApi
*/
get(encodingId: string, inputStreamId: string): Promise<InputStream>;
/**
* @summary List All Input Streams
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof InputStreamsApi
*/
list(encodingId: string, queryParameters?: InputStreamListQueryParams | ((q: InputStreamListQueryParamsBuilder) => InputStreamListQueryParamsBuilder)): Promise<PaginationResponse<InputStream>>;
}