@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 2.07 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import VorbisAudioConfiguration from '../../../../models/VorbisAudioConfiguration';
import PaginationResponse from '../../../../models/PaginationResponse';
import { VorbisAudioConfigurationListQueryParams, VorbisAudioConfigurationListQueryParamsBuilder } from './VorbisAudioConfigurationListQueryParams';
/**
* VorbisApi - object-oriented interface
* @export
* @class VorbisApi
* @extends {BaseAPI}
*/
export default class VorbisApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create Vorbis Codec Configuration
* @param {VorbisAudioConfiguration} vorbisAudioConfiguration The Vorbis Codec Configuration to be created
* @throws {BitmovinError}
* @memberof VorbisApi
*/
create(vorbisAudioConfiguration?: VorbisAudioConfiguration): Promise<VorbisAudioConfiguration>;
/**
* @summary Delete Vorbis Codec Configuration
* @param {string} configurationId Id of the codec configuration
* @throws {BitmovinError}
* @memberof VorbisApi
*/
delete(configurationId: string): Promise<BitmovinResponse>;
/**
* @summary Vorbis Codec Configuration Details
* @param {string} configurationId Id of the codec configuration
* @throws {BitmovinError}
* @memberof VorbisApi
*/
get(configurationId: string): Promise<VorbisAudioConfiguration>;
/**
* @summary List Vorbis Configurations
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof VorbisApi
*/
list(queryParameters?: VorbisAudioConfigurationListQueryParams | ((q: VorbisAudioConfigurationListQueryParamsBuilder) => VorbisAudioConfigurationListQueryParamsBuilder)): Promise<PaginationResponse<VorbisAudioConfiguration>>;
}