cloudflare
Version:
The official TypeScript library for the Cloudflare API
118 lines • 4.03 kB
text/typescript
import { APIResource } from "../../../../core/resource.mjs";
import * as CaptionsAPI from "../captions.mjs";
import * as VttAPI from "./vtt.mjs";
import { BaseVtt, Vtt, VttGetParams, VttGetResponse } from "./vtt.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class BaseLanguage extends APIResource {
static readonly _key: readonly ['stream', 'captions', 'language'];
/**
* Generate captions or subtitles for provided language via AI.
*
* @example
* ```ts
* const caption =
* await client.stream.captions.language.create('tr', {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* identifier: 'ea95132c15732412d22c1476fa83f27a',
* });
* ```
*/
create(language: string, params: LanguageCreateParams, options?: RequestOptions): APIPromise<CaptionsAPI.Caption>;
/**
* Uploads the caption or subtitle file to the endpoint for a specific BCP47
* language. One caption or subtitle file per language is allowed.
*
* @example
* ```ts
* const caption =
* await client.stream.captions.language.update('tr', {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* identifier: 'ea95132c15732412d22c1476fa83f27a',
* file: '@/Users/kyle/Desktop/tr.vtt',
* });
* ```
*/
update(language: string, params: LanguageUpdateParams, options?: RequestOptions): APIPromise<CaptionsAPI.Caption>;
/**
* Removes the captions or subtitles from a video.
*
* @example
* ```ts
* const language =
* await client.stream.captions.language.delete('tr', {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* identifier: 'ea95132c15732412d22c1476fa83f27a',
* });
* ```
*/
delete(language: string, params: LanguageDeleteParams, options?: RequestOptions): APIPromise<LanguageDeleteResponse>;
/**
* Lists the captions or subtitles for provided language.
*
* @example
* ```ts
* const caption = await client.stream.captions.language.get(
* 'tr',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* identifier: 'ea95132c15732412d22c1476fa83f27a',
* },
* );
* ```
*/
get(language: string, params: LanguageGetParams, options?: RequestOptions): APIPromise<CaptionsAPI.Caption>;
}
export declare class Language extends BaseLanguage {
vtt: VttAPI.Vtt;
}
export type LanguageDeleteResponse = string;
export interface LanguageCreateParams {
/**
* Identifier.
*/
account_id: string;
/**
* A Cloudflare-generated unique identifier for a media item.
*/
identifier: string;
}
export interface LanguageUpdateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Path param: A Cloudflare-generated unique identifier for a media item.
*/
identifier: string;
/**
* Body param: The WebVTT file containing the caption or subtitle content.
*/
file: string;
}
export interface LanguageDeleteParams {
/**
* Identifier.
*/
account_id: string;
/**
* A Cloudflare-generated unique identifier for a media item.
*/
identifier: string;
}
export interface LanguageGetParams {
/**
* Identifier.
*/
account_id: string;
/**
* A Cloudflare-generated unique identifier for a media item.
*/
identifier: string;
}
export declare namespace Language {
export { type LanguageDeleteResponse as LanguageDeleteResponse, type LanguageCreateParams as LanguageCreateParams, type LanguageUpdateParams as LanguageUpdateParams, type LanguageDeleteParams as LanguageDeleteParams, type LanguageGetParams as LanguageGetParams, };
export { Vtt as Vtt, BaseVtt as BaseVtt, type VttGetResponse as VttGetResponse, type VttGetParams as VttGetParams, };
}
//# sourceMappingURL=language.d.mts.map