Component:PlaybackSynchronizer: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
hey! I used this one before!
 
Line 3: Line 3:
|Name=Playback Synchronizer
|Name=Playback Synchronizer
}}
}}
{{stub}}
The '''PlaybackSynchronizer''' component is used to make two Audio Clips play together in unison, play at the same time, or to synchronize.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Target|{{RootFieldType|DriveRef`1|[[Type:SyncPlayback|SyncPlayback]]}}|TypeAdv0=true|
|Target|{{RootFieldType|DriveRef`1|[[Type:SyncPlayback|SyncPlayback]]}}|TypeAdv0=true| The playable to synchronize the playback position with the position of <code>Source</code>.
|Source|IPlayable|
|Source|IPlayable| The playable that will drive <code>Target</code>'s playback
|UseNormalizedPosition|Bool|
|UseNormalizedPosition|Bool| Whether to speed up or slow down the playback of <code>Target</code> if the duration doesn't match.
|PositionOffset|Float|
|PositionOffset|Float| How many seconds/normalized position to offset the <code>Target</code>'s synchronization with <code>Source</code>'s position.
|PositionRate|Float|
|PositionRate|Float| How much to multiply <code>Source</code>'s position before driving <code>Target</code>'s position with it.
}}
}}


== Behavior ==
== Usage ==
This can be used with any playable like an [[Component:Animator]] or otherwise with another animator or audio. It can also be used to synchronize Videos with each other. This can be useful when you want animations/videos to sync up with audio, in perfect unison without having to worry about networking.


== Examples ==
== Examples ==
Used in [[User:989onan|989onan's]] MMD player and Emote System to sync audio with the dance when the user is dancing with the system.


== See Also ==
== See Also ==
* [[Component:PlaybackPositionDriver]]
* [[Type:AudioClip]]


[[Category:Components:Media:Utility{{#translation:}}|Playback Synchronizer]]
[[Category:Components:Media:Utility{{#translation:}}|Playback Synchronizer]]
[[Category:Components{{#translation:}}|Playback Synchronizer]]
[[Category:Components{{#translation:}}|Playback Synchronizer]]
[[Category:ComponentStubs]]

Latest revision as of 17:54, 24 December 2024

Component image 
Playback Synchronizer component as seen in the Scene Inspector

The PlaybackSynchronizer component is used to make two Audio Clips play together in unison, play at the same time, or to synchronize.

Fields

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 direct DriveRef`1<SyncPlayback> The playable to synchronize the playback position with the position of Source.
Source IPlayable The playable that will drive Target's playback
UseNormalizedPosition Bool Whether to speed up or slow down the playback of Target if the duration doesn't match.
PositionOffset Float How many seconds/normalized position to offset the Target's synchronization with Source's position.
PositionRate Float How much to multiply Source's position before driving Target's position with it.

Usage

This can be used with any playable like an Component:Animator or otherwise with another animator or audio. It can also be used to synchronize Videos with each other. This can be useful when you want animations/videos to sync up with audio, in perfect unison without having to worry about networking.

Examples

Used in 989onan's MMD player and Emote System to sync audio with the dance when the user is dancing with the system.

See Also