org.alembik.util
Enum TranscodingUtils.OverlayLogoAttr

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

All Implemented Interfaces:

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

Enclosing class:

TranscodingUtils

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

OverlayLogo transformation attributes.

There are three common attributes for both image and video targets: src, protocol and width. The rest is specific to the media type that gets overlayed.

See Also:

TranscodingUtils.setImageOverlayLogo(TranscodingJob, String, org.alembik.util.TranscodingUtils.OverlayLogoColor, Integer), TranscodingUtils.setVideoOverlayLogo(TranscodingJob, String, org.alembik.util.TranscodingUtils.Coordinates, Integer), TranscodingUtils.getOverlayLogoAttrs(TranscodingJob)

Enum Constant Summary

DURATION
The number of seconds the logo should be present.

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

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

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

PROTOCOL
The name of the protocol to be used to fetch the logo (for example "HTTP").

SRC
The location of a logo to be overlayed.

TRANSPARENT_COLOR
The background color of the underlying image.

WIDTH
The desired logo width in pixels.

Method Summary

static TranscodingUtils.OverlayLogoAttr	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.OverlayLogoAttr	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TranscodingUtils.OverlayLogoAttr[]	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

SRC

public static final TranscodingUtils.OverlayLogoAttr SRC

The location of a logo to be overlayed.

PROTOCOL

public static final TranscodingUtils.OverlayLogoAttr PROTOCOL

The name of the protocol to be used to fetch the logo (for example "HTTP").

See Also:

TranscodingUtils.SourceProtocol

WIDTH

public static final TranscodingUtils.OverlayLogoAttr WIDTH

The desired logo width in pixels.

TRANSPARENT_COLOR

public static final TranscodingUtils.OverlayLogoAttr TRANSPARENT_COLOR

The background color of the underlying image.

See Also:

TranscodingUtils.OverlayLogoColor

POSX

public static final TranscodingUtils.OverlayLogoAttr POSX

The horizontal position (in pixels) of the logo in the video.

POSY

public static final TranscodingUtils.OverlayLogoAttr POSY

The vertical position (in pixels) of the logo in the video.

OFFSET

public static final TranscodingUtils.OverlayLogoAttr OFFSET

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

DURATION

public static final TranscodingUtils.OverlayLogoAttr DURATION

The number of seconds the logo should be present.

Method Detail

values

public static final TranscodingUtils.OverlayLogoAttr[] 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.OverlayLogoAttr c : TranscodingUtils.OverlayLogoAttr.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.OverlayLogoAttr 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.OverlayLogoAttr fromName(java.lang.String name)

Gets the enum instance of the given attribute name.

Parameters:

name - the attribute name

Returns:

enum instance.