@bitmovin/api-sdk/dist/encoding/encodings/streams/watermarking/nexguardFileMarker/NexguardFileMarkerApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import NexGuardFileMarker from '../../../../../models/NexGuardFileMarker';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { NexGuardFileMarkerListQueryParams, NexGuardFileMarkerListQueryParamsBuilder } from './NexGuardFileMarkerListQueryParams';
/**
 * NexguardFileMarkerApi - object-oriented interface
 * @export
 * @class NexguardFileMarkerApi
 * @extends {BaseAPI}
 */
export default class NexguardFileMarkerApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add a nexguard file marker watermarking configurations
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {NexGuardFileMarker} nexGuardFileMarker The nexguard file marker configurations
     * @throws {BitmovinError}
     * @memberof NexguardFileMarkerApi
     */
    create(encodingId: string, streamId: string, nexGuardFileMarker?: NexGuardFileMarker): Promise<NexGuardFileMarker>;
    /**
     * @summary Delete nexguard file marker watermarking configurations
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} nexguardId Id of the nexguard file marker watermarking configurations
     * @throws {BitmovinError}
     * @memberof NexguardFileMarkerApi
     */
    delete(encodingId: string, streamId: string, nexguardId: string): Promise<BitmovinResponse>;
    /**
     * @summary Nexguard file marker watermarking configurations details
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} nexguardId Id of the nexguard file marker watermarking configurations.
     * @throws {BitmovinError}
     * @memberof NexguardFileMarkerApi
     */
    get(encodingId: string, streamId: string, nexguardId: string): Promise<NexGuardFileMarker>;
    /**
     * @summary List nexguard file marker watermarking configurations
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof NexguardFileMarkerApi
     */
    list(encodingId: string, streamId: string, queryParameters?: NexGuardFileMarkerListQueryParams | ((q: NexGuardFileMarkerListQueryParamsBuilder) => NexGuardFileMarkerListQueryParamsBuilder)): Promise<PaginationResponse<NexGuardFileMarker>>;
}