Amazonka.Transcribe.Types.RelativeTimeRange

Documentation

data RelativeTimeRange

A time range, in percentage, between two points in your media file.

You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.

You can use also First to search from the start of the media file until the time that you specify. Or use Last to search from the time that you specify until the end of the media file. For example, setting First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of the media file.

If you prefer to use milliseconds instead of percentage, see .

See: newRelativeTimeRange smart constructor.

Constructors

RelativeTimeRange'

Fields

• endPercentage :: Maybe Natural

  The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

• first :: Maybe Natural

  The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

• last :: Maybe Natural

  The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

• startPercentage :: Maybe Natural

  The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

Instances

FromJSON RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

parseJSON :: Value -> Parser RelativeTimeRange

parseJSONList :: Value -> Parser [RelativeTimeRange]

ToJSON RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

toJSON :: RelativeTimeRange -> Value

toEncoding :: RelativeTimeRange -> Encoding

toJSONList :: [RelativeTimeRange] -> Value

toEncodingList :: [RelativeTimeRange] -> Encoding

Generic RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Associated Types

type Rep RelativeTimeRange :: Type -> Type

Methods

from :: RelativeTimeRange -> Rep RelativeTimeRange x

to :: Rep RelativeTimeRange x -> RelativeTimeRange

Read RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

readsPrec :: Int -> ReadS RelativeTimeRange

readList :: ReadS [RelativeTimeRange]

readPrec :: ReadPrec RelativeTimeRange

readListPrec :: ReadPrec [RelativeTimeRange]

Show RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

showsPrec :: Int -> RelativeTimeRange -> ShowS

show :: RelativeTimeRange -> String

showList :: [RelativeTimeRange] -> ShowS

NFData RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

rnf :: RelativeTimeRange -> ()

Eq RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

(==) :: RelativeTimeRange -> RelativeTimeRange -> Bool

(/=) :: RelativeTimeRange -> RelativeTimeRange -> Bool

Hashable RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

Methods

hashWithSalt :: Int -> RelativeTimeRange -> Int

hash :: RelativeTimeRange -> Int

type Rep RelativeTimeRange

Defined in Amazonka.Transcribe.Types.RelativeTimeRange

type Rep RelativeTimeRange = D1 ('MetaData "RelativeTimeRange" "Amazonka.Transcribe.Types.RelativeTimeRange" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "RelativeTimeRange'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "first") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "last") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "startPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newRelativeTimeRange :: RelativeTimeRange

Create a value of RelativeTimeRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endPercentage:RelativeTimeRange', relativeTimeRange_endPercentage - The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

$sel:first:RelativeTimeRange', relativeTimeRange_first - The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

$sel:last:RelativeTimeRange', relativeTimeRange_last - The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

$sel:startPercentage:RelativeTimeRange', relativeTimeRange_startPercentage - The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

relativeTimeRange_endPercentage :: Lens' RelativeTimeRange (Maybe Natural)

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

relativeTimeRange_first :: Lens' RelativeTimeRange (Maybe Natural)

The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches for your specified criteria in this time segment.

relativeTimeRange_last :: Lens' RelativeTimeRange (Maybe Natural)

The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches for your specified criteria in this time segment.

relativeTimeRange_startPercentage :: Lens' RelativeTimeRange (Maybe Natural)

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.