FrameCaptureSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.FrameCaptureSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FrameCaptureSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FrameCaptureSettings()

Constructors
Constructor and Description
`FrameCaptureSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FrameCaptureSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getFramerateDenominator()` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`Integer`	`getFramerateNumerator()` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`Integer`	`getMaxCaptures()` Maximum number of captures (encoded jpg output files).
`Integer`	`getQuality()` JPEG Quality - a higher value equals higher quality.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFramerateDenominator(Integer framerateDenominator)` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`void`	`setFramerateNumerator(Integer framerateNumerator)` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`void`	`setMaxCaptures(Integer maxCaptures)` Maximum number of captures (encoded jpg output files).
`void`	`setQuality(Integer quality)` JPEG Quality - a higher value equals higher quality.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`FrameCaptureSettings`	`withFramerateDenominator(Integer framerateDenominator)` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`FrameCaptureSettings`	`withFramerateNumerator(Integer framerateNumerator)` Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
`FrameCaptureSettings`	`withMaxCaptures(Integer maxCaptures)` Maximum number of captures (encoded jpg output files).
`FrameCaptureSettings`	`withQuality(Integer quality)` JPEG Quality - a higher value equals higher quality.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FrameCaptureSettings
```
public FrameCaptureSettings()
```
- Method Detail
  - setFramerateDenominator
```
public void setFramerateDenominator(Integer framerateDenominator)
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
    
    Parameters:
    
    framerateDenominator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
  - getFramerateDenominator
```
public Integer getFramerateDenominator()
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
    
    Returns:
    
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
  - withFramerateDenominator
```
public FrameCaptureSettings withFramerateDenominator(Integer framerateDenominator)
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
    
    Parameters:
    
    framerateDenominator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFramerateNumerator
```
public void setFramerateNumerator(Integer framerateNumerator)
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
    
    Parameters:
    
    framerateNumerator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
  - getFramerateNumerator
```
public Integer getFramerateNumerator()
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
    
    Returns:
    
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
  - withFramerateNumerator
```
public FrameCaptureSettings withFramerateNumerator(Integer framerateNumerator)
```
    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
    
    Parameters:
    
    framerateNumerator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxCaptures
```
public void setMaxCaptures(Integer maxCaptures)
```
    Maximum number of captures (encoded jpg output files).
    
    Parameters:
    
    maxCaptures - Maximum number of captures (encoded jpg output files).
  - getMaxCaptures
```
public Integer getMaxCaptures()
```
    Maximum number of captures (encoded jpg output files).
    
    Returns:
    
    Maximum number of captures (encoded jpg output files).
  - withMaxCaptures
```
public FrameCaptureSettings withMaxCaptures(Integer maxCaptures)
```
    Maximum number of captures (encoded jpg output files).
    
    Parameters:
    
    maxCaptures - Maximum number of captures (encoded jpg output files).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuality
```
public void setQuality(Integer quality)
```
    JPEG Quality - a higher value equals higher quality.
    
    Parameters:
    
    quality - JPEG Quality - a higher value equals higher quality.
  - getQuality
```
public Integer getQuality()
```
    JPEG Quality - a higher value equals higher quality.
    
    Returns:
    
    JPEG Quality - a higher value equals higher quality.
  - withQuality
```
public FrameCaptureSettings withQuality(Integer quality)
```
    JPEG Quality - a higher value equals higher quality.
    
    Parameters:
    
    quality - JPEG Quality - a higher value equals higher quality.
    
    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; useful for testing and debugging.
    
    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 FrameCaptureSettings 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.

Did this page help you?

Class FrameCaptureSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrameCaptureSettings

Method Detail

setFramerateDenominator

getFramerateDenominator

withFramerateDenominator

setFramerateNumerator

getFramerateNumerator

withFramerateNumerator

setMaxCaptures

getMaxCaptures

withMaxCaptures

setQuality

getQuality

withQuality

toString

equals

hashCode

clone

marshall