AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::VideoDescription Class Reference

#include <VideoDescription.h>

Public Member Functions

 VideoDescription ()
 
 VideoDescription (Aws::Utils::Json::JsonView jsonValue)
 
VideoDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AfdSignalingGetAfdSignaling () const
 
bool AfdSignalingHasBeenSet () const
 
void SetAfdSignaling (const AfdSignaling &value)
 
void SetAfdSignaling (AfdSignaling &&value)
 
VideoDescriptionWithAfdSignaling (const AfdSignaling &value)
 
VideoDescriptionWithAfdSignaling (AfdSignaling &&value)
 
const AntiAliasGetAntiAlias () const
 
bool AntiAliasHasBeenSet () const
 
void SetAntiAlias (const AntiAlias &value)
 
void SetAntiAlias (AntiAlias &&value)
 
VideoDescriptionWithAntiAlias (const AntiAlias &value)
 
VideoDescriptionWithAntiAlias (AntiAlias &&value)
 
const VideoCodecSettingsGetCodecSettings () const
 
bool CodecSettingsHasBeenSet () const
 
void SetCodecSettings (const VideoCodecSettings &value)
 
void SetCodecSettings (VideoCodecSettings &&value)
 
VideoDescriptionWithCodecSettings (const VideoCodecSettings &value)
 
VideoDescriptionWithCodecSettings (VideoCodecSettings &&value)
 
const ColorMetadataGetColorMetadata () const
 
bool ColorMetadataHasBeenSet () const
 
void SetColorMetadata (const ColorMetadata &value)
 
void SetColorMetadata (ColorMetadata &&value)
 
VideoDescriptionWithColorMetadata (const ColorMetadata &value)
 
VideoDescriptionWithColorMetadata (ColorMetadata &&value)
 
const RectangleGetCrop () const
 
bool CropHasBeenSet () const
 
void SetCrop (const Rectangle &value)
 
void SetCrop (Rectangle &&value)
 
VideoDescriptionWithCrop (const Rectangle &value)
 
VideoDescriptionWithCrop (Rectangle &&value)
 
const DropFrameTimecodeGetDropFrameTimecode () const
 
bool DropFrameTimecodeHasBeenSet () const
 
void SetDropFrameTimecode (const DropFrameTimecode &value)
 
void SetDropFrameTimecode (DropFrameTimecode &&value)
 
VideoDescriptionWithDropFrameTimecode (const DropFrameTimecode &value)
 
VideoDescriptionWithDropFrameTimecode (DropFrameTimecode &&value)
 
int GetFixedAfd () const
 
bool FixedAfdHasBeenSet () const
 
void SetFixedAfd (int value)
 
VideoDescriptionWithFixedAfd (int value)
 
int GetHeight () const
 
bool HeightHasBeenSet () const
 
void SetHeight (int value)
 
VideoDescriptionWithHeight (int value)
 
const RectangleGetPosition () const
 
bool PositionHasBeenSet () const
 
void SetPosition (const Rectangle &value)
 
void SetPosition (Rectangle &&value)
 
VideoDescriptionWithPosition (const Rectangle &value)
 
VideoDescriptionWithPosition (Rectangle &&value)
 
const RespondToAfdGetRespondToAfd () const
 
bool RespondToAfdHasBeenSet () const
 
void SetRespondToAfd (const RespondToAfd &value)
 
void SetRespondToAfd (RespondToAfd &&value)
 
VideoDescriptionWithRespondToAfd (const RespondToAfd &value)
 
VideoDescriptionWithRespondToAfd (RespondToAfd &&value)
 
const ScalingBehaviorGetScalingBehavior () const
 
bool ScalingBehaviorHasBeenSet () const
 
void SetScalingBehavior (const ScalingBehavior &value)
 
void SetScalingBehavior (ScalingBehavior &&value)
 
VideoDescriptionWithScalingBehavior (const ScalingBehavior &value)
 
VideoDescriptionWithScalingBehavior (ScalingBehavior &&value)
 
int GetSharpness () const
 
bool SharpnessHasBeenSet () const
 
void SetSharpness (int value)
 
VideoDescriptionWithSharpness (int value)
 
const VideoTimecodeInsertionGetTimecodeInsertion () const
 
bool TimecodeInsertionHasBeenSet () const
 
void SetTimecodeInsertion (const VideoTimecodeInsertion &value)
 
void SetTimecodeInsertion (VideoTimecodeInsertion &&value)
 
VideoDescriptionWithTimecodeInsertion (const VideoTimecodeInsertion &value)
 
