com.appscend.media.events

Enum APSMediaOverlay.APSMediaOverlayPosition

java.lang.Object

java.lang.Enum<APSMediaOverlay.APSMediaOverlayPosition>

com.appscend.media.events.APSMediaOverlay.APSMediaOverlayPosition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<APSMediaOverlay.APSMediaOverlayPosition>

Enclosing class:

APSMediaOverlay

public static enum APSMediaOverlay.APSMediaOverlayPosition
extends java.lang.Enum<APSMediaOverlay.APSMediaOverlayPosition>

Describes the position the overlay should take when placed on-screen by the player.

Enum Constant Summary

Enum Constants

Enum Constant and Description
kAPSMediaOverlayPositionBottom The overlay should be placed centrally at the bottom of the player surface.
kAPSMediaOverlayPositionBottomLeft The overlay should be bottom-left aligned with the player surface.
kAPSMediaOverlayPositionBottomRight The overlay should be bottom-right aligned with the player surface.
kAPSMediaOverlayPositionFullscreen The overlay should be stretched to fit the whole player surface.
kAPSMediaOverlayPositionLeft The overlay should be vertically centered to the left of the player surface.
kAPSMediaOverlayPositionRight The overlay should be vertically centered to the right of the player surface.
kAPSMediaOverlayPositionTop The overlay should be placed centrally in the top of the player surface.
kAPSMediaOverlayPositionTopLeft The overlay should be top-left aligned with the player surface.
kAPSMediaOverlayPositionTopRight The overlay should be top-right aligned with the player surface.
kAPSMediaOverlayPositionUnspecified The overlay will not be placed on screen.

Method Summary

Modifier and Type	Method and Description
static APSMediaOverlay.APSMediaOverlayPosition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static APSMediaOverlay.APSMediaOverlayPosition[]	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

kAPSMediaOverlayPositionFullscreen

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionFullscreen

The overlay should be stretched to fit the whole player surface.

kAPSMediaOverlayPositionBottomLeft

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionBottomLeft

The overlay should be bottom-left aligned with the player surface.

kAPSMediaOverlayPositionBottomRight

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionBottomRight

The overlay should be bottom-right aligned with the player surface.

kAPSMediaOverlayPositionTopLeft

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionTopLeft

The overlay should be top-left aligned with the player surface.

kAPSMediaOverlayPositionTopRight

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionTopRight

The overlay should be top-right aligned with the player surface.

kAPSMediaOverlayPositionTop

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionTop

The overlay should be placed centrally in the top of the player surface.

kAPSMediaOverlayPositionBottom

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionBottom

The overlay should be placed centrally at the bottom of the player surface.

kAPSMediaOverlayPositionLeft

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionLeft

The overlay should be vertically centered to the left of the player surface.

kAPSMediaOverlayPositionRight

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionRight

The overlay should be vertically centered to the right of the player surface.

kAPSMediaOverlayPositionUnspecified

public static final APSMediaOverlay.APSMediaOverlayPosition kAPSMediaOverlayPositionUnspecified

The overlay will not be placed on screen.

Method Detail

values

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

Returns:

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

valueOf

public static APSMediaOverlay.APSMediaOverlayPosition 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

java.lang.NullPointerException - if the argument is null