Video Player

From RealMotion Wiki

Content/Video Player

Load and play a video file. ​

Description

The Video Player box read and play video files. The Video Player is based on FFmpeg . The Video Player allows looping, seeking and volume setting.

Multiple Video Player boxes can be synchronized with the External Sync Mode.

Inputs

Filename String Receives the filename of the video to play.
Load File Trigger Loads the video file on reception of this event.
Looping Int Enables the video looping when the received integer is not equal to zero.
Pause Trigger Pauses the video on reception of this event.
Play Trigger Plays the video on reception of this event.
Seek Trigger Seeks the video to the inputted Seek Time on reception of this event.
Seek Time Float Receives the seek time.
Stop Trigger Stops the video on reception of this event.
Time Float, Animation Time Receives an external timecode used for the video playback.
Volume Float Receives the volume level.

Outputs

Audio Video Audio Video Line Outputs the video stream in a texture and the sound of the video into an Audio Line. Merged in the Audio Video Line, the video texture and the video audio may be faded with the Selector box.
Complete Trigger Trigger an event when the last frame of the video is played.
Info Video Info Outputs the information of the current video. The Video Info type is a specific data structure containing the absolute filepath, the relative filepath (Uri), the video duration, the video frame rate, the width, the height and the status of the Video Player. The Video Info may be read by the Get Item box.
Stats Video Statistics Outputs information about the video player. The Video Stats type is a specific data structure containing real-time statistics about the internal function of the video player. The Video Stats can be read by the Get Item box.
Time Float Outputs the current video time.

Parameters

General

Loading

Enable Input Pin: Filename Toggle Enables the Filename Input Pin and overrides the Filename parameter.
Filename Uri Indicates the path of the video to load.
Enable Input Pin: Load File Toggle Enables the Input Pin: Load File
Seek Toggle Enables the Seek Output Pin to allow seeking on runtime.

Playback

Start Paused Toggle Start the video paused on launch and on load of a new video,
Enable Input Pin: Play Toggle Enables the Input Pin: Play
Enable Input Pin: Pause Toggle Enables the Input Pin: Pause
Enable Input Pin: Stop Toggle Enables the Input Pin: Stop
Enable Input Pin: Looping Toggle Enables the Looping Input Pin and overrides the Looping parameter.
Looping Toggle Loops the video.
Enable Output Pin: Time Toggle Enables the Output Pin: Time

Display

Interpolate Frames Toggle Smooths the video output is the RealMotion FPS is higher than the video FPS. For example, the Video Player running at 60 FPS will interpolate the missing frame of 30 FPS video.

Audio

Enable Input Pin: Volume Toggle Enables the Volume Input Pin and overrides the Volume parameter.
Volume Float Enables the Audio Line Output Pin. Mostly Used in External Sync Mode.

Advanced

Sync Mode String Sets the playback mode of the video player. In Internal mode, the video player sends the sound directly to the sound card. In External mode, the video player will use the Timecode and the sound must be manually managed.
Seek to nearest key frame Toggle Enables the seek to the nearest key frame. Work best with videos containing key frame at 1 second interval or less.
YUV Color Space Override String Overrides the default Color Space used to read the video.
Enable Output Pin: Complete Toggle Enables the Complete Output Pin and output an event when the video reach its end.
Enable Output Pin: Info Toggle Enables the Info Output Pin. The Video Info type is a specific data structure containing the absolute filepath, the relative filepath (Uri), the video duration, the video framerate, the width, the height and the status of the Video Player. The Video Info may be read by the Get Item box.
Enable Output Pin: Stats Toggle Enables the Stats Output Pin. The Video Stats type is a specific data structure containing real time statistics about the internal function of the video player. The Video Stats can be read by the Get Item box.
Verbose Toggle When enabled, outputs information into the console.
Record Data Toggle Record the data of each frame of the current Video Player in a file. The command "datarecorder enable" also need to be inputted in the console to enable for all videos players the Record Data.
Default Video Uri Sets and overrides the video or image fallback in case the 'Filename' parameter cannot be loaded correctly.

See Also

Boxes related

Audio Player, Audio Player, Paint, Texture, Texture Buffer, Web Browser, Datapath Capture, Selector, Get Item, Audio Video Line, String, ​​

Version Information

Current documentation version: 2.1.5. ​ ​