@bitmovin/api-sdk/dist/encoding/live/streamKeys/StreamKeysApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import ActionsApi from './actions/ActionsApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import StreamKey from '../../../models/StreamKey';
import PaginationResponse from '../../../models/PaginationResponse';
import { StreamKeyListQueryParams, StreamKeyListQueryParamsBuilder } from './StreamKeyListQueryParams';
/**
 * StreamKeysApi - object-oriented interface
 * @export
 * @class StreamKeysApi
 * @extends {BaseAPI}
 */
export default class StreamKeysApi extends BaseAPI {
    actions: ActionsApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create new stream key
     * @param {StreamKey} streamKey The stream key to be created
     * @throws {BitmovinError}
     * @memberof StreamKeysApi
     */
    create(streamKey?: StreamKey): Promise<StreamKey>;
    /**
     * @summary Delete Stream Key
     * @param {string} streamKeyId Id of the stream key
     * @throws {BitmovinError}
     * @memberof StreamKeysApi
     */
    delete(streamKeyId: string): Promise<BitmovinResponse>;
    /**
     * @summary Stream Key details
     * @param {string} streamKeyId Id of the stream key
     * @throws {BitmovinError}
     * @memberof StreamKeysApi
     */
    get(streamKeyId: string): Promise<StreamKey>;
    /**
     * @summary List Stream Keys
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof StreamKeysApi
     */
    list(queryParameters?: StreamKeyListQueryParams | ((q: StreamKeyListQueryParamsBuilder) => StreamKeyListQueryParamsBuilder)): Promise<PaginationResponse<StreamKey>>;
}