VideoDescriptionWithTimecodeInsertion (VideoTimecodeInsertion &&value)
 
const VideoPreprocessorGetVideoPreprocessors () const
 
bool VideoPreprocessorsHasBeenSet () const
 
void SetVideoPreprocessors (const VideoPreprocessor &value)
 
void SetVideoPreprocessors (VideoPreprocessor &&value)
 
VideoDescriptionWithVideoPreprocessors (const VideoPreprocessor &value)
 
VideoDescriptionWithVideoPreprocessors (VideoPreprocessor &&value)
 
int GetWidth () const
 
bool WidthHasBeenSet () const
 
void SetWidth (int value)
 
VideoDescriptionWithWidth (int value)
 

Detailed Description

Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose. When you work directly in your JSON job specification, include one instance of Video description (VideoDescription) per output.

See Also:

AWS API Reference

Definition at line 43 of file VideoDescription.h.

Constructor & Destructor Documentation

◆ VideoDescription() [1/2]

Aws::MediaConvert::Model::VideoDescription::VideoDescription ( )

◆ VideoDescription() [2/2]

Aws::MediaConvert::Model::VideoDescription::VideoDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AfdSignalingHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::AfdSignalingHasBeenSet ( ) const
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 70 of file VideoDescription.h.

◆ AntiAliasHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::AntiAliasHasBeenSet ( ) const
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 125 of file VideoDescription.h.

◆ CodecSettingsHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::CodecSettingsHasBeenSet ( ) const
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 178 of file VideoDescription.h.

◆ ColorMetadataHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::ColorMetadataHasBeenSet ( ) const
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 241 of file VideoDescription.h.

◆ CropHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::CropHasBeenSet ( ) const
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 282 of file VideoDescription.h.

◆ DropFrameTimecodeHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::DropFrameTimecodeHasBeenSet ( ) const
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 323 of file VideoDescription.h.

◆ FixedAfdHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::FixedAfdHasBeenSet ( ) const
inline

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

Definition at line 370 of file VideoDescription.h.

◆ GetAfdSignaling()

const AfdSignaling& Aws::MediaConvert::Model::VideoDescription::GetAfdSignaling ( ) const
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 60 of file VideoDescription.h.

◆ GetAntiAlias()

const AntiAlias& Aws::MediaConvert::Model::VideoDescription::GetAntiAlias ( ) const
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 118 of file VideoDescription.h.

◆ GetCodecSettings()

const VideoCodecSettings& Aws::MediaConvert::Model::VideoDescription::GetCodecSettings ( ) const
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 166 of file VideoDescription.h.

◆ GetColorMetadata()

const ColorMetadata& Aws::MediaConvert::Model::VideoDescription::GetColorMetadata ( ) const
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 234 of file VideoDescription.h.

◆ GetCrop()

const Rectangle& Aws::MediaConvert::Model::VideoDescription::GetCrop ( ) const
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 276 of file VideoDescription.h.

◆ GetDropFrameTimecode()

const DropFrameTimecode& Aws::MediaConvert::Model::VideoDescription::GetDropFrameTimecode ( ) const
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 315 of file VideoDescription.h.

◆ GetFixedAfd()

int Aws::MediaConvert::Model::VideoDescription::GetFixedAfd ( ) const
inline

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

Definition at line 363 of file VideoDescription.h.

◆ GetHeight()

int Aws::MediaConvert::Model::VideoDescription::GetHeight ( ) const
inline

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

Definition at line 392 of file VideoDescription.h.

◆ GetPosition()

const Rectangle& Aws::MediaConvert::Model::VideoDescription::GetPosition ( ) const
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 420 of file VideoDescription.h.

◆ GetRespondToAfd()

const RespondToAfd& Aws::MediaConvert::Model::VideoDescription::GetRespondToAfd ( ) const
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 463 of file VideoDescription.h.

◆ GetScalingBehavior()

const ScalingBehavior& Aws::MediaConvert::Model::VideoDescription::GetScalingBehavior ( ) const
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 533 of file VideoDescription.h.

◆ GetSharpness()

int Aws::MediaConvert::Model::VideoDescription::GetSharpness ( ) const
inline

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

Definition at line 588 of file VideoDescription.h.

◆ GetTimecodeInsertion()

const VideoTimecodeInsertion& Aws::MediaConvert::Model::VideoDescription::GetTimecodeInsertion ( ) const
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 633 of file VideoDescription.h.

◆ GetVideoPreprocessors()

