Signature
Interface UseTimelineSnappingResultProperties
| Name | Signature | Description |
|---|---|---|
activeTarget | activeTarget: TimelineSnapTarget | null | Currently active snap target, or null when nothing is snapped. |
enabled | enabled: boolean | Whether magnetic snapping is enabled. |
feedback | feedback: TimelineSnapFeedback | Current transient snap feedback for canvas guides and UI status. |
prepareSnapping | (options?: string | SnapPreparationOptions): TimelineCommandResult | Prepares snap targets for an upcoming interaction. |
resolveSnap | (time: RationalTime, publishFeedback?: boolean): TimelineSnapResult | null | Resolves a candidate time against the prepared snap target index. |
setEnabled | (enabled: boolean): TimelineCommandResult | Enables or disables magnetic snapping. |
setThresholdPixels | (thresholdPixels: number): TimelineCommandResult | Sets the magnetic snap radius in screen pixels. |
settle | (): TimelineCommandResult | Finalizes an interaction and clears transient snap feedback. |
thresholdPixels | thresholdPixels: number | Magnetic snap radius in screen pixels. |