com.amazonaws.services.ivs.model

Class ThumbnailConfiguration

java.lang.Object

com.amazonaws.services.ivs.model.ThumbnailConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An object representing a configuration of thumbnails for recorded video.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThumbnailConfiguration()

Method Summary

Modifier and Type	Method and Description
ThumbnailConfiguration	clone()
boolean	equals(Object obj)
String	getRecordingMode() Thumbnail recording mode.
String	getResolution() Indicates the desired resolution of recorded thumbnails.
List<String>	getStorage() Indicates the format in which thumbnails are recorded.
Long	getTargetIntervalSeconds() The targeted thumbnail-generation interval in seconds.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setRecordingMode(String recordingMode) Thumbnail recording mode.
void	setResolution(String resolution) Indicates the desired resolution of recorded thumbnails.
void	setStorage(Collection<String> storage) Indicates the format in which thumbnails are recorded.
void	setTargetIntervalSeconds(Long targetIntervalSeconds) The targeted thumbnail-generation interval in seconds.
String	toString() Returns a string representation of this object.
ThumbnailConfiguration	withRecordingMode(RecordingMode recordingMode) Thumbnail recording mode.
ThumbnailConfiguration	withRecordingMode(String recordingMode) Thumbnail recording mode.
ThumbnailConfiguration	withResolution(String resolution) Indicates the desired resolution of recorded thumbnails.
ThumbnailConfiguration	withResolution(ThumbnailConfigurationResolution resolution) Indicates the desired resolution of recorded thumbnails.
ThumbnailConfiguration	withStorage(Collection<String> storage) Indicates the format in which thumbnails are recorded.
ThumbnailConfiguration	withStorage(String... storage) Indicates the format in which thumbnails are recorded.
ThumbnailConfiguration	withStorage(ThumbnailConfigurationStorage... storage) Indicates the format in which thumbnails are recorded.
ThumbnailConfiguration	withTargetIntervalSeconds(Long targetIntervalSeconds) The targeted thumbnail-generation interval in seconds.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ThumbnailConfiguration

public ThumbnailConfiguration()

Method Detail

setRecordingMode

public void setRecordingMode(String recordingMode)

Thumbnail recording mode. Default: INTERVAL.

Parameters:

recordingMode - Thumbnail recording mode. Default: INTERVAL.

See Also:

RecordingMode

getRecordingMode

public String getRecordingMode()

Thumbnail recording mode. Default: INTERVAL.

Returns:

Thumbnail recording mode. Default: INTERVAL.

See Also:

RecordingMode

withRecordingMode

public ThumbnailConfiguration withRecordingMode(String recordingMode)

Thumbnail recording mode. Default: INTERVAL.

Parameters:

recordingMode - Thumbnail recording mode. Default: INTERVAL.

Returns:

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

See Also:

RecordingMode

withRecordingMode

public ThumbnailConfiguration withRecordingMode(RecordingMode recordingMode)

Thumbnail recording mode. Default: INTERVAL.

Parameters:

recordingMode - Thumbnail recording mode. Default: INTERVAL.

Returns:

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

See Also:

RecordingMode

setTargetIntervalSeconds

public void setTargetIntervalSeconds(Long targetIntervalSeconds)

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Parameters:

targetIntervalSeconds - The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

getTargetIntervalSeconds

public Long getTargetIntervalSeconds()

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Returns:

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

withTargetIntervalSeconds

public ThumbnailConfiguration withTargetIntervalSeconds(Long targetIntervalSeconds)

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Parameters:

targetIntervalSeconds - The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Returns:

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

setResolution

public void setResolution(String resolution)

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Parameters:

resolution - Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

See Also:

ThumbnailConfigurationResolution

getResolution

public String getResolution()

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Returns:

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

See Also:

ThumbnailConfigurationResolution

withResolution

public ThumbnailConfiguration withResolution(String resolution)

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Parameters:

resolution - Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Returns:

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

See Also:

ThumbnailConfigurationResolution

withResolution

public ThumbnailConfiguration withResolution(ThumbnailConfigurationResolution resolution)

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Parameters:

resolution - Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

Returns:

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

See Also:

ThumbnailConfigurationResolution

getStorage

public List<String> getStorage()

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Returns:

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

See Also:

ThumbnailConfigurationStorage

setStorage

public void setStorage(Collection<String> storage)

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Parameters:

storage - Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

See Also:

ThumbnailConfigurationStorage

withStorage

public ThumbnailConfiguration withStorage(String... storage)

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

NOTE: This method appends the values to the existing list (if any). Use setStorage(java.util.Collection) or withStorage(java.util.Collection) if you want to override the existing values.

Parameters:

storage - Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Returns:

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

See Also:

ThumbnailConfigurationStorage

withStorage

public ThumbnailConfiguration withStorage(Collection<String> storage)

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Parameters:

storage - Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Returns:

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

See Also:

ThumbnailConfigurationStorage

withStorage

public ThumbnailConfiguration withStorage(ThumbnailConfigurationStorage... storage)

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Parameters:

storage - Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Returns:

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

See Also:

ThumbnailConfigurationStorage

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 ThumbnailConfiguration 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.