Video
class Video extends Media
Constructors
constructor
public override new Videoprops: VideoProps: Video
Parameters
OverwritesMedia.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalVideo
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Media.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberVideo
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromMedia.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalVideo
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Media.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentVideo
Media.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsVideo
Media.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsVideo
Media.alignSelfalpha
readonly public alpha: SimpleSignalnumberVideo
The alpha value of this video.
Unlike opacity, the alpha value affects only the video itself, leaving the fill, stroke, and children intact.
antialiased
readonly public antialiased: SimpleSignalbooleanVideo
Media.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberVideo
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
Media.arrowSizeassetRoot
public assetRoot?: `${string}/`
Media.assetRootbasis
readonly public basis: SimpleSignalFlexBasisVideo
Media.basisbottom
readonly public bottom: SimpleVector2SignalVideo
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromMedia.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalVideo
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromMedia.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalVideo
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromMedia.bottomRightcache
readonly public cache: SimpleSignalbooleanVideo
Media.cachecachePadding
readonly public cachePadding: SpacingSignalVideo
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.
Media.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]VideoSignalContextComponentChildrenNode[]Video
Media.childrenclip
readonly public clip: SimpleSignalbooleanVideo
Media.clipclosed
readonly public closed: SimpleSignalbooleanVideo
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromMedia.closedcomposite
readonly public composite: SimpleSignalbooleanVideo
Media.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationVideo
Media.compositeOperationcornerSharpness
readonly public cornerSharpness: SimpleSignalnumberVideo
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.
Examples
Inherited fromMedia.cornerSharpnesscreationStack
readonly public creationStack?: string
Media.creationStackdecoder
readonly public decoder: SimpleSignalnull'web''ffmpeg''slow'Video
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.
nulldetectedFileType
public detectedFileType: 'mp4''webm''hls''mov''unknown' = 'unknown'
direction
readonly public direction: SimpleSignalFlexDirectionVideo
Media.directionelement
public element: HTMLElement
Media.elementend
readonly public end: SimpleSignalnumberVideo
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).
Media.endendArrow
readonly public endArrow: SimpleSignalbooleanVideo
Whether to display an arrow at the end of the visible curve.
Use arrowSize to control the size of the arrow.
Media.endArrowendOffset
readonly public endOffset: SimpleSignalnumberVideo
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.
Media.endOffsetfill
readonly public fill: CanvasStyleSignalVideo
Media.fillfilters
readonly public filters: FiltersSignalVideo
Media.filtersfontFamily
readonly public fontFamily: SimpleSignalstringVideo
Media.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberVideo
Media.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringVideo
Media.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberVideo
Media.fontWeightgap
readonly public gap: Vector2LengthSignalVideo
Media.gapgrow
readonly public grow: SimpleSignalnumberVideo
Media.growisClass
public isClass: boolean
Media.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentVideo
Media.justifyContentkey
readonly public key: string
Media.keylayout
readonly public layout: SimpleSignalLayoutModeVideo
Media.layoutleft
readonly public left: SimpleVector2SignalVideo
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromMedia.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberVideo
Media.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapVideo
Media.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Video
Media.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberVideo
Media.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthVideo
Media.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinVideo
Media.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberVideo
Media.lineWidthloop
readonly public loop: SimpleSignalbooleanVideo
Media.loopmargin
readonly public margin: SpacingSignalVideo
Media.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitVideo
Media.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitVideo
Media.maxWidthmiddle
readonly public middle: SimpleVector2SignalVideo
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the offset has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromMedia.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitVideo
Media.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitVideo
Media.minWidthoffset
readonly public offset: Vector2SignalVideo
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
Media.offsetopacity
readonly public opacity: SimpleSignalnumberVideo
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromMedia.opacitypadding
readonly public padding: SpacingSignalVideo
Media.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Media.parentplaybackRate
readonly public playbackRate: SimpleSignalnumberVideo
Media.playbackRateposition
readonly public position: Vector2SignalVideo
Represents the position of this node in local space of its parent.
Examples
Inherited fromMedia.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Media.propertiesradius
readonly public radius: SpacingSignalVideo
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]
Examples
Inherited fromMedia.radiusratio
readonly public ratio: SimpleSignalnullnumberVideo
Media.ratioright
readonly public right: SimpleVector2SignalVideo
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromMedia.rightrotation
readonly public rotation: SimpleSignalnumberVideo
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromMedia.rotationscale
readonly public scale: Vector2SignalVideo
Represents the scale of this node in local space of its parent.
Examples
Inherited fromMedia.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]VideoSignalContextPossibleShaderConfigShaderConfig[]Video
Media.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberVideo
Media.shadowBlurshadowColor
readonly public shadowColor: ColorSignalVideo
Media.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalVideo
Media.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberVideo
Media.shrinksize
readonly public size: Vector2LengthSignalVideo
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.
Examples
Inherited fromMedia.sizeskew
readonly public skew: Vector2SignalVideo
Represents the skew of this node in local space of its parent.
Examples
Inherited fromMedia.skewsmoothCorners
readonly public smoothCorners: SimpleSignalbooleanVideo
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.
Examples
Inherited fromMedia.smoothCornerssmoothing
readonly public smoothing: SimpleSignalbooleanVideo
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.
Default Value:truesrc
readonly public src: SimpleSignalstringVideo
The source of this asset.
Examples
Inherited fromMedia.srcstart
readonly public start: SimpleSignalnumberVideo
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).
Media.startstartArrow
readonly public startArrow: SimpleSignalbooleanVideo
Whether to display an arrow at the start of the visible curve.
Use arrowSize to control the size of the arrow.
Media.startArrowstartOffset
readonly public startOffset: SimpleSignalnumberVideo
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.
Media.startOffsetstroke
readonly public stroke: CanvasStyleSignalVideo
Media.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanVideo
Media.strokeFirststyles
public styles: CSSStyleDeclaration
Media.stylestextAlign
readonly public textAlign: SimpleSignalCanvasTextAlignVideo
Media.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionVideo
Media.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapVideo
Media.textWraptop
readonly public top: SimpleVector2SignalVideo
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromMedia.toptopLeft
readonly public topLeft: SimpleVector2SignalVideo
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromMedia.topLefttopRight
readonly public topRight: SimpleVector2SignalVideo
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromMedia.topRightwrap
readonly public wrap: SimpleSignalFlexWrapVideo
Media.wrapzIndex
readonly public zIndex: SimpleSignalnumberVideo
Media.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Media.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Media.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Media.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Media.widthx
public get x(): SimpleSignalnumberthis
Media.xy
public get y(): SimpleSignalnumberthis
Media.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Media.[iterator]absoluteOpacity
public absoluteOpacity(): number
Media.absoluteOpacityadd
public addnode: ComponentChildren: Video
Add the given node(s) as the children of this node.
The nodes will be appended at the end of the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to append.
Media.addanchorPosition
public anchorPosition(): Vector2
Media.anchorPositionapplyState
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
Inherited fromMedia.applyStatearcLength
public arcLength(): number
The visible arc length of this curve.
This arc length accounts for both the offset and the start and
end properties.
Media.arcLengthbaseArcLength
public baseArcLength(): number
The base arc length of this curve.
This is the entire length of this curve, not accounting for
the offsets.
Media.baseArcLengthcacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromMedia.cacheBBoxchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Media.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromMedia.childrenAsclampTime
public clampTimetime: number: number
Parameters
time: number
Media.clampTimeclone
public clonecustomProps: NodeState = {}: Video
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Media.clonecompletion
public completion(): number
Media.completioncompositeToLocal
public compositeToLocal(): DOMMatrix
Media.compositeToLocalcompositeToWorld
public compositeToWorld(): DOMMatrix
A matrix mapping composite space to world space.
Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.
Inherited fromMedia.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Media.computedPositiondispose
public dispose(): void
Media.disposedistanceToPercentage
public distanceToPercentagevalue: number: number
Convert a distance along the curve to a percentage.
The distance should be given in relation to the full curve, not
accounting for startOffset and endOffset.
Parameters
value: numberThe distance along the curve.
Media.distanceToPercentagedrawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Parameters
Inherited fromMedia.drawOverlayfindAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromMedia.findAllfindAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromMedia.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromMedia.findFirstfindLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromMedia.findLastfullSource
public fullSource(): string
Media.fullSourcegetCurrentTime
public getCurrentTime(): number
Media.getCurrentTimegetDuration
public getDuration(): number
Media.getDurationgetOriginDelta
Parameters
Inherited fromMedia.getOriginDeltagetPointAtPercentage
public getPointAtPercentagevalue: number: CurvePoint
Parameters
value: number
Media.getPointAtPercentagegetState
public getState(): NodeState
Return a snapshot of the node's current signal values.
This method will calculate the values of any reactive properties of the node at the time the method is called.
Inherited fromMedia.getStategetUrl
public getUrl(): string
Media.getUrlgetVolume
public getVolume(): number
Media.getVolumehit
Parameters
Inherited fromMedia.hitinsert
public insertnode: ComponentChildrenindex: number = 0: Video
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to insert.
index: number = 0An index at which to insert the node(s).
Media.insertinstantiate
Create an instance of this node's class.
Parameters
Inherited fromMedia.instantiateisLayoutRoot
public isLayoutRoot(): boolean
Media.isLayoutRootisPlaying
public isPlaying(): boolean
Media.isPlayinglayoutEnabled
public layoutEnabled(): boolean
Get the resolved layout mode of this node.
When the mode is null, its value will be inherited from the parent.
Use layout to get the raw mode set for this node (without
inheritance).
Media.layoutEnabledlocalToParent
public localToParent(): DOMMatrix
Media.localToParentlocalToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromMedia.localToWorldlockSize
public lockSize(): void
Media.lockSizemove
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1Number of places by which the node should be moved.
Media.movemoveAbove
public moveAbovenode: NodedirectlyAbove: boolean = false: Video
Move the node above the provided node in the parent's layout.
The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyAbove: boolean = falseWhether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Media.moveAbovemoveBelow
public moveBelownode: NodedirectlyBelow: boolean = false: Video
Move the node below the provided node in the parent's layout.
The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyBelow: boolean = falseWhether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
Media.moveBelowmoveDown
public moveDown(): Video
Move the node down in relation to its siblings.
The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.
Inherited fromMedia.moveDownmoveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromMedia.moveOffsetmoveTo
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: numberThe index to move the node to.
Media.moveTomoveToBottom
public moveToBottom(): Video
Move the node to the bottom in relation to its siblings.
The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.
Inherited fromMedia.moveToBottommoveToTop
public moveToTop(): Video
Move the node to the top in relation to its siblings.
The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.
Inherited fromMedia.moveToTopmoveUp
public moveUp(): Video
Move the node up in relation to its siblings.
The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.
Inherited fromMedia.moveUpoffsetArcLength
public offsetArcLength(): number
The offset arc length of this curve.
This is the length of the curve that accounts for
the offsets.
Media.offsetArcLengthparentAs
Get the parent cast to the specified type.
Type Parameters
Inherited fromMedia.parentAspause
public pause(): void
Media.pausepeekChildren
public peekChildren(): readonly Node[]
Get the current children of this node.
Unlike children, this method does not have any side effects.
It does not register the children signal as a dependency, and it does not
spawn any children. It can be used to safely retrieve the current state of
the scene graph for debugging purposes.
Media.peekChildrenpercentageToDistance
public percentageToDistancevalue: number: number
Convert a percentage along the curve to a distance.
The returned distance is given in relation to the full curve, not
accounting for startOffset and endOffset.
Parameters
value: numberThe percentage along the curve.
Media.percentageToDistanceplay
public play(): void
Media.playprofile
public profile(): CurveProfile
Media.profilereactiveClone
public reactiveClonecustomProps: NodeState = {}: Video
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source node.
Parameters
customProps: NodeState = {}Properties to override.
Media.reactiveClonereleaseSize
public releaseSize(): void
Media.releaseSizeremove
public override remove(): Video
Remove this node from the tree.
OverwritesMedia.removeremoveChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromMedia.removeChildrenrender
public rendercontext: CanvasRenderingContext2D: Promisevoid
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
Media.renderreparent
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same place visually, but its parent will be changed.
Parameters
Inherited fromMedia.reparentrestore
public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Inherited fromMedia.restoreripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
Media.ripplesave
public save(): void
Push a snapshot of the node's current state onto the node's state stack.
This method can be used together with the restore method to save a
node's current state and later restore it. It is possible to store more
than one state by calling save method multiple times.
Media.savesetVolume
public setVolumevolume: number: void
Parameters
volume: number
Media.setVolumesnapshotClone
public snapshotClonecustomProps: NodeState = {}: Video
Create a copy of this node.
Unlike clone, a snapshot clone calculates any reactive properties
at the moment of cloning and passes the raw values to the copy.
Parameters
customProps: NodeState = {}Properties to override.
Media.snapshotClonetoPromise
Wait for any asynchronous resources that this node or its children have.
Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.
Inherited fromMedia.toPromiseview
public view(): View2D
Media.viewworldToLocal
public worldToLocal(): DOMMatrix
Get the world-to-local matrix for this node.
This matrix transforms vectors from world space to local space of this node.
Examples
Inherited fromMedia.worldToLocalworldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromMedia.worldToParent