Menu
Lumberyard
Legacy Reference

VideoPlayback Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

You can use the following flow graph nodes to configure video playback settings.

Play Node

Plays the video on the defined entity with the VideoPlayback component.

Inputs

Port Type Description
Activate Boolean Value of true begins playing video.
Loop Boolean Value of true loops video.
PlaybackSpeed Float Sets speed of playback. Value of 1 is normal speed, 0.5 is half speed, 2.0 is double speed, and so on.

Pause Nodes

Pauses the video on the defined entity with the VideoPlayback component.

Input

Port Type Description
Activate Boolean Value of true pauses the video.

Stop Nodes

Stops the video on the defined entity with the VideoPlayback component.

Input

Port Type Description
Activate Boolean Value of true stops the video. If video playback is resumed, it begins at the first frame of the video.

IsPlaying Nodes

Determines whether the VideoPlayback component on the defined entity is currently playing video.

Input

Port Type Description
Activate Boolean Value of true triggers output to the Playing output node. Output is triggered whether video is playing or not.

Output

Port Type Description
Playing Boolean Returns true if video is playing, false if video is paused or stopped.

PlaybackEvents Nodes

Provides a series of outputs that are triggered when the defined entity's VideoPlayback component reaches certain conditions.

Input

Port Type Description
Activate Boolean Value of true triggers node to listen for video playback events on the defined entity.

Outputs

Port Type Description
PlaybackStarted Boolean Triggered when the video begins playback.
PlaybackPaused Boolean Triggered when video playback is paused.
PlaybackStopped Boolean

Triggered when video playback is stopped.

If a video is not set to loop and finishes without user intervention, this is not triggered; this is triggered only when Stop is directly called.

PlaybackFinished Boolean

Triggered when video playback finishes.

If a video is set to loop, this is called every time that video finishes a loop.