Struct aws_sdk_ivs::types::ThumbnailConfiguration

#[non_exhaustive]
pub struct ThumbnailConfiguration {
    pub recording_mode: Option<RecordingMode>,
    pub target_interval_seconds: Option<i64>,
    pub resolution: Option<ThumbnailConfigurationResolution>,
    pub storage: Option<Vec<ThumbnailConfigurationStorage>>,
}

An object representing a configuration of thumbnails for recorded video.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

recording_mode: Option<RecordingMode>

Thumbnail recording mode. Default: INTERVAL.

target_interval_seconds: 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.

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

storage: 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.

Implementations

impl ThumbnailConfiguration

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

Thumbnail recording mode. Default: INTERVAL.

pub fn 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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .storage.is_none().

impl ThumbnailConfiguration

pub fn builder() -> ThumbnailConfigurationBuilder

Creates a new builder-style object to manufacture ThumbnailConfiguration.

Trait Implementations

impl Clone for ThumbnailConfiguration

fn clone(&self) -> ThumbnailConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThumbnailConfiguration

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

Formats the value using the given formatter.

impl PartialEq for ThumbnailConfiguration

fn eq(&self, other: &ThumbnailConfiguration) -> 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 ThumbnailConfiguration