effect-motion
API Referenceeffect-motionNamespacesAudioFunctions

duration

function duration<ID>(track): Effect<Duration, never, AudioMetadata<ID>>;

Function: duration()

function duration<ID>(track): Effect<Duration, never, AudioMetadata<ID>>;

Defined in: packages/motion/src/Audio.ts:220

The track's full source length — an explicit inspection.

Type Parameters

Type Parameter
ID extends string

Parameters

ParameterType
track| Audio<ID> | AudioResource<ID>

Returns

Effect<Duration, never, AudioMetadata<ID>>

Remarks

Requires AudioMetadata<ID>, which survives Scene.run/stream: run the scene with metadataLayer or preparedLayer provided. The result is a Duration, so it feeds Scene.sleep and the duration option of play directly. For the remaining length of a play started at from seconds, subtract Duration.seconds(from).

On this page