@twick/studio - v0.15.0 / Exports / ICaptionGenerationService
Interface: ICaptionGenerationService
Table of contents
Properties
Properties
generateCaptionVideo
• Optional generateCaptionVideo: (videoUrl: string, videoSize?: { height: number ; width: number }) => Promise<string>
Type declaration
▸ (videoUrl, videoSize?): Promise<string>
Parameters
| Name | Type |
|---|---|
videoUrl | string |
videoSize? | Object |
videoSize.height | number |
videoSize.width | number |
Returns
Promise<string>
Defined in
generateCaptions
• generateCaptions: (videoElement: VideoElement, project: ProjectJSON, language?: string, phraseLength?: CaptionPhraseLength) => Promise<string>
Type declaration
▸ (videoElement, project, language?, phraseLength?): Promise<string>
Parameters
| Name | Type |
|---|---|
videoElement | VideoElement |
project | ProjectJSON |
language? | string |
phraseLength? | CaptionPhraseLength |
Returns
Promise<string>
Defined in
getRequestStatus
• getRequestStatus: (reqId: string) => Promise<ICaptionGenerationPollingResponse>
Type declaration
▸ (reqId): Promise<ICaptionGenerationPollingResponse>
Parameters
| Name | Type |
|---|---|
reqId | string |
Returns
Promise<ICaptionGenerationPollingResponse>
Defined in
pollingIntervalMs
• Optional pollingIntervalMs: number
Polling interval in milliseconds for caption status checks. Defaults to 5000.
Defined in
updateProjectWithCaptions
• updateProjectWithCaptions: (captions: CaptionEntry[]) => ProjectJSON
Type declaration
▸ (captions): ProjectJSON
Parameters
| Name | Type |
|---|---|
captions | CaptionEntry[] |
Returns
ProjectJSON