Skip to main content

Audio

class Audio extends Media

Constructors​

constructor​

public override new Audioprops: MediaProps: Audio

Parameters

Overwrites Media.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalAudio

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.

Inherited from Media.absolutePosition

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberAudio

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 from Media.absoluteRotation

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalAudio

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.

Inherited from Media.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentAudio
Inherited from Media.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsAudio
Inherited from Media.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsAudio
Inherited from Media.alignSelf

antialiased​

readonly public antialiased: SimpleSignalbooleanAudio
Inherited from Media.antialiased

arrowSize​

readonly public arrowSize: SimpleSignalnumberAudio

Controls the size of the end and start arrows.

To make the arrows visible make sure to enable startArrow and/or endArrow.

Inherited from Media.arrowSize

assetRoot​

public assetRoot?: `${string}/`
Inherited from Media.assetRoot

basis​

readonly public basis: SimpleSignalFlexBasisAudio
Inherited from Media.basis

bottom​

readonly public bottom: SimpleVector2SignalAudio

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 from Media.bottom

bottomLeft​

readonly public bottomLeft: SimpleVector2SignalAudio

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 from Media.bottomLeft

bottomRight​

readonly public bottomRight: SimpleVector2SignalAudio

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 from Media.bottomRight

cache​

readonly public cache: SimpleSignalbooleanAudio
Inherited from Media.cache

cachePadding​

readonly public cachePadding: SpacingSignalAudio

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.

Inherited from Media.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]AudioSignalContextComponentChildrenNode[]Audio
Inherited from Media.children

clip​

readonly public clip: SimpleSignalbooleanAudio
Inherited from Media.clip

closed​

readonly public closed: SimpleSignalbooleanAudio

Whether the curve should be closed.

Closed curves have their start and end points connected.

Inherited from Media.closed

composite​

readonly public composite: SimpleSignalbooleanAudio
Inherited from Media.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationAudio
Inherited from Media.compositeOperation

cornerSharpness​

readonly public cornerSharpness: SimpleSignalnumberAudio

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 from Media.cornerSharpness

creationStack​

readonly public creationStack?: string
Inherited from Media.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionAudio
Inherited from Media.direction

element​

public element: HTMLElement
Inherited from Media.element

end​

readonly public end: SimpleSignalnumberAudio

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).

Inherited from Media.end

endArrow​

readonly public endArrow: SimpleSignalbooleanAudio

Whether to display an arrow at the end of the visible curve.

Use arrowSize to control the size of the arrow.

Inherited from Media.endArrow

endOffset​

readonly public endOffset: SimpleSignalnumberAudio

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.

Inherited from Media.endOffset

fill​

readonly public fill: CanvasStyleSignalAudio
Inherited from Media.fill

filters​

readonly public filters: FiltersSignalAudio
Inherited from Media.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringAudio
Inherited from Media.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberAudio
Inherited from Media.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringAudio
Inherited from Media.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberAudio
Inherited from Media.fontWeight

gap​

readonly public gap: Vector2LengthSignalAudio
Inherited from Media.gap

grow​

readonly public grow: SimpleSignalnumberAudio
Inherited from Media.grow

isClass​

public isClass: boolean
Inherited from Media.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentAudio
Inherited from Media.justifyContent

key​

readonly public key: string
Inherited from Media.key

layout​

readonly public layout: SimpleSignalLayoutModeAudio
Inherited from Media.layout

left​

readonly public left: SimpleVector2SignalAudio

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 from Media.left

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberAudio
Inherited from Media.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapAudio
Inherited from Media.lineCap

lineDash​

readonly public lineDash: SimpleSignalnumber[]Audio
Inherited from Media.lineDash

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberAudio
Inherited from Media.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthAudio
Inherited from Media.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinAudio
Inherited from Media.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberAudio
Inherited from Media.lineWidth

loop​

readonly public loop: SimpleSignalbooleanAudio
Inherited from Media.loop

margin​

readonly public margin: SpacingSignalAudio
Inherited from Media.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitAudio
Inherited from Media.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitAudio
Inherited from Media.maxWidth

middle​

readonly public middle: SimpleVector2SignalAudio

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 from Media.middle

minHeight​

readonly public minHeight: SimpleSignalLengthLimitAudio
Inherited from Media.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitAudio
Inherited from Media.minWidth

offset​

readonly public offset: Vector2SignalAudio

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
Inherited from Media.offset

opacity​

readonly public opacity: SimpleSignalnumberAudio

Represents the opacity of this node in the range 0-1.

The value is clamped to the range 0-1.

Inherited from Media.opacity

padding​

readonly public padding: SpacingSignalAudio
Inherited from Media.padding

parent​

readonly public parent: SimpleSignalnullNodevoid = ...
Inherited from Media.parent

playbackRate​

readonly public playbackRate: SimpleSignalnumberAudio
Inherited from Media.playbackRate

position​

readonly public position: Vector2SignalAudio

Represents the position of this node in local space of its parent.

Examples

Inherited from Media.position

properties​

readonly public properties: RecordstringPropertyMetadataany = ...
Inherited from Media.properties

