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

#include <InsertableImage.h>

Public Member Functions

 InsertableImage ()
 
 InsertableImage (Aws::Utils::Json::JsonView jsonValue)
 
InsertableImageoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (int value)
 
InsertableImageWithDuration (int value)
 
int GetFadeIn () const
 
bool FadeInHasBeenSet () const
 
void SetFadeIn (int value)
 
InsertableImageWithFadeIn (int value)
 
int GetFadeOut () const
 
bool FadeOutHasBeenSet () const
 
void SetFadeOut (int value)
 
InsertableImageWithFadeOut (int value)
 
int GetHeight () const
 
bool HeightHasBeenSet () const
 
void SetHeight (int value)
 
InsertableImageWithHeight (int value)
 
const Aws::StringGetImageInserterInput () const
 
bool ImageInserterInputHasBeenSet () const
 
void SetImageInserterInput (const Aws::String &value)
 
void SetImageInserterInput (Aws::String &&value)
 
void SetImageInserterInput (const char *value)
 
InsertableImageWithImageInserterInput (const Aws::String &value)
 
InsertableImageWithImageInserterInput (Aws::String &&value)
 
InsertableImageWithImageInserterInput (const char *value)
 
int GetImageX () const
 
bool ImageXHasBeenSet () const
 
void SetImageX (int value)
 
InsertableImageWithImageX (int value)
 
int GetImageY () const
 
bool ImageYHasBeenSet () const
 
void SetImageY (int value)
 
InsertableImageWithImageY (int value)
 
int GetLayer () const
 
bool LayerHasBeenSet () const
 
void SetLayer (int value)
 
InsertableImageWithLayer (int value)
 
int GetOpacity () const
 
bool OpacityHasBeenSet () const
 
void SetOpacity (int value)
 
InsertableImageWithOpacity (int value)
 
const Aws::StringGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::String &value)
 
void SetStartTime (Aws::String &&value)
 
void SetStartTime (const char *value)
 
InsertableImageWithStartTime (const Aws::String &value)
 
InsertableImageWithStartTime (Aws::String &&value)
 
InsertableImageWithStartTime (const char *value)
 
int GetWidth () const
 
bool WidthHasBeenSet () const
 
void SetWidth (int value)
 
InsertableImageWithWidth (int value)
 

Detailed Description

These settings apply to a specific graphic overlay. You can include multiple overlays in your job.

See Also:

AWS API Reference

Definition at line 32 of file InsertableImage.h.

Constructor & Destructor Documentation

◆ InsertableImage() [1/2]

Aws::MediaConvert::Model::InsertableImage::InsertableImage ( )

◆ InsertableImage() [2/2]

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

Member Function Documentation

◆ DurationHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::DurationHasBeenSet ( ) const
inline

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Definition at line 51 of file InsertableImage.h.

◆ FadeInHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::FadeInHasBeenSet ( ) const
inline

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Definition at line 82 of file InsertableImage.h.

◆ FadeOutHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::FadeOutHasBeenSet ( ) const
inline

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

Definition at line 117 of file InsertableImage.h.

◆ GetDuration()

int Aws::MediaConvert::Model::InsertableImage::GetDuration ( ) const
inline

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Definition at line 45 of file InsertableImage.h.

◆ GetFadeIn()

int Aws::MediaConvert::Model::InsertableImage::GetFadeIn ( ) const
inline

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Definition at line 73 of file InsertableImage.h.

◆ GetFadeOut()

int Aws::MediaConvert::Model::InsertableImage::GetFadeOut ( ) const
inline

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

Definition at line 109 of file InsertableImage.h.

◆ GetHeight()

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

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Definition at line 142 of file InsertableImage.h.

◆ GetImageInserterInput()

const Aws::String& Aws::MediaConvert::Model::InsertableImage::GetImageInserterInput ( ) const
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 173 of file InsertableImage.h.

◆ GetImageX()

int Aws::MediaConvert::Model::InsertableImage::GetImageX ( ) const
inline

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Definition at line 222 of file InsertableImage.h.

◆ GetImageY()

int Aws::MediaConvert::Model::InsertableImage::GetImageY ( ) const
inline

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Definition at line 247 of file InsertableImage.h.

◆ GetLayer()

int Aws::MediaConvert::Model::InsertableImage::GetLayer ( ) const
inline

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Definition at line 272 of file InsertableImage.h.

◆ GetOpacity()

int Aws::MediaConvert::Model::InsertableImage::GetOpacity ( ) const
inline

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Definition at line 297 of file InsertableImage.h.

◆ GetStartTime()

const Aws::String& Aws::MediaConvert::Model::InsertableImage::GetStartTime ( ) const
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 323 of file InsertableImage.h.

◆ GetWidth()

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

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Definition at line 380 of file InsertableImage.h.

◆ HeightHasBeenSet()

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

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Definition at line 150 of file InsertableImage.h.

◆ ImageInserterInputHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::ImageInserterInputHasBeenSet ( ) const
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 179 of file InsertableImage.h.

◆ ImageXHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::ImageXHasBeenSet ( ) const
inline

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Definition at line 228 of file InsertableImage.h.

