org.alembik.util
Class TranscodingUtils.TextOverlayFont

java.lang.Object
  org.alembik.util.TranscodingUtils.TextOverlayFont

Enclosing class:

TranscodingUtils

public static class TranscodingUtils.TextOverlayFont
extends java.lang.Object

The holder class for the font-related attributes of the TextOverlay transformation.

See Also:

TranscodingUtils.TRANSFORMATION_TEXT_OVERLAY, 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)

Constructor Summary

TranscodingUtils.TextOverlayFont(java.lang.String imageFamily, TranscodingUtils.TextOverlayColor color, TranscodingUtils.TextOverlayStyle style)
Creates the basic set of font attributes for the TextOverlay transformation to be applied on the image content.

TranscodingUtils.TextOverlayFont(java.lang.String imageFamily, TranscodingUtils.TextOverlayColor color, TranscodingUtils.TextOverlayStyle style, TranscodingUtils.TextOverlayOrientation orientation, TranscodingUtils.TextOverlayEffect effect, java.lang.Integer opacity, java.lang.Boolean smooth)
Creates the full set of font attributes for the TextOverlay transformation to be applied on the image content.

TranscodingUtils.TextOverlayFont(TranscodingUtils.TextOverlayFamily videoFamily, TranscodingUtils.TextOverlayColor color, java.lang.Integer size)
Creates the basic set of font attributes for the TextOverlay transformation to be applied on the video content.

Method Summary

TranscodingUtils.TextOverlayColor	getColor()
TranscodingUtils.TextOverlayEffect	getEffect()
java.lang.String	getImageFamily()
java.lang.Integer	getOpacity()
TranscodingUtils.TextOverlayOrientation	getOrientation()
java.lang.Integer	getSize()
java.lang.Boolean	getSmooth()
TranscodingUtils.TextOverlayStyle	getStyle()
TranscodingUtils.TextOverlayFamily	getVideoFamily()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TranscodingUtils.TextOverlayFont

public TranscodingUtils.TextOverlayFont(java.lang.String imageFamily,
                                        TranscodingUtils.TextOverlayColor color,
                                        TranscodingUtils.TextOverlayStyle style)

Creates the basic set of font attributes for the TextOverlay transformation to be applied on the image content.

Parameters:

imageFamily - name of the font

color - font color

style - font style

TranscodingUtils.TextOverlayFont

public TranscodingUtils.TextOverlayFont(java.lang.String imageFamily,
                                        TranscodingUtils.TextOverlayColor color,
                                        TranscodingUtils.TextOverlayStyle style,
                                        TranscodingUtils.TextOverlayOrientation orientation,
                                        TranscodingUtils.TextOverlayEffect effect,
                                        java.lang.Integer opacity,
                                        java.lang.Boolean smooth)

Creates the full set of font attributes for the TextOverlay transformation to be applied on the image content.

Parameters:

imageFamily - name of the font; the acceptable values are Serif, Sans-serif, Monospaced, Dialog, DialogInput and all the other ones supported by the server's JRE

color - font color

style - font style

orientation - font orientation

effect - additional effect to be applied

opacity - font opacity from the range: [0-100]

smooth - font anti-aliasing

TranscodingUtils.TextOverlayFont

public TranscodingUtils.TextOverlayFont(TranscodingUtils.TextOverlayFamily videoFamily,
                                        TranscodingUtils.TextOverlayColor color,
                                        java.lang.Integer size)

Creates the basic set of font attributes for the TextOverlay transformation to be applied on the video content.

Parameters:

videoFamily - name of the font

color - font color

size - font size

Method Detail

getImageFamily

public java.lang.String getImageFamily()

Returns:

font name for the text over an image

See Also:

TranscodingUtils.TextOverlayAttr.FAMILY

getVideoFamily

public TranscodingUtils.TextOverlayFamily getVideoFamily()

Returns:

font name for the text over a video

See Also:

TranscodingUtils.TextOverlayAttr.FAMILY

getColor

public TranscodingUtils.TextOverlayColor getColor()

Returns:

font color

See Also:

TranscodingUtils.TextOverlayAttr.COLOR

getStyle

public TranscodingUtils.TextOverlayStyle getStyle()

Returns:

font style

See Also:

TranscodingUtils.TextOverlayAttr.STYLE

getOrientation

public TranscodingUtils.TextOverlayOrientation getOrientation()

Returns:

font orientation

See Also:

TranscodingUtils.TextOverlayAttr.ORIENTATION

getEffect

public TranscodingUtils.TextOverlayEffect getEffect()

Returns:

font effect

See Also:

TranscodingUtils.TextOverlayAttr.EFFECT

getOpacity

public java.lang.Integer getOpacity()

Returns:

font opacity

See Also:

TranscodingUtils.TextOverlayAttr.OPACITY

getSmooth

public java.lang.Boolean getSmooth()

Returns:

true if font smoothness is required

See Also:

TranscodingUtils.TextOverlayAttr.SMOOTH

getSize

public java.lang.Integer getSize()

Returns:

font size

See Also:

TranscodingUtils.TextOverlayAttr.SIZE