SegmentDetection (AWS Java SDK :: Services :: Amazon Rekognition 2.15.75 API)

java.lang.Object
- software.amazon.awssdk.services.rekognition.model.SegmentDetection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SegmentDetection.Builder,SegmentDetection>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SegmentDetection
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SegmentDetection.Builder,SegmentDetection>
```
A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SegmentDetection.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SegmentDetection.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SegmentDetection.Builder`	`builder()`
`Long`	`durationMillis()` The duration of the detected segment in milliseconds.
`String`	`durationSMPTE()` The duration of the timecode for the detected segment in SMPTE format.
`String`	`endTimecodeSMPTE()` The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment.
`Long`	`endTimestampMillis()` The end time of the detected segment, in milliseconds, from the start of the video.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SegmentDetection.Builder>`	`serializableBuilderClass()`
`ShotSegment`	`shotSegment()` If the segment is a shot detection, contains information about the shot detection.
`String`	`startTimecodeSMPTE()` The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.
`Long`	`startTimestampMillis()` The start time of the detected segment in milliseconds from the start of the video.
`TechnicalCueSegment`	`technicalCueSegment()` If the segment is a technical cue, contains information about the technical cue.
`SegmentDetection.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`SegmentType`	`type()` The type of the segment.
`String`	`typeAsString()` The type of the segment.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - type
```
public final SegmentType type()
```
    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SegmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
    
    See Also:
    
    SegmentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SegmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
    
    See Also:
    
    SegmentType
  - startTimestampMillis
```
public final 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.
    
    Returns:
    
    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.
  - endTimestampMillis
```
public final Long endTimestampMillis()
```
    The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
    
    Returns:
    
    The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
  - durationMillis
```
public final Long durationMillis()
```
    The duration of the detected segment in milliseconds.
    
    Returns:
    
    The duration of the detected segment in milliseconds.
  - startTimecodeSMPTE
```
public final 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).
    
    Returns:
    
    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).
  - endTimecodeSMPTE
```
public final 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).
    
    Returns:
    
    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).
  - durationSMPTE
```
public final String durationSMPTE()
```
    The duration of the timecode for the detected segment in SMPTE format.
    
    Returns:
    
    The duration of the timecode for the detected segment in SMPTE format.
  - technicalCueSegment
```
public final TechnicalCueSegment technicalCueSegment()
```
    If the segment is a technical cue, contains information about the technical cue.
    
    Returns:
    
    If the segment is a technical cue, contains information about the technical cue.
  - shotSegment
```
public final ShotSegment shotSegment()
```
    If the segment is a shot detection, contains information about the shot detection.
    
    Returns:
    
    If the segment is a shot detection, contains information about the shot detection.
  - toBuilder
```
public SegmentDetection.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SegmentDetection.Builder,SegmentDetection>
  - builder
```
public static SegmentDetection.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SegmentDetection.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SegmentDetection

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

type

typeAsString

startTimestampMillis

endTimestampMillis

durationMillis

startTimecodeSMPTE

endTimecodeSMPTE

durationSMPTE

technicalCueSegment

shotSegment

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields