@twick/studio - v0.15.0 / Exports / ISubtitleGenerationService

Interface: ISubtitleGenerationService

Table of contents

Properties

• generateSubtitleVideo
• generateSubtitles
• getRequestStatus
• updateProjectWithSubtitles

Properties

generateSubtitleVideo

• Optional generateSubtitleVideo: (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

studio/src/types/index.ts:88

---

generateSubtitles

• generateSubtitles: (videoElement: VideoElement, project: ProjectJSON) => Promise<string>

Type declaration

▸ (videoElement, project): Promise<string>

Parameters

Name	Type
videoElement	VideoElement
project	ProjectJSON

Returns

Promise<string>

Defined in

studio/src/types/index.ts:79

---

getRequestStatus

• getRequestStatus: (reqId: string) => Promise<ISubtitleGenerationPollingResponse>

Type declaration

▸ (reqId): Promise<ISubtitleGenerationPollingResponse>

Parameters

Name	Type
reqId	string

Returns

Promise<ISubtitleGenerationPollingResponse>

Defined in

studio/src/types/index.ts:93

---

updateProjectWithSubtitles

• updateProjectWithSubtitles: (subtitles: SubtitleEntry[]) => ProjectJSON

Type declaration

▸ (subtitles): ProjectJSON

Parameters

Name	Type
subtitles	SubtitleEntry[]

Returns

ProjectJSON

Defined in

studio/src/types/index.ts:84