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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_metadataArray<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:



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

Current status of the segment detection job.

Returns:

  • (String)


2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)


2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#segmentsArray<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:



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#selected_segment_typesArray<Types::SegmentTypeInfo>

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

Returns:



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

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

Returns:

  • (String)


2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#video_metadataArray<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:



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2743

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types)
  SENSITIVE = []
  include Aws::Structure
end