@bitmovin/api-sdk/dist/encoding/encodings/scte35Triggers/Scte35TriggersApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import BitmovinResponse from '../../../models/BitmovinResponse';
import Scte35Trigger from '../../../models/Scte35Trigger';
import PaginationResponse from '../../../models/PaginationResponse';
import { Scte35TriggerListQueryParams, Scte35TriggerListQueryParamsBuilder } from './Scte35TriggerListQueryParams';
/**
 * Scte35TriggersApi - object-oriented interface
 * @export
 * @class Scte35TriggersApi
 * @extends {BaseAPI}
 */
export default class Scte35TriggersApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Create SCTE 35 trigger
     * @param {string} encodingId Id of the encoding.
     * @param {Scte35Trigger} scte35Trigger The SCTE 35 trigger to be created
     * @throws {BitmovinError}
     * @memberof Scte35TriggersApi
     */
    create(encodingId: string, scte35Trigger?: Scte35Trigger): Promise<Scte35Trigger>;
    /**
     * @summary Delete SCTE 35 trigger
     * @param {string} encodingId Id of the encoding
     * @param {string} scte35triggerId Id of the SCTE 35 trigger
     * @throws {BitmovinError}
     * @memberof Scte35TriggersApi
     */
    delete(encodingId: string, scte35triggerId: string): Promise<BitmovinResponse>;
    /**
     * @summary SCTE 35 trigger Details
     * @param {string} encodingId Id of the encoding
     * @param {string} scte35triggerId Id of the SCTE 35 trigger
     * @throws {BitmovinError}
     * @memberof Scte35TriggersApi
     */
    get(encodingId: string, scte35triggerId: string): Promise<Scte35Trigger>;
    /**
     * @summary List all SCTE 35 triggers for an encoding
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof Scte35TriggersApi
     */
    list(encodingId: string, queryParameters?: Scte35TriggerListQueryParams | ((q: Scte35TriggerListQueryParamsBuilder) => Scte35TriggerListQueryParamsBuilder)): Promise<PaginationResponse<Scte35Trigger>>;
}