Component:PlaybackStateDriver: Difference between revisions

Latest revision as of 18:22, 13 November 2024

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. Some components stop their functionality when this field is disabled, but some don't.
`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

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

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=PlaybackStateDriverComponent.png
 |Name=Playback State Driver
 }}
+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 [[Type:IPlayable|IPlayable]].
 <!--T:2-->
@@ Line 14: / Line 14: @@
 |IsPlaying|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Will drive IField<bool> to true if playing, false if not playing
 |IsNotPlaying|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Will drive IField<bool> to true is not playing, false if playing
-|IsPaused|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Will drive IField<bool> to true if video is paused
+|IsPaused|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Will drive IField<bool> to true if playable is paused
-|IsStopped|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv4=true| Will drive IField<bool> to true if video is stopped
+|IsStopped|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv4=true| Will drive IField<bool> to true if playable is stopped
 }}
 <!--T:3-->
 == Usage ==
+Attach to a slot and provide <code>Source</code> any [[Type:Bool|Bool]] provided to the other fields will be driven to the status of that field's status check.
 <!--T:4-->
@@ Line 27: / Line 28: @@
 <!--T:5-->
-== Related Components ==
+== See Also ==
+* [[Component:IsPlayingDriver]]
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Playback State Driver]]
 [[Category:Components:Media:Utility{{#translation:}}|Playback State Driver]]