Struct aws_sdk_ivs::types::builders::ThumbnailConfigurationBuilder

#[non_exhaustive]
pub struct ThumbnailConfigurationBuilder { /* private fields */ }

A builder for ThumbnailConfiguration.

Implementations

impl ThumbnailConfigurationBuilder

pub fn recording_mode(self, input: RecordingMode) -> Self

Thumbnail recording mode. Default: INTERVAL.

pub fn set_recording_mode(self, input: Option<RecordingMode>) -> Self

Thumbnail recording mode. Default: INTERVAL.

pub fn get_recording_mode(&self) -> &Option<RecordingMode>

Thumbnail recording mode. Default: INTERVAL.

pub fn target_interval_seconds(self, input: i64) -> Self

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.

pub fn set_target_interval_seconds(self, input: Option<i64>) -> Self

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.

pub fn get_target_interval_seconds(&self) -> &Option<i64>

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.

pub fn resolution(self, input: ThumbnailConfigurationResolution) -> Self

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

pub fn set_resolution( self, input: Option<ThumbnailConfigurationResolution> ) -> Self

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

pub fn get_resolution(&self) -> &Option<ThumbnailConfigurationResolution>

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

pub fn storage(self, input: ThumbnailConfigurationStorage) -> Self

Appends an item to storage.

To override the contents of this collection use set_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.

pub fn set_storage( self, input: Option<Vec<ThumbnailConfigurationStorage>> ) -> Self

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.

pub fn get_storage(&self) -> &Option<Vec<ThumbnailConfigurationStorage>>

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.

pub fn build(self) -> ThumbnailConfiguration

Consumes the builder and constructs a ThumbnailConfiguration.

Trait Implementations

impl Clone for ThumbnailConfigurationBuilder

fn clone(&self) -> ThumbnailConfigurationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThumbnailConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThumbnailConfigurationBuilder

fn default() -> ThumbnailConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for ThumbnailConfigurationBuilder

fn eq(&self, other: &ThumbnailConfigurationBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ThumbnailConfigurationBuilder