org.alembik.util
Enum TranscodingUtils.TextOverlayAttr

java.lang.Object
  java.lang.Enum<TranscodingUtils.TextOverlayAttr>
      org.alembik.util.TranscodingUtils.TextOverlayAttr

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TranscodingUtils.TextOverlayAttr>

Enclosing class:

TranscodingUtils

public static enum TranscodingUtils.TextOverlayAttr
extends java.lang.Enum<TranscodingUtils.TextOverlayAttr>

The TextOverlay transformation attributes.

There are three attributes used for both image and video: message, family, color. The rest is specific to the media type that gets overlayed.

See Also:

TranscodingUtils.setImageTextOverlay(TranscodingJob, String, org.alembik.util.TranscodingUtils.TextOverlayFont), TranscodingUtils.setVideoTextOverlay(TranscodingJob, String, org.alembik.util.TranscodingUtils.TextOverlayFont, org.alembik.util.TranscodingUtils.Coordinates), TranscodingUtils.setVideoTextScrollOverlay(TranscodingJob, String, org.alembik.util.TranscodingUtils.TextOverlayFont, org.alembik.util.TranscodingUtils.Coordinates), TranscodingUtils.getOverlayLogoAttrs(TranscodingJob)

Enum Constant Summary

COLOR
The font color of the overlayed text.

DURATION
The number of seconds the text should be displayed over the video.

EFFECT
The additional effect (applies to images only).

FAMILY
The font family of the overlayed text.

MESSAGE
The text to be overlayed.

OFFSET
The starting moment in the video (in seconds) when the text should appear.

OPACITY
The text opacity (applies to images only).

ORIENTATION
The font/text orientation (applies to images only).

POSX
The horizontal position (in pixels) of the text in the video frame.

POSY
The vertical position (in pixels) of the text in the video frame.

SCROLL
If true the text will be scrolled over the video.

SIZE
The font size (applies to videos only).

SMOOTH
If true the text will be smoothened (applies to images only).

STYLE
The font style (applies to images only).

Method Summary

static TranscodingUtils.TextOverlayAttr	fromName(java.lang.String name) Gets the enum instance of the given attribute name.
java.lang.String	getName() Returns the name of the attribute.
static TranscodingUtils.TextOverlayAttr	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TranscodingUtils.TextOverlayAttr[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MESSAGE

public static final TranscodingUtils.TextOverlayAttr MESSAGE

The text to be overlayed.

FAMILY

public static final TranscodingUtils.TextOverlayAttr FAMILY

The font family of the overlayed text.

See Also:

TranscodingUtils.TextOverlayFamily

COLOR

public static final TranscodingUtils.TextOverlayAttr COLOR

The font color of the overlayed text.

See Also:

TranscodingUtils.TextOverlayColor

STYLE

public static final TranscodingUtils.TextOverlayAttr STYLE

The font style (applies to images only).

See Also:

TranscodingUtils.TextOverlayStyle

OPACITY

public static final TranscodingUtils.TextOverlayAttr OPACITY

The text opacity (applies to images only).

SMOOTH

public static final TranscodingUtils.TextOverlayAttr SMOOTH

If true the text will be smoothened (applies to images only).

ORIENTATION

public static final TranscodingUtils.TextOverlayAttr ORIENTATION

The font/text orientation (applies to images only).

See Also:

TranscodingUtils.TextOverlayOrientation

EFFECT

public static final TranscodingUtils.TextOverlayAttr EFFECT

The additional effect (applies to images only).

See Also:

TranscodingUtils.TextOverlayEffect

OFFSET

public static final TranscodingUtils.TextOverlayAttr OFFSET

The starting moment in the video (in seconds) when the text should appear.

SIZE

public static final TranscodingUtils.TextOverlayAttr SIZE

The font size (applies to videos only).

POSY

public static final TranscodingUtils.TextOverlayAttr POSY

The vertical position (in pixels) of the text in the video frame.

POSX

public static final TranscodingUtils.TextOverlayAttr POSX

The horizontal position (in pixels) of the text in the video frame.

SCROLL

public static final TranscodingUtils.TextOverlayAttr SCROLL

If true the text will be scrolled over the video.

DURATION

public static final TranscodingUtils.TextOverlayAttr DURATION

The number of seconds the text should be displayed over the video.

Method Detail

values

public static final TranscodingUtils.TextOverlayAttr[] values()

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

for(TranscodingUtils.TextOverlayAttr c : TranscodingUtils.TextOverlayAttr.values())
        System.out.println(c);

Returns:

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

valueOf

public static TranscodingUtils.TextOverlayAttr valueOf(java.lang.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:

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

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

name value

fromName

public static TranscodingUtils.TextOverlayAttr fromName(java.lang.String name)

Gets the enum instance of the given attribute name.

Parameters:

name - the attribute name

Returns:

enum instance.