const VideoPreprocessor& Aws::MediaConvert::Model::VideoDescription::GetVideoPreprocessors ( ) const
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 726 of file VideoDescription.h.

◆ GetWidth()

int Aws::MediaConvert::Model::VideoDescription::GetWidth ( ) const
inline

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

Definition at line 768 of file VideoDescription.h.

◆ HeightHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::HeightHasBeenSet ( ) const
inline

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

Definition at line 399 of file VideoDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::VideoDescription::Jsonize ( ) const

◆ operator=()

VideoDescription& Aws::MediaConvert::Model::VideoDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PositionHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::PositionHasBeenSet ( ) const
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 426 of file VideoDescription.h.

◆ RespondToAfdHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::RespondToAfdHasBeenSet ( ) const
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 475 of file VideoDescription.h.

◆ ScalingBehaviorHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::ScalingBehaviorHasBeenSet ( ) const
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 542 of file VideoDescription.h.

◆ SetAfdSignaling() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetAfdSignaling ( AfdSignaling &&  value)
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 90 of file VideoDescription.h.

◆ SetAfdSignaling() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetAfdSignaling ( const AfdSignaling value)
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 80 of file VideoDescription.h.

◆ SetAntiAlias() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetAntiAlias ( AntiAlias &&  value)
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 139 of file VideoDescription.h.

◆ SetAntiAlias() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetAntiAlias ( const AntiAlias value)
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 132 of file VideoDescription.h.

◆ SetCodecSettings() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetCodecSettings ( const VideoCodecSettings value)
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 190 of file VideoDescription.h.

◆ SetCodecSettings() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetCodecSettings ( VideoCodecSettings &&  value)
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 202 of file VideoDescription.h.

◆ SetColorMetadata() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetColorMetadata ( ColorMetadata &&  value)
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 255 of file VideoDescription.h.

◆ SetColorMetadata() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetColorMetadata ( const ColorMetadata value)
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 248 of file VideoDescription.h.

◆ SetCrop() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetCrop ( const Rectangle value)
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 288 of file VideoDescription.h.

◆ SetCrop() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetCrop ( Rectangle &&  value)
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 294 of file VideoDescription.h.

◆ SetDropFrameTimecode() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetDropFrameTimecode ( const DropFrameTimecode value)
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 331 of file VideoDescription.h.

◆ SetDropFrameTimecode() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetDropFrameTimecode ( DropFrameTimecode &&  value)
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 339 of file VideoDescription.h.

◆ SetFixedAfd()

void Aws::MediaConvert::Model::VideoDescription::SetFixedAfd ( int  value)
inline

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

Definition at line 377 of file VideoDescription.h.

◆ SetHeight()

void Aws::MediaConvert::Model::VideoDescription::SetHeight ( int  value)
inline

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

Definition at line 406 of file VideoDescription.h.

◆ SetPosition() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetPosition ( const Rectangle value)
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 432 of file VideoDescription.h.

◆ SetPosition() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetPosition ( Rectangle &&  value)
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 438 of file VideoDescription.h.

◆ SetRespondToAfd() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetRespondToAfd ( const RespondToAfd value)
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 487 of file VideoDescription.h.

◆ SetRespondToAfd() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetRespondToAfd ( RespondToAfd &&  value)
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 499 of file VideoDescription.h.

◆ SetScalingBehavior() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetScalingBehavior ( const ScalingBehavior value)
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 551 of file VideoDescription.h.

◆ SetScalingBehavior() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetScalingBehavior ( ScalingBehavior &&  value)
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 560 of file VideoDescription.h.

◆ SetSharpness()

void Aws::MediaConvert::Model::VideoDescription::SetSharpness ( int  value)
inline

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

Definition at line 606 of file VideoDescription.h.

◆ SetTimecodeInsertion() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetTimecodeInsertion ( const VideoTimecodeInsertion value)
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 667 of file VideoDescription.h.

◆ SetTimecodeInsertion() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetTimecodeInsertion ( VideoTimecodeInsertion &&  value)
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 684 of file VideoDescription.h.

◆ SetVideoPreprocessors() [1/2]

void Aws::MediaConvert::Model::VideoDescription::SetVideoPreprocessors ( const VideoPreprocessor value)
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 740 of file VideoDescription.h.

◆ SetVideoPreprocessors() [2/2]

void Aws::MediaConvert::Model::VideoDescription::SetVideoPreprocessors ( VideoPreprocessor &&  value)
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 747 of file VideoDescription.h.

◆ SetWidth()