radius​

readonly public radius: SpacingSignalAudio

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 from Media.radius

ratio​

readonly public ratio: SimpleSignalnullnumberAudio
Inherited from Media.ratio
readonly public right: SimpleVector2SignalAudio

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 from Media.right

rotation​

readonly public rotation: SimpleSignalnumberAudio

Represents the rotation (in degrees) of this node relative to its parent.

Inherited from Media.rotation

scale​

readonly public scale: Vector2SignalAudio

Represents the scale of this node in local space of its parent.

Examples

Inherited from Media.scale

shaders​

readonly public shaders: SignalPossibleShaderConfigShaderConfig[]AudioSignalContextPossibleShaderConfigShaderConfig[]Audio
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from Media.shaders

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberAudio
Inherited from Media.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalAudio
Inherited from Media.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalAudio
Inherited from Media.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberAudio
Inherited from Media.shrink

size​

readonly public size: Vector2LengthSignalAudio

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 from Media.size

skew​

readonly public skew: Vector2SignalAudio

Represents the skew of this node in local space of its parent.

Examples

Inherited from Media.skew

smoothCorners​

readonly public smoothCorners: SimpleSignalbooleanAudio

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 from Media.smoothCorners

src​

readonly public src: SimpleSignalstringAudio

The source of this asset.

Examples

Inherited from Media.src

start​

readonly public start: SimpleSignalnumberAudio

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).

Inherited from Media.start

startArrow​

readonly public startArrow: SimpleSignalbooleanAudio

Whether to display an arrow at the start of the visible curve.

Use arrowSize to control the size of the arrow.

Inherited from Media.startArrow

startOffset​

readonly public startOffset: SimpleSignalnumberAudio

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.

Inherited from Media.startOffset

stroke​

readonly public stroke: CanvasStyleSignalAudio
Inherited from Media.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanAudio
Inherited from Media.strokeFirst

styles​

public styles: CSSStyleDeclaration
Inherited from Media.styles

textAlign​

readonly public textAlign: SimpleSignalCanvasTextAlignAudio
Inherited from Media.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionAudio
Inherited from Media.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapAudio
Inherited from Media.textWrap

top​

readonly public top: SimpleVector2SignalAudio

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 from Media.top

topLeft​

readonly public topLeft: SimpleVector2SignalAudio

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 from Media.topLeft

topRight​

readonly public topRight: SimpleVector2SignalAudio

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 from Media.topRight

wrap​

readonly public wrap: SimpleSignalFlexWrapAudio
Inherited from Media.wrap

zIndex​

readonly public zIndex: SimpleSignalnumberAudio
Inherited from Media.zIndex

Accessors​

columnGap​

public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Media.columnGap

height​

public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Media.height

rowGap​

public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Media.rowGap

width​

public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Media.width

x​

public get x(): SimpleSignalnumberthis
Inherited from Media.x

y​

public get y(): SimpleSignalnumberthis
Inherited from Media.y

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Inherited from Media.[iterator]

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Media.absoluteOpacity

add​

public addnode: ComponentChildren: Audio

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

Inherited from Media.add

anchorPosition​

public anchorPosition(): Vector2
Inherited from Media.anchorPosition

applyState​

public applyStatestate: NodeState: void
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator

Apply the given state to the node, setting all matching signal values to the provided values.

Parameters

Inherited from Media.applyState

arcLength​

public arcLength(): number

The visible arc length of this curve.

This arc length accounts for both the offset and the start and end properties.

Inherited from Media.arcLength

baseArcLength​

public baseArcLength(): number

The base arc length of this curve.

This is the entire length of this curve, not accounting for the offsets.

Inherited from Media.baseArcLength

cacheBBox​

public cacheBBox(): BBox

Get a bounding box for the contents rendered by this node as well as its children.

Inherited from Media.cacheBBox

childAs​

public childAsT extends NodeT = Nodeindex: number: nullT

Get the nth children cast to the specified type.

Type Parameters

Parameters

  • index: number

    The index of the child to retrieve.

Inherited from Media.childAs

childrenAs​

public childrenAsT extends NodeT = Node(): T[]

Get the children array cast to the specified type.

Type Parameters

Inherited from Media.childrenAs

clampTime​

public clampTimetime: number: number

Parameters

Inherited from Media.clampTime

clone​

public clonecustomProps: NodeState = {}: Audio

Create a copy of this node.

Parameters

Inherited from Media.clone

completion​

public completion(): number
Inherited from Media.completion

compositeToLocal​

public compositeToLocal(): DOMMatrix
Inherited from Media.compositeToLocal

compositeToWorld​

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 from Media.compositeToWorld

computedPosition​

public computedPosition(): Vector2
Inherited from Media.computedPosition

dispose​

public dispose(): void
Inherited from Media.dispose

distanceToPercentage​

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: number

    The distance along the curve.

Inherited from Media.distanceToPercentage

drawOverlay​

public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void

Parameters

Inherited from Media.drawOverlay

findAll​

