Class: Aws::Rekognition::Types::GetSegmentDetectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetSegmentDetectionResponse

Defined in:

(unknown)

Overview

Returned by:

• Client#get_segment_detection

Instance Attribute Summary

• #audio_metadata ⇒ Array<Types::AudioMetadata>

  An array of objects.

• #job_status ⇒ String

  Current status of the segment detection job.

• #next_token ⇒ String

  If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.

• #segments ⇒ Array<Types::SegmentDetection>

  An array of segments detected in a video.

• #selected_segment_types ⇒ Array<Types::SegmentTypeInfo>

  An array containing the segment types requested in the call to StartSegmentDetection.

• #status_message ⇒ String

  If the job fails, StatusMessage provides a descriptive error message.

• #video_metadata ⇒ Array<Types::VideoMetadata>

  Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.

Instance Attribute Details

#audio_metadata ⇒ Array<Types::AudioMetadata>

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

• (Array<Types::AudioMetadata>) —

  An array of objects.

#job_status ⇒ String

Current status of the segment detection job.

Possible values:

• IN_PROGRESS
• SUCCEEDED
• FAILED

Returns:

• (String) —

  Current status of the segment detection job.

#next_token ⇒ String

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Returns:

• (String) —

  If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.

#segments ⇒ Array<Types::SegmentDetection>

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

Returns:

• (Array<Types::SegmentDetection>) —

  An array of segments detected in a video.

#selected_segment_types ⇒ Array<Types::SegmentTypeInfo>

An array containing the segment types requested in the call to StartSegmentDetection.

Returns:

• (Array<Types::SegmentTypeInfo>) —

  An array containing the segment types requested in the call to StartSegmentDetection.

#status_message ⇒ String

If the job fails, StatusMessage provides a descriptive error message.

Returns:

• (String) —

  If the job fails, StatusMessage provides a descriptive error message.

#video_metadata ⇒ Array<Types::VideoMetadata>

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Returns:

• (Array<Types::VideoMetadata>) —

  Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array.