{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Transcribe.Types.NonTalkTimeFilter
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Transcribe.Types.NonTalkTimeFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.Transcribe.Types.AbsoluteTimeRange
import Amazonka.Transcribe.Types.RelativeTimeRange

-- | Flag the presence or absence of periods of silence in your Call
-- Analytics transcription output.
--
-- Rules using @NonTalkTimeFilter@ are designed to match:
--
-- -   The presence of silence at specified periods throughout the call
--
-- -   The presence of speech at specified periods throughout the call
--
-- See
-- <https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch Rule criteria for batch categories>
-- for usage examples.
--
-- /See:/ 'newNonTalkTimeFilter' smart constructor.
data NonTalkTimeFilter = NonTalkTimeFilter'
  { -- | Makes it possible to specify a time range (in milliseconds) in your
    -- audio, during which you want to search for a period of silence. See for
    -- more detail.
    NonTalkTimeFilter -> Maybe AbsoluteTimeRange
absoluteTimeRange :: Prelude.Maybe AbsoluteTimeRange,
    -- | Set to @TRUE@ to flag periods of speech. Set to @FALSE@ to flag periods
    -- of silence
    NonTalkTimeFilter -> Maybe Bool
negate :: Prelude.Maybe Prelude.Bool,
    -- | Makes it possible to specify a time range (in percentage) in your media
    -- file, during which you want to search for a period of silence. See for
    -- more detail.
    NonTalkTimeFilter -> Maybe RelativeTimeRange
relativeTimeRange :: Prelude.Maybe RelativeTimeRange,
    -- | Specify the duration, in milliseconds, of the period of silence that you
    -- want to flag. For example, you can flag a silent period that lasts
    -- 30,000 milliseconds.
    NonTalkTimeFilter -> Maybe Natural
threshold :: Prelude.Maybe Prelude.Natural
  }
  deriving (NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
$c/= :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
== :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
$c== :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
Prelude.Eq, ReadPrec [NonTalkTimeFilter]
ReadPrec NonTalkTimeFilter
Int -> ReadS NonTalkTimeFilter
ReadS [NonTalkTimeFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [NonTalkTimeFilter]
$creadListPrec :: ReadPrec [NonTalkTimeFilter]
readPrec :: ReadPrec NonTalkTimeFilter
$creadPrec :: ReadPrec NonTalkTimeFilter
readList :: ReadS [NonTalkTimeFilter]
$creadList :: ReadS [NonTalkTimeFilter]
readsPrec :: Int -> ReadS NonTalkTimeFilter
$creadsPrec :: Int -> ReadS NonTalkTimeFilter
Prelude.Read, Int -> NonTalkTimeFilter -> ShowS
[NonTalkTimeFilter] -> ShowS
NonTalkTimeFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [NonTalkTimeFilter] -> ShowS
$cshowList :: [NonTalkTimeFilter] -> ShowS
show :: NonTalkTimeFilter -> String
$cshow :: NonTalkTimeFilter -> String
showsPrec :: Int -> NonTalkTimeFilter -> ShowS
$cshowsPrec :: Int -> NonTalkTimeFilter -> ShowS
Prelude.Show, forall x. Rep NonTalkTimeFilter x -> NonTalkTimeFilter
forall x. NonTalkTimeFilter -> Rep NonTalkTimeFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep NonTalkTimeFilter x -> NonTalkTimeFilter
$cfrom :: forall x. NonTalkTimeFilter -> Rep NonTalkTimeFilter x
Prelude.Generic)

-- |
-- Create a value of 'NonTalkTimeFilter' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'absoluteTimeRange', 'nonTalkTimeFilter_absoluteTimeRange' - Makes it possible to specify a time range (in milliseconds) in your
-- audio, during which you want to search for a period of silence. See for
-- more detail.
--
-- 'negate', 'nonTalkTimeFilter_negate' - Set to @TRUE@ to flag periods of speech. Set to @FALSE@ to flag periods
-- of silence
--
-- 'relativeTimeRange', 'nonTalkTimeFilter_relativeTimeRange' - Makes it possible to specify a time range (in percentage) in your media
-- file, during which you want to search for a period of silence. See for
-- more detail.
--
-- 'threshold', 'nonTalkTimeFilter_threshold' - Specify the duration, in milliseconds, of the period of silence that you
-- want to flag. For example, you can flag a silent period that lasts
-- 30,000 milliseconds.
newNonTalkTimeFilter ::
  NonTalkTimeFilter
newNonTalkTimeFilter :: NonTalkTimeFilter
newNonTalkTimeFilter =
  NonTalkTimeFilter'
    { $sel:absoluteTimeRange:NonTalkTimeFilter' :: Maybe AbsoluteTimeRange
absoluteTimeRange =
        forall a. Maybe a
Prelude.Nothing,
      $sel:negate:NonTalkTimeFilter' :: Maybe Bool
negate = forall a. Maybe a
Prelude.Nothing,
      $sel:relativeTimeRange:NonTalkTimeFilter' :: Maybe RelativeTimeRange
relativeTimeRange = forall a. Maybe a
Prelude.Nothing,
      $sel:threshold:NonTalkTimeFilter' :: Maybe Natural
threshold = forall a. Maybe a
Prelude.Nothing
    }

-- | Makes it possible to specify a time range (in milliseconds) in your
-- audio, during which you want to search for a period of silence. See for
-- more detail.
nonTalkTimeFilter_absoluteTimeRange :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe AbsoluteTimeRange)
nonTalkTimeFilter_absoluteTimeRange :: Lens' NonTalkTimeFilter (Maybe AbsoluteTimeRange)
nonTalkTimeFilter_absoluteTimeRange = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe AbsoluteTimeRange
absoluteTimeRange :: Maybe AbsoluteTimeRange
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
absoluteTimeRange} -> Maybe AbsoluteTimeRange
absoluteTimeRange) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe AbsoluteTimeRange
a -> NonTalkTimeFilter
s {$sel:absoluteTimeRange:NonTalkTimeFilter' :: Maybe AbsoluteTimeRange
absoluteTimeRange = Maybe AbsoluteTimeRange
a} :: NonTalkTimeFilter)

