Component:PlaybackPositionDriver: Difference between revisions

Latest revision as of 17:44, 24 December 2024

Component image

The PlaybackPositionDriver component is used to output and/or influence the playback position of an IPlayable.

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`Target`	field drive of Float	The field to drive with the time position of `Source` from. If `UseNormalizedPosition` is true, this is 0<->1, else it's the amount of seconds from the start.
`Source`	IPlayable	The playable audio to get the time from.
`UseNormalizedPosition`	Bool	Whether to output a 0<->1 or an amount of seconds
`WriteBack`	Bool	Whether writing to the value of the field specified by `Target` will set the playback position.

Can be used on a timeline to get the amount of time left or played in an audio clip that is playing.

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=PlaybackPositionDriverComponent.png
 |Name=Playback Position Driver
 }}
+The '''PlaybackPositionDriver''' component is used to output and/or influence the playback position of an [[Type:IPlayable|IPlayable]].
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|Target|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv0=true|
+|Target|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv0=true| The field to drive with the time position of <code>Source</code> from. If <code>UseNormalizedPosition</code> is true, this is 0<->1, else it's the amount of seconds from the start.
-|Source|IPlayable|
+|Source|IPlayable| The playable audio to get the time from.
-|UseNormalizedPosition|Bool|
+|UseNormalizedPosition|Bool| Whether to output a 0<->1 or an amount of seconds
-|WriteBack|Bool|
+|WriteBack|Bool| Whether writing to the value of the field specified by <code>Target</code> will set the playback position.
 }}
 <!--T:3-->
 == Usage ==
+Can be used on a timeline to get the amount of time left or played in an audio clip that is playing.
 <!--T:4-->
 == Examples ==
+{{stub}}
 <!--T:5-->
-== Related Components ==
+== See Also ==
+* [[Component:PlaybackSynchronizer]]
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Playback Position Driver]]
 [[Category:Components:Media:Utility{{#translation:}}|Playback Position Driver]]