cloudflare/resources/stream/captions.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CaptionsAPI from 'cloudflare/resources/stream/captions';
export declare class Captions extends APIResource {
    /**
     * Uploads the caption or subtitle file to the endpoint for a specific BCP47
     * language. One caption or subtitle file per language is allowed.
     */
    update(identifier: string, language: string, params: CaptionUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CaptionUpdateResponse>;
    /**
     * Removes the captions or subtitles from a video.
     */
    delete(identifier: string, language: string, params: CaptionDeleteParams, options?: Core.RequestOptions): Core.APIPromise<CaptionDeleteResponse>;
    /**
     * Lists the available captions or subtitles for a specific video.
     */
    get(identifier: string, params: CaptionGetParams, options?: Core.RequestOptions): Core.APIPromise<CaptionGetResponse>;
}
export interface StreamCaptions {
    /**
     * The language label displayed in the native language to users.
     */
    label?: string;
    /**
     * The language tag in BCP 47 format.
     */
    language?: string;
}
export type CaptionUpdateResponse = unknown | string;
export type CaptionDeleteResponse = unknown | Array<unknown> | string;
export type CaptionGetResponse = Array<StreamCaptions>;
export interface CaptionUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The WebVTT file containing the caption or subtitle content.
     */
    file: string;
}
export interface CaptionDeleteParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface CaptionGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace Captions {
    export import StreamCaptions = CaptionsAPI.StreamCaptions;
    export import CaptionUpdateResponse = CaptionsAPI.CaptionUpdateResponse;
    export import CaptionDeleteResponse = CaptionsAPI.CaptionDeleteResponse;
    export import CaptionGetResponse = CaptionsAPI.CaptionGetResponse;
    export import CaptionUpdateParams = CaptionsAPI.CaptionUpdateParams;
    export import CaptionDeleteParams = CaptionsAPI.CaptionDeleteParams;
    export import CaptionGetParams = CaptionsAPI.CaptionGetParams;
}
//# sourceMappingURL=captions.d.ts.map