Package com.amazonaws.kinesisvideo.producer

Enum FrameOrderMode

java.lang.Object

java.lang.Enum<FrameOrderMode>

com.amazonaws.kinesisvideo.producer.FrameOrderMode

All Implemented Interfaces:

Serializable, Comparable<FrameOrderMode>

public enum FrameOrderMode
extends Enum<FrameOrderMode>

Definition of the FrameOrderMode. NOTE: This enum must be the same as defined in /client/Include.h

Enum Constant Summary

Enum Constants

Enum Constant	Description
FRAME_ORDER_MODE_PASS_THROUGH	When in FRAME_ORDER_MODE_PASS_THROUGH, when putKinesisVideoFrame is called, the frame is submitted immediately
FRAME_ORDERING_MODE_MULTI_TRACK_AV	When in FRAME_ORDERING_MODE_MULTI_TRACK_AV, frames are submitted in the order of their dts.
FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_DTS_ONE_MS_COMPENSATE	If frames from different tracks have dts difference less than mkv timecode scale, then add 1 unit of mkv timecode scale to the latter frame to avoid backend reporting fragment overlap.
FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_PTS_ONE_MS_COMPENSATE	same as the dts counter part, but compares pts instead.

Method Summary

Modifier and Type	Method	Description
static int	getFrameOrderMode(String status)
int	intValue()
static FrameOrderMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FrameOrderMode[]	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

FRAME_ORDER_MODE_PASS_THROUGH

public static final FrameOrderMode FRAME_ORDER_MODE_PASS_THROUGH

When in FRAME_ORDER_MODE_PASS_THROUGH, when putKinesisVideoFrame is called, the frame is submitted immediately

FRAME_ORDERING_MODE_MULTI_TRACK_AV

public static final FrameOrderMode FRAME_ORDERING_MODE_MULTI_TRACK_AV

When in FRAME_ORDERING_MODE_MULTI_TRACK_AV, frames are submitted in the order of their dts. In case of two frames having the same mkv timestamp, and one of them being key frame, the key frame flag is moved to the earliest frame to make sure we dont have cluster end timestamp being equal to the next cluster beginning timestamp.

FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_DTS_ONE_MS_COMPENSATE

public static final FrameOrderMode FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_DTS_ONE_MS_COMPENSATE

If frames from different tracks have dts difference less than mkv timecode scale, then add 1 unit of mkv timecode scale to the latter frame to avoid backend reporting fragment overlap. This will be deprecated once backend is fixed.

FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_PTS_ONE_MS_COMPENSATE

public static final FrameOrderMode FRAME_ORDERING_MODE_MULTI_TRACK_AV_COMPARE_PTS_ONE_MS_COMPENSATE

same as the dts counter part, but compares pts instead.

Method Detail

values

public static FrameOrderMode[] 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 (FrameOrderMode c : FrameOrderMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static FrameOrderMode 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

getFrameOrderMode

public static final int getFrameOrderMode(String status)

intValue

public final int intValue()