◆ ImageYHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::ImageYHasBeenSet ( ) const
inline

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Definition at line 253 of file InsertableImage.h.

◆ Jsonize()

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

◆ LayerHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::LayerHasBeenSet ( ) const
inline

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Definition at line 278 of file InsertableImage.h.

◆ OpacityHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::OpacityHasBeenSet ( ) const
inline

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Definition at line 303 of file InsertableImage.h.

◆ operator=()

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

◆ SetDuration()

void Aws::MediaConvert::Model::InsertableImage::SetDuration ( int  value)
inline

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Definition at line 57 of file InsertableImage.h.

◆ SetFadeIn()

void Aws::MediaConvert::Model::InsertableImage::SetFadeIn ( int  value)
inline

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Definition at line 91 of file InsertableImage.h.

◆ SetFadeOut()

void Aws::MediaConvert::Model::InsertableImage::SetFadeOut ( int  value)
inline

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

Definition at line 125 of file InsertableImage.h.

◆ SetHeight()

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

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Definition at line 158 of file InsertableImage.h.

◆ SetImageInserterInput() [1/3]

void Aws::MediaConvert::Model::InsertableImage::SetImageInserterInput ( Aws::String &&  value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 191 of file InsertableImage.h.

◆ SetImageInserterInput() [2/3]

void Aws::MediaConvert::Model::InsertableImage::SetImageInserterInput ( const Aws::String value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 185 of file InsertableImage.h.

◆ SetImageInserterInput() [3/3]

void Aws::MediaConvert::Model::InsertableImage::SetImageInserterInput ( const char *  value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 197 of file InsertableImage.h.

◆ SetImageX()

void Aws::MediaConvert::Model::InsertableImage::SetImageX ( int  value)
inline

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Definition at line 234 of file InsertableImage.h.

◆ SetImageY()

void Aws::MediaConvert::Model::InsertableImage::SetImageY ( int  value)
inline

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Definition at line 259 of file InsertableImage.h.

◆ SetLayer()

void Aws::MediaConvert::Model::InsertableImage::SetLayer ( int  value)
inline

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Definition at line 284 of file InsertableImage.h.

◆ SetOpacity()

void Aws::MediaConvert::Model::InsertableImage::SetOpacity ( int  value)
inline

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Definition at line 309 of file InsertableImage.h.

◆ SetStartTime() [1/3]

void Aws::MediaConvert::Model::InsertableImage::SetStartTime ( Aws::String &&  value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 344 of file InsertableImage.h.

◆ SetStartTime() [2/3]

void Aws::MediaConvert::Model::InsertableImage::SetStartTime ( const Aws::String value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 337 of file InsertableImage.h.

◆ SetStartTime() [3/3]

void Aws::MediaConvert::Model::InsertableImage::SetStartTime ( const char *  value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 351 of file InsertableImage.h.

◆ SetWidth()

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

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Definition at line 394 of file InsertableImage.h.

◆ StartTimeHasBeenSet()

bool Aws::MediaConvert::Model::InsertableImage::StartTimeHasBeenSet ( ) const
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 330 of file InsertableImage.h.

◆ WidthHasBeenSet()

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

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Definition at line 387 of file InsertableImage.h.

◆ WithDuration()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithDuration ( int  value)
inline

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Definition at line 63 of file InsertableImage.h.

◆ WithFadeIn()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithFadeIn ( int  value)
inline

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Definition at line 100 of file InsertableImage.h.

◆ WithFadeOut()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithFadeOut ( int  value)
inline

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

Definition at line 133 of file InsertableImage.h.

◆ WithHeight()

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

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Definition at line 166 of file InsertableImage.h.

◆ WithImageInserterInput() [1/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithImageInserterInput ( Aws::String &&  value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 209 of file InsertableImage.h.

◆ WithImageInserterInput() [2/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithImageInserterInput ( const Aws::String value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 203 of file InsertableImage.h.

◆ WithImageInserterInput() [3/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithImageInserterInput ( const char *  value)
inline

Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Definition at line 215 of file InsertableImage.h.

◆ WithImageX()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithImageX ( int  value)
inline

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Definition at line 240 of file InsertableImage.h.

◆ WithImageY()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithImageY ( int  value)
inline

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Definition at line 265 of file InsertableImage.h.

◆ WithLayer()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithLayer ( int  value)
inline

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Definition at line 290 of file InsertableImage.h.

◆ WithOpacity()

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithOpacity ( int  value)
inline

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Definition at line 315 of file InsertableImage.h.

◆ WithStartTime() [1/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithStartTime ( Aws::String &&  value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 365 of file InsertableImage.h.

◆ WithStartTime() [2/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithStartTime ( const Aws::String value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 358 of file InsertableImage.h.

◆ WithStartTime() [3/3]

InsertableImage& Aws::MediaConvert::Model::InsertableImage::WithStartTime ( const char *  value)
inline

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Definition at line 372 of file InsertableImage.h.

◆ WithWidth()

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

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Definition at line 401 of file InsertableImage.h.


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