com.amazonaws.services.rekognition.model

Class SegmentDetection

java.lang.Object

com.amazonaws.services.rekognition.model.SegmentDetection

All Implemented Interfaces:

java.io.Serializable

public class SegmentDetection
extends java.lang.Object
implements java.io.Serializable

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

Constructor Summary

Constructors

Constructor and Description
SegmentDetection()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Long	getDurationMillis() The duration of the detected segment in milliseconds.
java.lang.String	getDurationSMPTE() The duration of the timecode for the detected segment in SMPTE format.
java.lang.String	getEndTimecodeSMPTE() The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment.
java.lang.Long	getEndTimestampMillis() The end time of the detected segment, in milliseconds, from the start of the video.
ShotSegment	getShotSegment() If the segment is a shot detection, contains information about the shot detection.
java.lang.String	getStartTimecodeSMPTE() The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.
java.lang.Long	getStartTimestampMillis() The start time of the detected segment in milliseconds from the start of the video.
TechnicalCueSegment	getTechnicalCueSegment() If the segment is a technical cue, contains information about the technical cue.
java.lang.String	getType() The type of the segment.
int	hashCode()
void	setDurationMillis(java.lang.Long durationMillis) The duration of the detected segment in milliseconds.
void	setDurationSMPTE(java.lang.String durationSMPTE) The duration of the timecode for the detected segment in SMPTE format.
void	setEndTimecodeSMPTE(java.lang.String endTimecodeSMPTE) The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment.
void	setEndTimestampMillis(java.lang.Long endTimestampMillis) The end time of the detected segment, in milliseconds, from the start of the video.
void	setShotSegment(ShotSegment shotSegment) If the segment is a shot detection, contains information about the shot detection.
void	setStartTimecodeSMPTE(java.lang.String startTimecodeSMPTE) The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.
void	setStartTimestampMillis(java.lang.Long startTimestampMillis) The start time of the detected segment in milliseconds from the start of the video.
void	setTechnicalCueSegment(TechnicalCueSegment technicalCueSegment) If the segment is a technical cue, contains information about the technical cue.
void	setType(SegmentType type) The type of the segment.
void	setType(java.lang.String type) The type of the segment.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SegmentDetection	withDurationMillis(java.lang.Long durationMillis) The duration of the detected segment in milliseconds.
SegmentDetection	withDurationSMPTE(java.lang.String durationSMPTE) The duration of the timecode for the detected segment in SMPTE format.
SegmentDetection	withEndTimecodeSMPTE(java.lang.String endTimecodeSMPTE) The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment.
SegmentDetection	withEndTimestampMillis(java.lang.Long endTimestampMillis) The end time of the detected segment, in milliseconds, from the start of the video.
SegmentDetection	withShotSegment(ShotSegment shotSegment) If the segment is a shot detection, contains information about the shot detection.
SegmentDetection	withStartTimecodeSMPTE(java.lang.String startTimecodeSMPTE) The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.
SegmentDetection	withStartTimestampMillis(java.lang.Long startTimestampMillis) The start time of the detected segment in milliseconds from the start of the video.
SegmentDetection	withTechnicalCueSegment(TechnicalCueSegment technicalCueSegment) If the segment is a technical cue, contains information about the technical cue.
SegmentDetection	withType(SegmentType type) The type of the segment.
SegmentDetection	withType(java.lang.String type) The type of the segment.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentDetection

public SegmentDetection()

Method Detail

getType

public java.lang.String getType()

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

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Returns:

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

See Also:

SegmentType

setType

public void setType(java.lang.String type)

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

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Parameters:

type -

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

See Also:

SegmentType

withType

public SegmentDetection withType(java.lang.String type)

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

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

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Parameters:

type -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SegmentType

setType

public void setType(SegmentType type)

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

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Parameters:

type -

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

See Also:

SegmentType

withType

public SegmentDetection withType(SegmentType type)

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

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

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Parameters:

type -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SegmentType

getStartTimestampMillis

public java.lang.Long getStartTimestampMillis()

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.

setStartTimestampMillis

public void setStartTimestampMillis(java.lang.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.

withStartTimestampMillis

public SegmentDetection withStartTimestampMillis(java.lang.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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getEndTimestampMillis

public java.lang.Long getEndTimestampMillis()

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.

setEndTimestampMillis

public void setEndTimestampMillis(java.lang.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.

withEndTimestampMillis

public SegmentDetection withEndTimestampMillis(java.lang.Long endTimestampMillis)

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

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

Parameters:

endTimestampMillis -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDurationMillis

public java.lang.Long getDurationMillis()

The duration of the detected segment in milliseconds.

Constraints:
Range: 0 -

Returns:

The duration of the detected segment in milliseconds.

setDurationMillis

public void setDurationMillis(java.lang.Long durationMillis)

The duration of the detected segment in milliseconds.

Constraints:
Range: 0 -

Parameters:

durationMillis -

The duration of the detected segment in milliseconds.

withDurationMillis

public SegmentDetection withDurationMillis(java.lang.Long durationMillis)

The duration of the detected segment in milliseconds.

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

Constraints:
Range: 0 -

Parameters:

durationMillis -

The duration of the detected segment in milliseconds.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTimecodeSMPTE

public java.lang.String getStartTimecodeSMPTE()

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

setStartTimecodeSMPTE

public void setStartTimecodeSMPTE(java.lang.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).

withStartTimecodeSMPTE

public SegmentDetection withStartTimecodeSMPTE(java.lang.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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getEndTimecodeSMPTE

public java.lang.String getEndTimecodeSMPTE()

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

setEndTimecodeSMPTE

public void setEndTimecodeSMPTE(java.lang.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).

withEndTimecodeSMPTE

public SegmentDetection withEndTimecodeSMPTE(java.lang.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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getDurationSMPTE

public java.lang.String getDurationSMPTE()

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.

setDurationSMPTE

public void setDurationSMPTE(java.lang.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.

withDurationSMPTE

public SegmentDetection withDurationSMPTE(java.lang.String durationSMPTE)

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

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

Parameters:

durationSMPTE -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTechnicalCueSegment

public TechnicalCueSegment getTechnicalCueSegment()

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.

setTechnicalCueSegment

public void setTechnicalCueSegment(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.

withTechnicalCueSegment

public SegmentDetection withTechnicalCueSegment(TechnicalCueSegment technicalCueSegment)

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

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

Parameters:

technicalCueSegment -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getShotSegment

public ShotSegment getShotSegment()

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.

setShotSegment

public void setShotSegment(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.

withShotSegment

public SegmentDetection withShotSegment(ShotSegment shotSegment)

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

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

Parameters:

shotSegment -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object