agi.foundation.graphics.imaging

(agi.foundation.graphics-2024r2.jar)

Enum VideoPlayback

java.lang.Object

java.lang.Enum<VideoPlayback>

agi.foundation.graphics.imaging.VideoPlayback

All Implemented Interfaces:

Enumeration, Serializable, Comparable<VideoPlayback>

public enum VideoPlayback
extends Enum<VideoPlayback>
implements Enumeration

Specifies how the VideoStream will playback. When the Playback (get) is set to RealTime, the video will playback in real time. When the Playback (get) is set to TimeInterval, the video will seek to the frame that corresponds linearly to the current SceneManager time within the interval defined by IntervalStartTime (get) and IntervalEndTime (get). For instance, if the video contains 60 frames and the IntervalStartTime (get) and IntervalEndTime (get) specify a 60 minute interval, the first frame of the video will be displayed when the SceneManager time is equal to IntervalStartTime (get). Similarly, when SceneManager time is equal to IntervalEndTime (get), the last frame of the video will be displayed. Intermediate times within that interval are mapped linearly to the frames in the video.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REAL_TIME The video will playback in realtime.
TIME_INTERVAL The video will playback in coincidence with the SceneManager time within the interval defined by IntervalStartTime (get) and IntervalEndTime (get).

Method Summary

Modifier and Type	Method and Description
static VideoPlayback	getDefault() Get the enum constant that is considered to be the default.
static VideoPlayback	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static VideoPlayback	valueOf(String name) Returns the enum constant of this type with the specified name.
static VideoPlayback[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REAL_TIME

public static final VideoPlayback REAL_TIME

The video will playback in realtime.

TIME_INTERVAL

public static final VideoPlayback TIME_INTERVAL

The video will playback in coincidence with the SceneManager time within the interval defined by IntervalStartTime (get) and IntervalEndTime (get).

For optimal synchronization with Insight3D animation, a video format should be used that supports frame accurate seeking through indexing. Motion JPEG (M-JPEG), Digital Video (DVSD), and Quicktime (MOV), are among the codecs and formats that provide full index blocks and support frame accurate seeking.

Method Detail

values

public static VideoPlayback[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VideoPlayback c : VideoPlayback.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VideoPlayback valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static VideoPlayback getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static VideoPlayback getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.