@twick/studio - v0.15.0 / Exports

@twick/studio - v0.15.0

Table of contents

References

• default

Interfaces

• GenerateSubtitlesResponse
• ISubtitleGenerationPollingResponse
• ISubtitleGenerationService
• MediaItem
• PanelProps
• PropertiesPanelProps
• RequestStatus
• RequestStatusCompleted
• RequestStatusPending
• Result
• StudioConfig
• SubtitleEntry
• TextElement
• Timeline
• TimelineElement
• ToolCategory
• Track
• VideoSettings

Type Aliases

• RequestStatusResponse

Variables

• CAPTION_PROPS

Functions

• AudioPanel
• CirclePanel
• IconPanel
• ImagePanel
• RectPanel
• StudioHeader
• SubtitlesPanel
• TextPanel
• Toolbar
• TwickStudio
• VideoPanel
• useGenerateSubtitles
• useStudioManager

References

default

Renames and re-exports TwickStudio

Type Aliases

RequestStatusResponse

Ƭ RequestStatusResponse: RequestStatusPending | RequestStatusCompleted

Union type for request status responses

Defined in

studio/src/types/index.ts:70

Variables

CAPTION_PROPS

• Const CAPTION_PROPS: Object

Type declaration

Name	Type
highlight_bg	{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 50; weight: number = 700 } ; fontWeight: number = 700; lineWidth: number = 0.35; shadowColor: string = "#000000"; shadowOffset: number[] ; stroke: string = "#000000" }
highlight_bg.colors	{ bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" }
highlight_bg.colors.bgColor	string
highlight_bg.colors.highlight	string
highlight_bg.colors.text	string
highlight_bg.font	{ family: string = "Bangers"; size: number = 50; weight: number = 700 }
highlight_bg.font.family	string
highlight_bg.font.size	number
highlight_bg.font.weight	number
highlight_bg.fontWeight	number
highlight_bg.lineWidth	number
highlight_bg.shadowColor	string
highlight_bg.shadowOffset	number[]
highlight_bg.stroke	string
word_by_word	{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 50; weight: number = 700 } ; lineWidth: number = 0.35; shadowBlur: number = 5; shadowColor: string = "#000000"; shadowOffset: number[] ; stroke: string = "#000000" }
word_by_word.colors	{ bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" }
word_by_word.colors.bgColor	string
word_by_word.colors.highlight	string
word_by_word.colors.text	string
word_by_word.font	{ family: string = "Bangers"; size: number = 50; weight: number = 700 }
word_by_word.font.family	string
word_by_word.font.size	number
word_by_word.font.weight	number
word_by_word.lineWidth	number
word_by_word.shadowBlur	number
word_by_word.shadowColor	string
word_by_word.shadowOffset	number[]
word_by_word.stroke	string
word_by_word_with_bg	{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 50; weight: number = 700 } ; lineWidth: number = 0.35; shadowBlur: number = 5; shadowColor: string = "#000000"; shadowOffset: number[] }
word_by_word_with_bg.colors	{ bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" }
word_by_word_with_bg.colors.bgColor	string
word_by_word_with_bg.colors.highlight	string
word_by_word_with_bg.colors.text	string
word_by_word_with_bg.font	{ family: string = "Bangers"; size: number = 50; weight: number = 700 }
word_by_word_with_bg.font.family	string
word_by_word_with_bg.font.size	number
word_by_word_with_bg.font.weight	number
word_by_word_with_bg.lineWidth	number
word_by_word_with_bg.shadowBlur	number
word_by_word_with_bg.shadowColor	string
word_by_word_with_bg.shadowOffset	number[]

Defined in

studio/src/helpers/constant.ts:3

Functions

AudioPanel

▸ AudioPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	AudioPanelProps

Returns

Element

Defined in

studio/src/components/panel/audio-panel.tsx:37

---

CirclePanel

▸ CirclePanel(«destructured»): Element

Parameters

Name	Type
«destructured»	CirclePanelProps

Returns

Element

Defined in

studio/src/components/panel/circle-panel.tsx:46

---

IconPanel

▸ IconPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	IconPanelProps

Returns

Element

Defined in

studio/src/components/panel/icon-panel.tsx:46

---

ImagePanel

▸ ImagePanel(«destructured»): Element

Parameters

Name	Type
«destructured»	ImagePanelProps

Returns

Element

Defined in

studio/src/components/panel/image-panel.tsx:33

---

RectPanel

▸ RectPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	RectPanelProps

Returns

Element

Defined in

studio/src/components/panel/rect-panel.tsx:43

---

StudioHeader

▸ StudioHeader(«destructured»): Element

Parameters

Name	Type
«destructured»	StudioHeaderProps

Returns

Element

Defined in

studio/src/components/header.tsx:29

---

SubtitlesPanel

▸ SubtitlesPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› addSubtitle	() => void
› deleteSubtitle	(index: number) => void
› splitSubtitle	(index: number) => void
› subtitles	SubtitleEntry[]
› updateSubtitle	(index: number, subtitle: SubtitleEntry) => void

Returns

Element

Defined in

studio/src/components/panel/subtitles-panel.tsx:43

---

TextPanel

▸ TextPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	TextPanelProps

Returns

Element

Defined in

studio/src/components/panel/text-panel.tsx:57

---

Toolbar

▸ Toolbar(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› selectedTool	string
› setSelectedTool	(tool: string) => void

Returns

Element

Defined in

studio/src/components/toolbar.tsx:63

---

TwickStudio

▸ TwickStudio(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› studioConfig?	StudioConfig

Returns

Element

Defined in

studio/src/components/twick-studio.tsx:33

---

VideoPanel

▸ VideoPanel(«destructured»): Element

Parameters

Name	Type
«destructured»	VideoPanelProps

Returns

Element

Defined in

studio/src/components/panel/video-panel.tsx:35

---

useGenerateSubtitles

▸ useGenerateSubtitles(studioConfig?): Object

Parameters

Name	Type
studioConfig?	StudioConfig

Returns

Object

Name	Type
addSubtitlesToTimeline	(subtitles: SubtitleEntry[]) => void
getSubtitleStatus	(reqId: string) => Promise<ISubtitleGenerationPollingResponse>
onGenerateSubtitles	(videoElement: VideoElement) => Promise<null | string>

Defined in

studio/src/hooks/use-generate-subtitles.ts:8

---

useStudioManager

▸ useStudioManager(): Object

Returns

Object

Name	Type
addElement	(element: TrackElement) => Promise<void>
selectedElement	null | TrackElement
selectedProp	string
selectedTool	string
setSelectedProp	Dispatch<SetStateAction<string>>
setSelectedTool	Dispatch<SetStateAction<string>>
updateElement	(element: TrackElement) => void

Defined in

studio/src/hooks/use-studio-manager.tsx:30