@bitmovin/api-sdk/dist/encoding/encodings/keyframes/KeyframesApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import BitmovinResponse from '../../../models/BitmovinResponse';
import Keyframe from '../../../models/Keyframe';
import PaginationResponse from '../../../models/PaginationResponse';
import { KeyframeListQueryParams, KeyframeListQueryParamsBuilder } from './KeyframeListQueryParams';
/**
 * KeyframesApi - object-oriented interface
 * @export
 * @class KeyframesApi
 * @extends {BaseAPI}
 */
export default class KeyframesApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Create Keyframes
     * @param {string} encodingId Id of the encoding.
     * @param {Keyframe} keyframe The Keyframes to be created
     * @throws {BitmovinError}
     * @memberof KeyframesApi
     */
    create(encodingId: string, keyframe?: Keyframe): Promise<Keyframe>;
    /**
     * @summary Delete Keyframe
     * @param {string} encodingId Id of the encoding.
     * @param {string} keyframeId Id of the keyframe.
     * @throws {BitmovinError}
     * @memberof KeyframesApi
     */
    delete(encodingId: string, keyframeId: string): Promise<BitmovinResponse>;
    /**
     * @summary Keyframe Details
     * @param {string} encodingId Id of the encoding.
     * @param {string} keyframeId Id of the keyframe.
     * @throws {BitmovinError}
     * @memberof KeyframesApi
     */
    get(encodingId: string, keyframeId: string): Promise<Keyframe>;
    /**
     * @summary List all Keyframes
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof KeyframesApi
     */
    list(encodingId: string, queryParameters?: KeyframeListQueryParams | ((q: KeyframeListQueryParamsBuilder) => KeyframeListQueryParamsBuilder)): Promise<PaginationResponse<Keyframe>>;
}