Skip to content
Screen
CI
Search
Ctrl
K
Cancel
GitHub
Getting Started
Overview
Agent integration
Manual setup & first video
Video script basics
Editor
CI setup
Fixtures
Narration
Overlays
Languages
Guides
Animated interactions
Camera and zooming
Mid-video overlay updates
Public URLs and embeds
Redact sensitive content
Screen audio
Update ScreenCI
Version history
Organisation & SSO
Anonymous trial
Reference
CLI
Configuration
Public delivery API
Full API Reference
Functions
autoZoom
defineConfig
hide
hideNarration
hideRecording
overlayRect
redact
resetZoom
resizeRecording
resolveLocaleForLanguage
showNarration
showRecording
speed
time
unredactAll
zoomTo
Type Aliases
ActionMethod
ActionParamRecord
ActionParamValue
AspectRatio
AutoZoomOptions
ClipOptions
ClipRegion
ClipTarget
Cues
CustomVoiceRef
EachVariant
Easing
ElevenLabsVoiceKey
ExtendedScreenCIConfig
FeatureArg
FPS
HtmlPageOverlayConfig
LangNarrationOverride
LanguagesArg
LanguagesConfig
LocalizeMode
LocalizeNarrationValue
MediaOverlayConfig
ModelType
ModelVoiceKey
NarrationAudioCleanupOption
NarrationCue
OverlayClip
OverlayConfig
OverlayConfigFactory
OverlayController
OverlayControllerFor
OverlayDuration
OverlayInput
OverlayInputOrFactory
OverlayPlacement
OverlayRect
OverlayRectOptions
Overlays
OverlayTransitionOptions
Quality
RecordingLocalize
RecordingUpdateEvent
RecordOptions
RecordUploadPolicy
RedactHandle
RedactOptions
RedactStyle
RenderOptions
ResolvedClipPadding
ResolvedNarrationAudioCleanup
ScreenCIConfig
ScreenCILocator
ScreenCILocatorCheckOptions
ScreenCILocatorClickOptions
ScreenCILocatorDragToOptions
ScreenCILocatorFillOptions
ScreenCILocatorHoverOptions
ScreenCILocatorPostClickMoveOptions
ScreenCILocatorPressSequentiallyOptions
ScreenCILocatorSelectOptionOptions
ScreenCILocatorSelectTextOptions
ScreenCIPage
TimelineOffset
TopLevelVoiceConfig
TsxOverlayConfig
UpdateTransition
VideoBuilder
VideoEncoderPreset
VoiceConfig
VoiceKey
ZoomTarget
ZoomTargetPoint
Variables
ACTION_PARAM_DEFAULTS
DEFAULT_LANGUAGE_LOCALES
MAX_AUDIO_LEVEL
modelTypes
video
voices
Interfaces
MediaBuilder
GitHub
OverlayDuration
OverlayDuration
=
number
Defined in: asset.ts:52
A relative overlay length, in milliseconds.