Interface SegmentDetection.Builder

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

  • Method Details

    • type

      SegmentDetection.Builder type(String type)

      The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      type - The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      SegmentDetection.Builder type(SegmentType type)

      The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      type - The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTimestampMillis

      SegmentDetection.Builder startTimestampMillis(Long startTimestampMillis)

      The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.

      Parameters:
      startTimestampMillis - The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimestampMillis

      SegmentDetection.Builder endTimestampMillis(Long endTimestampMillis)

      The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

      Parameters:
      endTimestampMillis - The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • durationMillis

      SegmentDetection.Builder durationMillis(Long durationMillis)

      The duration of the detected segment in milliseconds.

      Parameters:
      durationMillis - The duration of the detected segment in milliseconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimecodeSMPTE

      SegmentDetection.Builder startTimecodeSMPTE(String startTimecodeSMPTE)

      The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

      Parameters:
      startTimecodeSMPTE - The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimecodeSMPTE

      SegmentDetection.Builder endTimecodeSMPTE(String endTimecodeSMPTE)

      The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

      Parameters:
      endTimecodeSMPTE - The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • durationSMPTE

      SegmentDetection.Builder durationSMPTE(String durationSMPTE)

      The duration of the timecode for the detected segment in SMPTE format.

      Parameters:
      durationSMPTE - The duration of the timecode for the detected segment in SMPTE format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • technicalCueSegment

      SegmentDetection.Builder technicalCueSegment(TechnicalCueSegment technicalCueSegment)

      If the segment is a technical cue, contains information about the technical cue.

      Parameters:
      technicalCueSegment - If the segment is a technical cue, contains information about the technical cue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • technicalCueSegment

      default SegmentDetection.Builder technicalCueSegment(Consumer<TechnicalCueSegment.Builder> technicalCueSegment)

      If the segment is a technical cue, contains information about the technical cue.

      This is a convenience method that creates an instance of the TechnicalCueSegment.Builder avoiding the need to create one manually via TechnicalCueSegment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to technicalCueSegment(TechnicalCueSegment).

      Parameters:
      technicalCueSegment - a consumer that will call methods on TechnicalCueSegment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shotSegment

      SegmentDetection.Builder shotSegment(ShotSegment shotSegment)

      If the segment is a shot detection, contains information about the shot detection.

      Parameters:
      shotSegment - If the segment is a shot detection, contains information about the shot detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shotSegment

      default SegmentDetection.Builder shotSegment(Consumer<ShotSegment.Builder> shotSegment)

      If the segment is a shot detection, contains information about the shot detection.

      This is a convenience method that creates an instance of the ShotSegment.Builder avoiding the need to create one manually via ShotSegment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shotSegment(ShotSegment).

      Parameters:
      shotSegment - a consumer that will call methods on ShotSegment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startFrameNumber

      SegmentDetection.Builder startFrameNumber(Long startFrameNumber)

      The frame number of the start of a video segment, using a frame index that starts with 0.

      Parameters:
      startFrameNumber - The frame number of the start of a video segment, using a frame index that starts with 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endFrameNumber

      SegmentDetection.Builder endFrameNumber(Long endFrameNumber)

      The frame number at the end of a video segment, using a frame index that starts with 0.

      Parameters:
      endFrameNumber - The frame number at the end of a video segment, using a frame index that starts with 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • durationFrames

      SegmentDetection.Builder durationFrames(Long durationFrames)

      The duration of a video segment, expressed in frames.

      Parameters:
      durationFrames - The duration of a video segment, expressed in frames.
      Returns:
      Returns a reference to this object so that method calls can be chained together.