UseTimelinePlaybackResult API

Signature

Interface UseTimelinePlaybackResult

Name	Signature	Description
`clearInOutPoints`	`(): TimelineCommandResult`	Clears both in and out points.
`inPoint`	`inPoint: RationalTime \| undefined`	Current in point, when set.
`outPoint`	`outPoint: RationalTime \| undefined`	Current out point, when set.
`pause`	`(): TimelineCommandResult`	Pauses timeline playback.
`play`	`(options?: PlaybackOptions): TimelineCommandResult`	Starts timeline playback.
`playbackRate`	`playbackRate: number`	Current playback speed multiplier.
`playing`	`playing: boolean`	Whether the timeline is currently playing.
`setInPoint`	`(time?: RationalTime): TimelineCommandResult`	Sets the in point to a supplied time or the current playhead.
`setOutPoint`	`(time?: RationalTime): TimelineCommandResult`	Sets the out point to a supplied time or the current playhead.
`setPlaybackRate`	`(rate: number): TimelineCommandResult`	Sets the playback speed multiplier.
`setPlayheadTime`	`(time: RationalTime): TimelineCommandResult`	Moves the playhead to an absolute time.
`stepBackward`	`(amountSeconds?: number): TimelineCommandResult`	Moves the playhead backward by a number of seconds.
`stepForward`	`(amountSeconds?: number): TimelineCommandResult`	Advances the playhead by a number of seconds.
`togglePlayback`	`(): TimelineCommandResult`	Starts playback when paused, or pauses playback when playing.