Package software.amazon.awssdk.services.ivs.model

Interface ThumbnailConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ThumbnailConfiguration.Builder,ThumbnailConfiguration>, SdkBuilder<ThumbnailConfiguration.Builder,ThumbnailConfiguration>, SdkPojo
Enclosing class:
ThumbnailConfiguration
public static interface ThumbnailConfiguration.Builder extends SdkPojo, CopyableBuilder<ThumbnailConfiguration.Builder,ThumbnailConfiguration>

  • Method Details

    • recordingMode

      ThumbnailConfiguration.Builder recordingMode(String recordingMode)

      Thumbnail recording mode. Default: INTERVAL.

      Parameters:
      recordingMode - Thumbnail recording mode. Default: INTERVAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recordingMode

      ThumbnailConfiguration.Builder recordingMode(RecordingMode recordingMode)

      Thumbnail recording mode. Default: INTERVAL.

      Parameters:
      recordingMode - Thumbnail recording mode. Default: INTERVAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resolution

      ThumbnailConfiguration.Builder resolution(String resolution)

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

      Parameters:
      resolution - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resolution

      ThumbnailConfiguration.Builder resolution(ThumbnailConfigurationResolution resolution)

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

      Parameters:
      resolution - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageWithStrings

      ThumbnailConfiguration.Builder storageWithStrings(Collection<String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageWithStrings

      ThumbnailConfiguration.Builder storageWithStrings(String... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storage

      ThumbnailConfiguration.Builder storage(Collection<ThumbnailConfigurationStorage> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storage

      ThumbnailConfiguration.Builder storage(ThumbnailConfigurationStorage... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetIntervalSeconds

      ThumbnailConfiguration.Builder targetIntervalSeconds(Long targetIntervalSeconds)

      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.

      Parameters:
      targetIntervalSeconds - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.