@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
45 lines (44 loc) • 1.58 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import SrtInput from '../../../models/SrtInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { SrtInputListQueryParams, SrtInputListQueryParamsBuilder } from './SrtInputListQueryParams';
/**
* SrtApi - object-oriented interface
* @export
* @class SrtApi
* @extends {BaseAPI}
*/
export default class SrtApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create SRT input
* @param {SrtInput} srtInput The SrtInput to be created
* @throws {BitmovinError}
* @memberof SrtApi
*/
create(srtInput?: SrtInput): Promise<SrtInput>;
/**
* @summary Delete SRT input
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof SrtApi
*/
delete(inputId: string): Promise<SrtInput>;
/**
* @summary SRT Input Details
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof SrtApi
*/
get(inputId: string): Promise<SrtInput>;
/**
* @summary List SRT inputs
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof SrtApi
*/
list(queryParameters?: SrtInputListQueryParams | ((q: SrtInputListQueryParamsBuilder) => SrtInputListQueryParamsBuilder)): Promise<PaginationResponse<SrtInput>>;
}