public findAllT extends NodeTpredicate: node: any => node is T: T[]
public findAllT extends NodeT = Nodepredicate: node: any => boolean: T[]

Find all descendants of this node that match the given predicate.

Type Parameters

Parameters

  • predicate: node: any => node is T

    A function that returns true if the node matches.

Inherited from Media.findAll

findAncestor​

public findAncestorT extends NodeTpredicate: node: Node => node is T: nullT
public findAncestorT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the closest ancestor of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Media.findAncestor

findFirst​

public findFirstT extends NodeTpredicate: node: Node => node is T: nullT
public findFirstT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the first descendant of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Media.findFirst

findLast​

public findLastT extends NodeTpredicate: node: Node => node is T: nullT
public findLastT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the last descendant of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Media.findLast

fullSource​

public fullSource(): string
Inherited from Media.fullSource

getCurrentTime​

public getCurrentTime(): number
Inherited from Media.getCurrentTime

getDuration​

public getDuration(): number
Inherited from Media.getDuration

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Media.getOriginDelta

getPointAtPercentage​

public getPointAtPercentagevalue: number: CurvePoint

Parameters

Inherited from Media.getPointAtPercentage

getState​

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 from Media.getState

getUrl​

public getUrl(): string
Inherited from Media.getUrl

getVolume​

public getVolume(): number
Inherited from Media.getVolume

hit​

public hitposition: Vector2: nullNode

Parameters

Inherited from Media.hit

insert​

public insertnode: ComponentChildrenindex: number = 0: Audio

Insert the given node(s) at the specified index in the children list.

Examples

Parameters

Inherited from Media.insert

instantiate​

public instantiateprops: NodeProps = {}: Audio

Create an instance of this node's class.

Parameters

Inherited from Media.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from Media.isLayoutRoot

isPlaying​

public isPlaying(): boolean
Inherited from Media.isPlaying

layoutEnabled​

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).

Inherited from Media.layoutEnabled

localToParent​

public localToParent(): DOMMatrix
Inherited from Media.localToParent

localToWorld​

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 from Media.localToWorld

lockSize​

public lockSize(): void
Inherited from Media.lockSize

move​

public moveby: number = 1: Audio

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 = 1

    Number of places by which the node should be moved.

Inherited from Media.move

moveAbove​

public moveAbovenode: NodedirectlyAbove: boolean = false: Audio

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: Node

    The sibling node below which to move.

  • directlyAbove: boolean = false

    Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.

Inherited from Media.moveAbove

moveBelow​

public moveBelownode: NodedirectlyBelow: boolean = false: Audio

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: Node

    The sibling node below which to move.

  • directlyBelow: boolean = false

    Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.

Inherited from Media.moveBelow

moveDown​

public moveDown(): Audio

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 from Media.moveDown

moveOffset​

public moveOffsetoffset: Vector2: void

Update the offset of this node and adjust the position to keep it in the same place.

Parameters

Inherited from Media.moveOffset

moveTo​

public moveToindex: number: Audio

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: number

    The index to move the node to.

Inherited from Media.moveTo

moveToBottom​

public moveToBottom(): Audio

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 from Media.moveToBottom

moveToTop​

public moveToTop(): Audio

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 from Media.moveToTop

moveUp​

public moveUp(): Audio

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 from Media.moveUp

offsetArcLength​

public offsetArcLength(): number

The offset arc length of this curve.

This is the length of the curve that accounts for the offsets.

Inherited from Media.offsetArcLength

parentAs​

public parentAsT extends NodeT = Node(): nullT

Get the parent cast to the specified type.

Type Parameters

Inherited from Media.parentAs

pause​

public pause(): void
Inherited from Media.pause

peekChildren​

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.

Inherited from Media.peekChildren

percentageToDistance​

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: number

    The percentage along the curve.

Inherited from Media.percentageToDistance

play​

public play(): void
Inherited from Media.play

profile​

public profile(): CurveProfile
Inherited from Media.profile

reactiveClone​

public reactiveClonecustomProps: NodeState = {}: Audio

Create a reactive copy of this node.

A reactive copy has all its properties dynamically updated to match the source node.

Parameters

Inherited from Media.reactiveClone

releaseSize​

public releaseSize(): void
Inherited from Media.releaseSize

remove​

public remove(): Audio

Remove this node from the tree.

Inherited from Media.remove

removeChildren​

public removeChildren(): void

Remove all children of this node.

Inherited from Media.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: Promisevoid

Render this node onto the given canvas.

Parameters

Inherited from Media.render

reparent​

public reparentnewParent: Node: void

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 from Media.reparent

restore​

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 from Media.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from Media.ripple

save​

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.

Inherited from Media.save

setVolume​

public setVolumevolume: number: void

Parameters

Inherited from Media.setVolume

snapshotClone​

public snapshotClonecustomProps: NodeState = {}: Audio

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

Inherited from Media.snapshotClone

toPromise​

public toPromise(): PromiseAudio

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 from Media.toPromise

view​

public view(): View2D
Inherited from Media.view

worldToLocal​

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 from Media.worldToLocal

worldToParent​

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 from Media.worldToParent