Skip to main content

@twick/studio - v0.15.0 / Exports

@twick/studio - v0.15.0

Table of contents​

References​

Interfaces​

Type Aliases​

Variables​

Functions​

References​

LivePlayer​

Renames and re-exports LivePlayerProvider

PLAYER_STATE​

Renames and re-exports LivePlayerProvider

default​

Renames and re-exports TwickStudio

generateId​

Renames and re-exports LivePlayerProvider

getBaseProject​

Renames and re-exports LivePlayerProvider

useLivePlayerContext​

Renames and re-exports LivePlayerProvider

Type Aliases​

CloudUploadProvider​

Ƭ CloudUploadProvider: "s3" | "gcs"

Defined in​

studio/src/hooks/use-cloud-media-upload.ts:3

RequestStatusResponse​

Ƭ RequestStatusResponse: RequestStatusPending | RequestStatusCompleted

Union type for request status responses

Defined in​

studio/src/types/index.ts:81

Variables​

CAPTION_PROPS​

• Const CAPTION_PROPS: Object

Type declaration​

NameType
highlight_bg{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 46; 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.bgColorstring
highlight_bg.colors.highlightstring
highlight_bg.colors.textstring
highlight_bg.font{ family: string = "Bangers"; size: number = 46; weight: number = 700 }
highlight_bg.font.familystring
highlight_bg.font.sizenumber
highlight_bg.font.weightnumber
highlight_bg.fontWeightnumber
highlight_bg.lineWidthnumber
highlight_bg.shadowColorstring
highlight_bg.shadowOffsetnumber[]
highlight_bg.strokestring
outline_only{ colors: { bgColor: string = "#000000"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Arial"; size: number = 42; weight: number = 600 } ; fontWeight: number = 600; lineWidth: number = 0.5; shadowBlur: number = 0; shadowColor: string = "#000000"; shadowOffset: number[] ; stroke: string = "#000000" }
outline_only.colors{ bgColor: string = "#000000"; highlight: string = "#ff4081"; text: string = "#ffffff" }
outline_only.colors.bgColorstring
outline_only.colors.highlightstring
outline_only.colors.textstring
outline_only.font{ family: string = "Arial"; size: number = 42; weight: number = 600 }
outline_only.font.familystring
outline_only.font.sizenumber
outline_only.font.weightnumber
outline_only.fontWeightnumber
outline_only.lineWidthnumber
outline_only.shadowBlurnumber
outline_only.shadowColorstring
outline_only.shadowOffsetnumber[]
outline_only.strokestring
soft_box{ colors: { bgColor: string = "#333333"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Montserrat"; size: number = 40; weight: number = 600 } ; fontWeight: number = 600; lineWidth: number = 0.2; shadowBlur: number = 3; shadowColor: string = "rgba(0,0,0,0.3)"; shadowOffset: number[] ; stroke: string = "#000000" }
soft_box.colors{ bgColor: string = "#333333"; highlight: string = "#ff4081"; text: string = "#ffffff" }
soft_box.colors.bgColorstring
soft_box.colors.highlightstring
soft_box.colors.textstring
soft_box.font{ family: string = "Montserrat"; size: number = 40; weight: number = 600 }
soft_box.font.familystring
soft_box.font.sizenumber
soft_box.font.weightnumber
soft_box.fontWeightnumber
soft_box.lineWidthnumber
soft_box.shadowBlurnumber
soft_box.shadowColorstring
soft_box.shadowOffsetnumber[]
soft_box.strokestring
word_by_word{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 46; 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.bgColorstring
word_by_word.colors.highlightstring
word_by_word.colors.textstring
word_by_word.font{ family: string = "Bangers"; size: number = 46; weight: number = 700 }
word_by_word.font.familystring
word_by_word.font.sizenumber
word_by_word.font.weightnumber
word_by_word.lineWidthnumber
word_by_word.shadowBlurnumber
word_by_word.shadowColorstring
word_by_word.shadowOffsetnumber[]
word_by_word.strokestring
word_by_word_with_bg{ colors: { bgColor: string = "#444444"; highlight: string = "#ff4081"; text: string = "#ffffff" } ; font: { family: string = "Bangers"; size: number = 46; 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.bgColorstring
word_by_word_with_bg.colors.highlightstring
word_by_word_with_bg.colors.textstring
word_by_word_with_bg.font{ family: string = "Bangers"; size: number = 46; weight: number = 700 }
word_by_word_with_bg.font.familystring
word_by_word_with_bg.font.sizenumber
word_by_word_with_bg.font.weightnumber
word_by_word_with_bg.lineWidthnumber
word_by_word_with_bg.shadowBlurnumber
word_by_word_with_bg.shadowColorstring
word_by_word_with_bg.shadowOffsetnumber[]

Defined in​

studio/src/helpers/constant.ts:3

DEFAULT_PROJECT_TEMPLATES​

• Const DEFAULT_PROJECT_TEMPLATES: ProjectTemplate[]

Defined in​

studio/src/templates/default-templates.ts:4

DEFAULT_STUDIO_CONFIG​

• Const DEFAULT_STUDIO_CONFIG: StudioConfig

Defined in​

studio/src/profiles/index.ts:9

DEMO_STUDIO_CONFIG​

• Const DEMO_STUDIO_CONFIG: StudioConfig

Defined in​

studio/src/profiles/index.ts:22

EDU_STUDIO_CONFIG​

• Const EDU_STUDIO_CONFIG: StudioConfig

Defined in​

studio/src/profiles/index.ts:14

LivePlayerProvider​

• LivePlayerProvider: any

MARKETING_STUDIO_CONFIG​

• Const MARKETING_STUDIO_CONFIG: StudioConfig

Defined in​

studio/src/profiles/index.ts:30

Functions​

AnnotationsPanel​

▸ AnnotationsPanel(«destructured»): ReactElement<unknown, string | JSXElementConstructor<any>>

Parameters​

NameType
«destructured»PanelProps

Returns​

ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in​

studio/src/components/panel/annotations-panel.tsx:17

AudioPanel​

▸ AudioPanel(«destructured»): Element

Parameters​

NameType
«destructured»AudioPanelProps

Returns​

Element

Defined in​

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

CaptionsPanel​

▸ CaptionsPanel(«destructured»): Element

Parameters​

NameType
«destructured»Object
› addCaption() => void
› captionsCaptionEntry[]
› deleteCaption(index: number) => void
› splitCaption(index: number) => void
› updateCaption(index: number, caption: CaptionEntry) => void

Returns​

Element

Defined in​

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

ChaptersPanel​

▸ ChaptersPanel(_props): ReactElement<unknown, string | JSXElementConstructor<any>>

Parameters​

NameType
_propsPanelProps

Returns​

ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in​

studio/src/components/panel/chapters-panel.tsx:9

CirclePanel​

▸ CirclePanel(«destructured»): Element

Parameters​

NameType
«destructured»CirclePanelProps

Returns​

Element

Defined in​

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

CloudMediaUpload​

▸ CloudMediaUpload(«destructured»): Element

Parameters​

NameType
«destructured»CloudMediaUploadProps

Returns​

Element

Defined in​

studio/src/components/shared/cloud-media-upload.tsx:21

ImagePanel​

▸ ImagePanel(«destructured»): Element

Parameters​

NameType
«destructured»ImagePanelProps

Returns​

Element

Defined in​

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

RecordPanel​

▸ RecordPanel(«destructured»): ReactElement<unknown, string | JSXElementConstructor<any>>

Parameters​

NameType
«destructured»PanelProps

Returns​

ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in​

studio/src/components/panel/record-panel.tsx:6

RectPanel​

▸ RectPanel(«destructured»): Element

Parameters​

NameType
«destructured»RectPanelProps

Returns​

Element

Defined in​

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

ScriptPanel​

▸ ScriptPanel(«destructured»): ReactElement<unknown, string | JSXElementConstructor<any>>

Parameters​

NameType
«destructured»PanelProps

Returns​

ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in​

studio/src/components/panel/script-panel.tsx:11

StudioHeader​

▸ StudioHeader(«destructured»): Element

Parameters​

NameType
«destructured»StudioHeaderProps

Returns​

Element

Defined in​

studio/src/components/header.tsx:32

TemplateGalleryPanel​

▸ TemplateGalleryPanel(«destructured»): ReactElement<unknown, string | JSXElementConstructor<any>>

Parameters​

NameType
«destructured»TemplateGalleryPanelProps

Returns​

ReactElement<unknown, string | JSXElementConstructor<any>>

Defined in​

studio/src/components/panel/template-gallery-panel.tsx:10

TextPanel​

▸ TextPanel(«destructured»): Element

Parameters​

NameType
«destructured»TextPanelProps

Returns​

Element

Defined in​

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

Toolbar​

▸ Toolbar(«destructured»): Element

Parameters​

NameTypeDefault value
«destructured»Objectundefined
› customTools?ToolCategory[][]
› hiddenTools?string[][]
› selectedToolstringundefined
› setSelectedTool(tool: string) => voidundefined

Returns​

Element

Defined in​

studio/src/components/toolbar.tsx:70

TwickStudio​

▸ TwickStudio(«destructured»): Element

Parameters​

NameType
«destructured»Object
› studioConfig?StudioConfig

Returns​

Element

Defined in​

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

VideoPanel​

▸ VideoPanel(«destructured»): Element

Parameters​

NameType
«destructured»VideoPanelProps

Returns​

Element

Defined in​

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

exportProjectBundle​

▸ exportProjectBundle(project, options?): ProjectBundleExport

Creates a portable export bundle with project JSON, chapters, and captions. This intentionally avoids zip dependencies; callers can zip externally.

Parameters​

NameType
projectProjectJSON
options?ExportProjectBundleOptions

Returns​

ProjectBundleExport

Defined in​

studio/src/helpers/export-project-bundle.ts:33

useCloudMediaUpload​

▸ useCloudMediaUpload(config): UseCloudMediaUploadReturn

Parameters​

NameType
configUseCloudMediaUploadConfig

Returns​

UseCloudMediaUploadReturn

Defined in​

studio/src/hooks/use-cloud-media-upload.ts:64

useGenerateCaptions​

▸ useGenerateCaptions(studioConfig?): Object

Parameters​

NameType
studioConfig?StudioConfig

Returns​

Object

NameType
addCaptionsToTimeline(captions: CaptionEntry[]) => void
getCaptionstatus(reqId: string) => Promise<ICaptionGenerationPollingResponse>
onGenerateCaptions(videoElement: VideoElement) => Promise<null | string>
pollingIntervalMsnumber

Defined in​

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

useScreenRecorder​

▸ useScreenRecorder(): UseScreenRecorderReturn

Returns​

UseScreenRecorderReturn

Defined in​

studio/src/hooks/use-screen-recorder.ts:14

useStudioManager​

▸ useStudioManager(): Object

Returns​

Object

NameType
addElement(element: TrackElement) => Promise<void>
selectedElementnull | TrackElement
selectedPropstring
selectedToolstring
setSelectedPropDispatch<SetStateAction<string>>
setSelectedToolDispatch<SetStateAction<string>>
updateElement(element: TrackElement) => void

Defined in​

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