VideoProps
interface VideoProps extends MediaProps
Properties
alignContent
Inherited from MediaProps.alignContentalignItems
Inherited from MediaProps.alignItemsalignSelf
Inherited from MediaProps.alignSelfalpha
alpha?: SignalValuenumber
The alpha value of this video.
Unlike opacity, the alpha value affects only the video itself, leaving the fill, stroke, and children intact.
antialiased
antialiased?: SignalValueboolean
MediaProps.antialiasedarrowSize
arrowSize?: SignalValuenumber
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
MediaProps.arrowSizeawaitCanPlay
awaitCanPlay?: SignalValueboolean
MediaProps.awaitCanPlaybasis
Inherited from MediaProps.basisbottom
bottom?: SignalValuePossibleVector2number
The position of the bottom edge of this node.
This shortcut property will set the node's position so that the bottom edge
ends up in the given place.
If present, overrides the position property.
MediaProps.bottombottomLeft
bottomLeft?: SignalValuePossibleVector2number
The position of the bottom left corner of this node.
This shortcut property will set the node's position so that the bottom left
corner ends up in the given place.
If present, overrides the position property.
MediaProps.bottomLeftbottomRight
The position of the bottom right corner of this node.
This shortcut property will set the node's position so that the bottom
right corner ends up in the given place.
If present, overrides the position property.
MediaProps.bottomRightcache
cache?: SignalValueboolean
MediaProps.cachecachePadding
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
MediaProps.cachePaddingcachePaddingBottom
cachePaddingBottom?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
MediaProps.cachePaddingBottomcachePaddingLeft
cachePaddingLeft?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
MediaProps.cachePaddingLeftcachePaddingRight
cachePaddingRight?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
MediaProps.cachePaddingRightcachePaddingTop
cachePaddingTop?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
MediaProps.cachePaddingTopchildren
Inherited from MediaProps.childrenclip
clip?: SignalValueboolean
MediaProps.clipclosed
closed?: SignalValueboolean
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromMediaProps.closedcolumnGap
Inherited from MediaProps.columnGapcomposite
composite?: SignalValueboolean
MediaProps.compositecompositeOperation
compositeOperation?: SignalValueGlobalCompositeOperation
MediaProps.compositeOperationcornerSharpness
cornerSharpness?: SignalValuenumber
Controls the sharpness of smoothCorners.
This property only affects the way rounded corners are drawn. To control
the corner radius use the radius property.
Requires smoothCorners to be enabled to have any effect.
By default, corner sharpness is set to 0.6 which represents a smooth,
circle-like rounding. At 0 the edges are squared off.
MediaProps.cornerSharpnessdecoder
decoder?: SignalValuenull'web''ffmpeg''slow'
Which decoder to use during rendering. The web decoder is the fastest
but only supports MP4 files. The ffmpeg decoder is slower and more resource
intensive but supports more formats. The slow decoder is the slowest but
supports all formats.
direction
Inherited from MediaProps.directionend
end?: SignalValuenumber
A percentage from the start after which the curve should be clipped.
The portion of the curve that comes after the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
MediaProps.endendArrow
endArrow?: SignalValueboolean
Whether to display an arrow at the end of the visible curve.
Use arrowSize to control the size of the arrow.
MediaProps.endArrowendOffset
endOffset?: SignalValuenumber
The offset in pixels from the end of the curve.
This property lets you specify where along the defined curve the actual
visible portion ends. For example, setting it to 20 will make the last
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use end
instead.
MediaProps.endOffsetfill
Inherited from MediaProps.fillfilters
Inherited from MediaProps.filtersfontFamily
fontFamily?: SignalValuestring
MediaProps.fontFamilyfontSize
fontSize?: SignalValuenumber
MediaProps.fontSizefontStyle
fontStyle?: SignalValuestring
MediaProps.fontStylefontWeight
fontWeight?: SignalValuenumber
MediaProps.fontWeightgap
Inherited from MediaProps.gapgrow
grow?: SignalValuenumber
MediaProps.growheight
Inherited from MediaProps.heightjustifyContent
Inherited from MediaProps.justifyContentkey
key?: string
MediaProps.keylayout
Inherited from MediaProps.layoutleft
left?: SignalValuePossibleVector2number
The position of the left edge of this node.
This shortcut property will set the node's position so that the left edge
ends up in the given place.
If present, overrides the position property.
MediaProps.leftletterSpacing
letterSpacing?: SignalValuenumber
MediaProps.letterSpacinglineCap
lineCap?: SignalValueCanvasLineCap
MediaProps.lineCaplineDash
lineDash?: SignalValuenumber[]
MediaProps.lineDashlineDashOffset
lineDashOffset?: SignalValuenumber
MediaProps.lineDashOffsetlineHeight
Inherited from MediaProps.lineHeightlineJoin
lineJoin?: SignalValueCanvasLineJoin
MediaProps.lineJoinlineWidth
lineWidth?: SignalValuenumber
MediaProps.lineWidthloop
loop?: SignalValueboolean
MediaProps.loopmargin
Inherited from MediaProps.marginmarginBottom
marginBottom?: SignalValuenumber
MediaProps.marginBottommarginLeft
marginLeft?: SignalValuenumber
MediaProps.marginLeftmarginRight
marginRight?: SignalValuenumber
MediaProps.marginRightmarginTop
marginTop?: SignalValuenumber
MediaProps.marginTopmaxHeight
Inherited from MediaProps.maxHeightmaxWidth
Inherited from MediaProps.maxWidthmiddle
middle?: SignalValuePossibleVector2number
The position of the center of this node.
This shortcut property will set the node's position so that the center ends
up in the given place.
If present, overrides the position property.
When offset is not set, this will be the same as the
position.
MediaProps.middleminHeight
Inherited from MediaProps.minHeightminWidth
Inherited from MediaProps.minWidthoffset
offset?: SignalValuePossibleVector2number
MediaProps.offsetoffsetX
offsetX?: SignalValuenumber
MediaProps.offsetXoffsetY
offsetY?: SignalValuenumber
MediaProps.offsetYopacity
opacity?: SignalValuenumber
MediaProps.opacitypadding
Inherited from MediaProps.paddingpaddingBottom
paddingBottom?: SignalValuenumber
MediaProps.paddingBottompaddingLeft
paddingLeft?: SignalValuenumber
MediaProps.paddingLeftpaddingRight
paddingRight?: SignalValuenumber
MediaProps.paddingRightpaddingTop
paddingTop?: SignalValuenumber
MediaProps.paddingTopplay
play?: boolean
MediaProps.playplaybackRate
playbackRate?: number
MediaProps.playbackRateposition
position?: SignalValuePossibleVector2number
MediaProps.positionradius
Rounds the corners of this rectangle.
The value represents the radius of the quarter circle that is used to round the corners. If the value is a number, the same radius is used for all corners. Passing an array of two to four numbers will set individual radii for each corner. Individual radii correspond to different corners depending on the number of values passed:
// top-left-and-bottom-right | top-right-and-bottom-left
[10, 30]
// top-left | top-right-and-bottom-left | bottom-right
[10, 20, 30]
// top-left | top-right | bottom-right | bottom-left
[10, 20, 30, 40]
MediaProps.radiusratio
ratio?: SignalValuenumber
MediaProps.ratioref
ref?: ReferenceReceiverany
MediaProps.refright
right?: SignalValuePossibleVector2number
The position of the right edge of this node.
This shortcut property will set the node's position so that the right edge
ends up in the given place.
If present, overrides the position property.
MediaProps.rightrotation
rotation?: SignalValuenumber
MediaProps.rotationrowGap
Inherited from MediaProps.rowGapscale
scale?: SignalValuePossibleVector2number
MediaProps.scalescaleX
scaleX?: SignalValuenumber
MediaProps.scaleXscaleY
scaleY?: SignalValuenumber
MediaProps.scaleYshaders
shaders?: PossibleShaderConfig
MediaProps.shadersshadowBlur
shadowBlur?: SignalValuenumber
MediaProps.shadowBlurshadowColor
Inherited from MediaProps.shadowColorshadowOffset
Inherited from MediaProps.shadowOffsetshadowOffsetX
shadowOffsetX?: SignalValuenumber
MediaProps.shadowOffsetXshadowOffsetY
shadowOffsetY?: SignalValuenumber
MediaProps.shadowOffsetYshrink
shrink?: SignalValuenumber
MediaProps.shrinksize
Inherited from MediaProps.sizeskew
skew?: SignalValuePossibleVector2number
MediaProps.skewskewX
skewX?: SignalValuenumber
MediaProps.skewXskewY
skewY?: SignalValuenumber
MediaProps.skewYsmoothCorners
smoothCorners?: SignalValueboolean
Enables corner smoothing.
This property only affects the way rounded corners are drawn. To control
the corner radius use the radius property.
When enabled, rounded corners are drawn continuously using Bézier curves
rather than quarter circles. The sharpness of the curve can be controlled
with cornerSharpness.
You can read more about corner smoothing in this article by Nick Lawrence.
Inherited fromMediaProps.smoothCornerssmoothing
smoothing?: SignalValueboolean
Whether the video should be smoothed.
When disabled, the video will be scaled using the nearest neighbor interpolation with no smoothing. The resulting video will appear pixelated.
spawner
Deprecated
Use children instead.
MediaProps.spawnersrc
src?: SignalValuestring
MediaProps.srcstart
start?: SignalValuenumber
A percentage from the start before which the curve should be clipped.
The portion of the curve that comes before the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
MediaProps.startstartArrow
startArrow?: SignalValueboolean
Whether to display an arrow at the start of the visible curve.
Use arrowSize to control the size of the arrow.
MediaProps.startArrowstartOffset
startOffset?: SignalValuenumber
The offset in pixels from the start of the curve.
This property lets you specify where along the defined curve the actual
visible portion starts. For example, setting it to 20 will make the first
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use start
instead.
MediaProps.startOffsetstroke
Inherited from MediaProps.strokestrokeFirst
strokeFirst?: SignalValueboolean
MediaProps.strokeFirsttagName
tagName?: keyof HTMLElementTagNameMap
MediaProps.tagNametextAlign
textAlign?: SignalValueCanvasTextAlign
MediaProps.textAligntextDirection
textDirection?: SignalValueCanvasDirection
MediaProps.textDirectiontextWrap
Inherited from MediaProps.textWraptime
time?: SignalValuenumber
MediaProps.timetop
top?: SignalValuePossibleVector2number
The position of the top edge of this node.
This shortcut property will set the node's position so that the top edge
ends up in the given place.
If present, overrides the position property.
MediaProps.toptopLeft
topLeft?: SignalValuePossibleVector2number
The position of the top left corner of this node.
This shortcut property will set the node's position so that the top left
corner ends up in the given place.
If present, overrides the position property.
MediaProps.topLefttopRight
topRight?: SignalValuePossibleVector2number
The position of the top right corner of this node.
This shortcut property will set the node's position so that the top right
corner ends up in the given place.
If present, overrides the position property.
MediaProps.topRightvolume
volume?: number
MediaProps.volumewidth
Inherited from MediaProps.widthwrap
Inherited from MediaProps.wrapx
x?: SignalValuenumber
MediaProps.xy
y?: SignalValuenumber
MediaProps.yzIndex
zIndex?: SignalValuenumber
MediaProps.zIndex