-- | Set to @TRUE@ to flag periods of speech. Set to @FALSE@ to flag periods
-- of silence
nonTalkTimeFilter_negate :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe Prelude.Bool)
nonTalkTimeFilter_negate :: Lens' NonTalkTimeFilter (Maybe Bool)
nonTalkTimeFilter_negate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe Bool
negate :: Maybe Bool
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
negate} -> Maybe Bool
negate) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe Bool
a -> NonTalkTimeFilter
s {$sel:negate:NonTalkTimeFilter' :: Maybe Bool
negate = Maybe Bool
a} :: NonTalkTimeFilter)

-- | Makes it possible to specify a time range (in percentage) in your media
-- file, during which you want to search for a period of silence. See for
-- more detail.
nonTalkTimeFilter_relativeTimeRange :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe RelativeTimeRange)
nonTalkTimeFilter_relativeTimeRange :: Lens' NonTalkTimeFilter (Maybe RelativeTimeRange)
nonTalkTimeFilter_relativeTimeRange = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe RelativeTimeRange
relativeTimeRange :: Maybe RelativeTimeRange
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
relativeTimeRange} -> Maybe RelativeTimeRange
relativeTimeRange) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe RelativeTimeRange
a -> NonTalkTimeFilter
s {$sel:relativeTimeRange:NonTalkTimeFilter' :: Maybe RelativeTimeRange
relativeTimeRange = Maybe RelativeTimeRange
a} :: NonTalkTimeFilter)

-- | Specify the duration, in milliseconds, of the period of silence that you
-- want to flag. For example, you can flag a silent period that lasts
-- 30,000 milliseconds.
nonTalkTimeFilter_threshold :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe Prelude.Natural)
nonTalkTimeFilter_threshold :: Lens' NonTalkTimeFilter (Maybe Natural)
nonTalkTimeFilter_threshold = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe Natural
threshold :: Maybe Natural
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
threshold} -> Maybe Natural
threshold) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe Natural
a -> NonTalkTimeFilter
s {$sel:threshold:NonTalkTimeFilter' :: Maybe Natural
threshold = Maybe Natural
a} :: NonTalkTimeFilter)

instance Data.FromJSON NonTalkTimeFilter where
  parseJSON :: Value -> Parser NonTalkTimeFilter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"NonTalkTimeFilter"
      ( \Object
x ->
          Maybe AbsoluteTimeRange
-> Maybe Bool
-> Maybe RelativeTimeRange
-> Maybe Natural
-> NonTalkTimeFilter
NonTalkTimeFilter'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"AbsoluteTimeRange")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Negate")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"RelativeTimeRange")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Threshold")
      )

instance Prelude.Hashable NonTalkTimeFilter where
  hashWithSalt :: Int -> NonTalkTimeFilter -> Int
hashWithSalt Int
_salt NonTalkTimeFilter' {Maybe Bool
Maybe Natural
Maybe AbsoluteTimeRange
Maybe RelativeTimeRange
threshold :: Maybe Natural
relativeTimeRange :: Maybe RelativeTimeRange
negate :: Maybe Bool
absoluteTimeRange :: Maybe AbsoluteTimeRange
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AbsoluteTimeRange
absoluteTimeRange
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
negate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe RelativeTimeRange
relativeTimeRange
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
threshold

instance Prelude.NFData NonTalkTimeFilter where
  rnf :: NonTalkTimeFilter -> ()
rnf NonTalkTimeFilter' {Maybe Bool
Maybe Natural
Maybe AbsoluteTimeRange
Maybe RelativeTimeRange
threshold :: Maybe Natural
relativeTimeRange :: Maybe RelativeTimeRange
negate :: Maybe Bool
absoluteTimeRange :: Maybe AbsoluteTimeRange
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AbsoluteTimeRange
absoluteTimeRange
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
negate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe RelativeTimeRange
relativeTimeRange
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
threshold

instance Data.ToJSON NonTalkTimeFilter where
  toJSON :: NonTalkTimeFilter -> Value
toJSON NonTalkTimeFilter' {Maybe Bool
Maybe Natural
Maybe AbsoluteTimeRange
Maybe RelativeTimeRange
threshold :: Maybe Natural
relativeTimeRange :: Maybe RelativeTimeRange
negate :: Maybe Bool
absoluteTimeRange :: Maybe AbsoluteTimeRange
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AbsoluteTimeRange" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe AbsoluteTimeRange
absoluteTimeRange,
            (Key
"Negate" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
negate,
            (Key
"RelativeTimeRange" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe RelativeTimeRange
relativeTimeRange,
            (Key
"Threshold" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
threshold
          ]
      )