Component:PlaybackStateDriver

From Resonite Wiki
Revision as of 18:22, 13 November 2024 by 989onan (talk | contribs) (add desc, usage, see also)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Playback State Driver component as seen in the Scene Inspector

The PlaybackStateDriver is a component that drives a set of booleans to whether or not certain states are currently active or not for a particular IPlayable.

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.
Source IPlayable Playback source - VideoTextureProvider or Playback
IsPlaying field drive of Bool Will drive IField<bool> to true if playing, false if not playing
IsNotPlaying field drive of Bool Will drive IField<bool> to true is not playing, false if playing
IsPaused field drive of Bool Will drive IField<bool> to true if playable is paused
IsStopped field drive of Bool Will drive IField<bool> to true if playable is stopped

Usage

Attach to a slot and provide Source any Bool provided to the other fields will be driven to the status of that field's status check.

Examples

Example of PlaybackStateDriver The Source (being driven by a VideoTextureProvider) is driving the ValueField<bool> Value to true, since the video is playing.

See Also