void Aws::MediaConvert::Model::VideoDescription::SetWidth ( int  value)
inline

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

Definition at line 780 of file VideoDescription.h.

◆ SharpnessHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::SharpnessHasBeenSet ( ) const
inline

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

Definition at line 597 of file VideoDescription.h.

◆ TimecodeInsertionHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::TimecodeInsertionHasBeenSet ( ) const
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 650 of file VideoDescription.h.

◆ VideoPreprocessorsHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::VideoPreprocessorsHasBeenSet ( ) const
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 733 of file VideoDescription.h.

◆ WidthHasBeenSet()

bool Aws::MediaConvert::Model::VideoDescription::WidthHasBeenSet ( ) const
inline

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

Definition at line 774 of file VideoDescription.h.

◆ WithAfdSignaling() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithAfdSignaling ( AfdSignaling &&  value)
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 110 of file VideoDescription.h.

◆ WithAfdSignaling() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithAfdSignaling ( const AfdSignaling value)
inline

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

Definition at line 100 of file VideoDescription.h.

◆ WithAntiAlias() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithAntiAlias ( AntiAlias &&  value)
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 153 of file VideoDescription.h.

◆ WithAntiAlias() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithAntiAlias ( const AntiAlias value)
inline

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

Definition at line 146 of file VideoDescription.h.

◆ WithCodecSettings() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithCodecSettings ( const VideoCodecSettings value)
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 214 of file VideoDescription.h.

◆ WithCodecSettings() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithCodecSettings ( VideoCodecSettings &&  value)
inline

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

Definition at line 226 of file VideoDescription.h.

◆ WithColorMetadata() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithColorMetadata ( ColorMetadata &&  value)
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 269 of file VideoDescription.h.

◆ WithColorMetadata() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithColorMetadata ( const ColorMetadata value)
inline

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

Definition at line 262 of file VideoDescription.h.

◆ WithCrop() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithCrop ( const Rectangle value)
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 300 of file VideoDescription.h.

◆ WithCrop() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithCrop ( Rectangle &&  value)
inline

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

Definition at line 306 of file VideoDescription.h.

◆ WithDropFrameTimecode() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithDropFrameTimecode ( const DropFrameTimecode value)
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 347 of file VideoDescription.h.

◆ WithDropFrameTimecode() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithDropFrameTimecode ( DropFrameTimecode &&  value)
inline

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

Definition at line 355 of file VideoDescription.h.

◆ WithFixedAfd()

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithFixedAfd ( int  value)
inline

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

Definition at line 384 of file VideoDescription.h.

◆ WithHeight()

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithHeight ( int  value)
inline

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

Definition at line 413 of file VideoDescription.h.

◆ WithPosition() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithPosition ( const Rectangle value)
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 444 of file VideoDescription.h.

◆ WithPosition() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithPosition ( Rectangle &&  value)
inline

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

Definition at line 450 of file VideoDescription.h.

◆ WithRespondToAfd() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithRespondToAfd ( const RespondToAfd value)
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 511 of file VideoDescription.h.

◆ WithRespondToAfd() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithRespondToAfd ( RespondToAfd &&  value)
inline

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

Definition at line 523 of file VideoDescription.h.

◆ WithScalingBehavior() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithScalingBehavior ( const ScalingBehavior value)
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 569 of file VideoDescription.h.

◆ WithScalingBehavior() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithScalingBehavior ( ScalingBehavior &&  value)
inline

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

Definition at line 578 of file VideoDescription.h.

◆ WithSharpness()

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithSharpness ( int  value)
inline

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

Definition at line 615 of file VideoDescription.h.

◆ WithTimecodeInsertion() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithTimecodeInsertion ( const VideoTimecodeInsertion value)
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 701 of file VideoDescription.h.

◆ WithTimecodeInsertion() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithTimecodeInsertion ( VideoTimecodeInsertion &&  value)
inline

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

Definition at line 718 of file VideoDescription.h.

◆ WithVideoPreprocessors() [1/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithVideoPreprocessors ( const VideoPreprocessor value)
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 754 of file VideoDescription.h.

◆ WithVideoPreprocessors() [2/2]

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithVideoPreprocessors ( VideoPreprocessor &&  value)
inline

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Definition at line 761 of file VideoDescription.h.

◆ WithWidth()

VideoDescription& Aws::MediaConvert::Model::VideoDescription::WithWidth ( int  value)
inline

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

Definition at line 786 of file VideoDescription.h.


The documentation for this class was generated from the following file: