com.amazonaws.services.mediaconvert.model

Class HlsImageBasedTrickPlaySettings

java.lang.Object

com.amazonaws.services.mediaconvert.model.HlsImageBasedTrickPlaySettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HlsImageBasedTrickPlaySettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HlsImageBasedTrickPlaySettings()

Method Summary

Modifier and Type	Method and Description
HlsImageBasedTrickPlaySettings	clone()
boolean	equals(Object obj)
String	getIntervalCadence() The cadence MediaConvert follows for generating thumbnails.
Integer	getThumbnailHeight() Height of each thumbnail within each tile image, in pixels.
Double	getThumbnailInterval() Enter the interval, in seconds, that MediaConvert uses to generate thumbnails.
Integer	getThumbnailWidth() Width of each thumbnail within each tile image, in pixels.
Integer	getTileHeight() Number of thumbnails in each column of a tile image.
Integer	getTileWidth() Number of thumbnails in each row of a tile image.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIntervalCadence(String intervalCadence) The cadence MediaConvert follows for generating thumbnails.
void	setThumbnailHeight(Integer thumbnailHeight) Height of each thumbnail within each tile image, in pixels.
void	setThumbnailInterval(Double thumbnailInterval) Enter the interval, in seconds, that MediaConvert uses to generate thumbnails.
void	setThumbnailWidth(Integer thumbnailWidth) Width of each thumbnail within each tile image, in pixels.
void	setTileHeight(Integer tileHeight) Number of thumbnails in each column of a tile image.
void	setTileWidth(Integer tileWidth) Number of thumbnails in each row of a tile image.
String	toString() Returns a string representation of this object.
HlsImageBasedTrickPlaySettings	withIntervalCadence(HlsIntervalCadence intervalCadence) The cadence MediaConvert follows for generating thumbnails.
HlsImageBasedTrickPlaySettings	withIntervalCadence(String intervalCadence) The cadence MediaConvert follows for generating thumbnails.
HlsImageBasedTrickPlaySettings	withThumbnailHeight(Integer thumbnailHeight) Height of each thumbnail within each tile image, in pixels.
HlsImageBasedTrickPlaySettings	withThumbnailInterval(Double thumbnailInterval) Enter the interval, in seconds, that MediaConvert uses to generate thumbnails.
HlsImageBasedTrickPlaySettings	withThumbnailWidth(Integer thumbnailWidth) Width of each thumbnail within each tile image, in pixels.
HlsImageBasedTrickPlaySettings	withTileHeight(Integer tileHeight) Number of thumbnails in each column of a tile image.
HlsImageBasedTrickPlaySettings	withTileWidth(Integer tileWidth) Number of thumbnails in each row of a tile image.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HlsImageBasedTrickPlaySettings

public HlsImageBasedTrickPlaySettings()

Method Detail

setIntervalCadence

public void setIntervalCadence(String intervalCadence)

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Parameters:

intervalCadence - The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

See Also:

HlsIntervalCadence

getIntervalCadence

public String getIntervalCadence()

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Returns:

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

See Also:

HlsIntervalCadence

withIntervalCadence

public HlsImageBasedTrickPlaySettings withIntervalCadence(String intervalCadence)

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Parameters:

intervalCadence - The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsIntervalCadence

withIntervalCadence

public HlsImageBasedTrickPlaySettings withIntervalCadence(HlsIntervalCadence intervalCadence)

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Parameters:

intervalCadence - The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsIntervalCadence

setThumbnailHeight

public void setThumbnailHeight(Integer thumbnailHeight)

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

Parameters:

thumbnailHeight - Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

getThumbnailHeight

public Integer getThumbnailHeight()

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

Returns:

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

withThumbnailHeight

public HlsImageBasedTrickPlaySettings withThumbnailHeight(Integer thumbnailHeight)

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

Parameters:

thumbnailHeight - Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

Returns:

Returns a reference to this object so that method calls can be chained together.

setThumbnailInterval

public void setThumbnailInterval(Double thumbnailInterval)

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

Parameters:

thumbnailInterval - Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

getThumbnailInterval

public Double getThumbnailInterval()

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

Returns:

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

withThumbnailInterval

public HlsImageBasedTrickPlaySettings withThumbnailInterval(Double thumbnailInterval)

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

Parameters:

thumbnailInterval - Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

Returns:

Returns a reference to this object so that method calls can be chained together.

setThumbnailWidth

public void setThumbnailWidth(Integer thumbnailWidth)

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

Parameters:

thumbnailWidth - Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

getThumbnailWidth

public Integer getThumbnailWidth()

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

Returns:

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

withThumbnailWidth

public HlsImageBasedTrickPlaySettings withThumbnailWidth(Integer thumbnailWidth)

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

Parameters:

thumbnailWidth - Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTileHeight

public void setTileHeight(Integer tileHeight)

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

Parameters:

tileHeight - Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

getTileHeight

public Integer getTileHeight()

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

Returns:

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

withTileHeight

public HlsImageBasedTrickPlaySettings withTileHeight(Integer tileHeight)

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

Parameters:

tileHeight - Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTileWidth

public void setTileWidth(Integer tileWidth)

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

Parameters:

tileWidth - Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

getTileWidth

public Integer getTileWidth()

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

Returns:

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

withTileWidth

public HlsImageBasedTrickPlaySettings withTileWidth(Integer tileWidth)

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

Parameters:

tileWidth - Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HlsImageBasedTrickPlaySettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.