{-# 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.IVS.Types.ThumbnailConfiguration
-- 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.IVS.Types.ThumbnailConfiguration where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IVS.Types.RecordingMode
import qualified Amazonka.Prelude as Prelude

-- | An object representing a configuration of thumbnails for recorded video.
--
-- /See:/ 'newThumbnailConfiguration' smart constructor.
data ThumbnailConfiguration = ThumbnailConfiguration'
  { -- | Thumbnail recording mode. Default: @INTERVAL@.
    ThumbnailConfiguration -> Maybe RecordingMode
recordingMode :: Prelude.Maybe RecordingMode,
    -- | The targeted thumbnail-generation interval in seconds. This is
    -- configurable (and required) only if @recordingMode@ is @INTERVAL@.
    -- Default: 60.
    --
    -- __Important:__ Setting a value for @targetIntervalSeconds@ does not
    -- guarantee that thumbnails are generated at the specified interval. For
    -- thumbnails to be generated at the @targetIntervalSeconds@ interval, the
    -- @IDR\/Keyframe@ value for the input video must be less than the
    -- @targetIntervalSeconds@ value. See
    -- <https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html Amazon IVS Streaming Configuration>
    -- for information on setting @IDR\/Keyframe@ to the recommended value in
    -- video-encoder settings.
    ThumbnailConfiguration -> Maybe Natural
targetIntervalSeconds :: Prelude.Maybe Prelude.Natural
  }
  deriving (ThumbnailConfiguration -> ThumbnailConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool
$c/= :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool
== :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool
$c== :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool
Prelude.Eq, ReadPrec [ThumbnailConfiguration]
ReadPrec ThumbnailConfiguration
Int -> ReadS ThumbnailConfiguration
ReadS [ThumbnailConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ThumbnailConfiguration]
$creadListPrec :: ReadPrec [ThumbnailConfiguration]
readPrec :: ReadPrec ThumbnailConfiguration
$creadPrec :: ReadPrec ThumbnailConfiguration
readList :: ReadS [ThumbnailConfiguration]
$creadList :: ReadS [ThumbnailConfiguration]
readsPrec :: Int -> ReadS ThumbnailConfiguration
$creadsPrec :: Int -> ReadS ThumbnailConfiguration
Prelude.Read, Int -> ThumbnailConfiguration -> ShowS
[ThumbnailConfiguration] -> ShowS
ThumbnailConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ThumbnailConfiguration] -> ShowS
$cshowList :: [ThumbnailConfiguration] -> ShowS
show :: ThumbnailConfiguration -> String
$cshow :: ThumbnailConfiguration -> String
showsPrec :: Int -> ThumbnailConfiguration -> ShowS
$cshowsPrec :: Int -> ThumbnailConfiguration -> ShowS
Prelude.Show, forall x. Rep ThumbnailConfiguration x -> ThumbnailConfiguration
forall x. ThumbnailConfiguration -> Rep ThumbnailConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ThumbnailConfiguration x -> ThumbnailConfiguration
$cfrom :: forall x. ThumbnailConfiguration -> Rep ThumbnailConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'ThumbnailConfiguration' 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:
--
-- 'recordingMode', 'thumbnailConfiguration_recordingMode' - Thumbnail recording mode. Default: @INTERVAL@.
--
-- 'targetIntervalSeconds', 'thumbnailConfiguration_targetIntervalSeconds' - The targeted thumbnail-generation interval in seconds. This is
-- configurable (and required) only if @recordingMode@ is @INTERVAL@.
-- Default: 60.
--
-- __Important:__ Setting a value for @targetIntervalSeconds@ does not
-- guarantee that thumbnails are generated at the specified interval. For
-- thumbnails to be generated at the @targetIntervalSeconds@ interval, the
-- @IDR\/Keyframe@ value for the input video must be less than the
-- @targetIntervalSeconds@ value. See
-- <https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html Amazon IVS Streaming Configuration>
-- for information on setting @IDR\/Keyframe@ to the recommended value in
-- video-encoder settings.
newThumbnailConfiguration ::
  ThumbnailConfiguration
newThumbnailConfiguration :: ThumbnailConfiguration
newThumbnailConfiguration =
  ThumbnailConfiguration'
    { $sel:recordingMode:ThumbnailConfiguration' :: Maybe RecordingMode
recordingMode =
        forall a. Maybe a
Prelude.Nothing,
      $sel:targetIntervalSeconds:ThumbnailConfiguration' :: Maybe Natural
targetIntervalSeconds = forall a. Maybe a
Prelude.Nothing
    }

-- | Thumbnail recording mode. Default: @INTERVAL@.
thumbnailConfiguration_recordingMode :: Lens.Lens' ThumbnailConfiguration (Prelude.Maybe RecordingMode)
thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode)
thumbnailConfiguration_recordingMode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ThumbnailConfiguration' {Maybe RecordingMode
recordingMode :: Maybe RecordingMode
$sel:recordingMode:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe RecordingMode
recordingMode} -> Maybe RecordingMode
recordingMode) (\s :: ThumbnailConfiguration
s@ThumbnailConfiguration' {} Maybe RecordingMode
a -> ThumbnailConfiguration
s {$sel:recordingMode:ThumbnailConfiguration' :: Maybe RecordingMode
recordingMode = Maybe RecordingMode
a} :: ThumbnailConfiguration)

-- | The targeted thumbnail-generation interval in seconds. This is
-- configurable (and required) only if @recordingMode@ is @INTERVAL@.
-- Default: 60.
--
-- __Important:__ Setting a value for @targetIntervalSeconds@ does not
-- guarantee that thumbnails are generated at the specified interval. For
-- thumbnails to be generated at the @targetIntervalSeconds@ interval, the
-- @IDR\/Keyframe@ value for the input video must be less than the
-- @targetIntervalSeconds@ value. See
-- <https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html Amazon IVS Streaming Configuration>
-- for information on setting @IDR\/Keyframe@ to the recommended value in
-- video-encoder settings.
thumbnailConfiguration_targetIntervalSeconds :: Lens.Lens' ThumbnailConfiguration (Prelude.Maybe Prelude.Natural)
thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural)
thumbnailConfiguration_targetIntervalSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ThumbnailConfiguration' {Maybe Natural
targetIntervalSeconds :: Maybe Natural
$sel:targetIntervalSeconds:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe Natural
targetIntervalSeconds} -> Maybe Natural
targetIntervalSeconds) (\s :: ThumbnailConfiguration
s@ThumbnailConfiguration' {} Maybe Natural
a -> ThumbnailConfiguration
s {$sel:targetIntervalSeconds:ThumbnailConfiguration' :: Maybe Natural
targetIntervalSeconds = Maybe Natural
a} :: ThumbnailConfiguration)

instance Data.FromJSON ThumbnailConfiguration where
  parseJSON :: Value -> Parser ThumbnailConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ThumbnailConfiguration"
      ( \Object
x ->
          Maybe RecordingMode -> Maybe Natural -> ThumbnailConfiguration
ThumbnailConfiguration'
            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
"recordingMode")
            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
"targetIntervalSeconds")
      )

instance Prelude.Hashable ThumbnailConfiguration where
  hashWithSalt :: Int -> ThumbnailConfiguration -> Int
hashWithSalt Int
_salt ThumbnailConfiguration' {Maybe Natural
Maybe RecordingMode
targetIntervalSeconds :: Maybe Natural
recordingMode :: Maybe RecordingMode
$sel:targetIntervalSeconds:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe Natural
$sel:recordingMode:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe RecordingMode
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe RecordingMode
recordingMode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
targetIntervalSeconds

instance Prelude.NFData ThumbnailConfiguration where
  rnf :: ThumbnailConfiguration -> ()
rnf ThumbnailConfiguration' {Maybe Natural
Maybe RecordingMode
targetIntervalSeconds :: Maybe Natural
recordingMode :: Maybe RecordingMode
$sel:targetIntervalSeconds:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe Natural
$sel:recordingMode:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe RecordingMode
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe RecordingMode
recordingMode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
targetIntervalSeconds

instance Data.ToJSON ThumbnailConfiguration where
  toJSON :: ThumbnailConfiguration -> Value
toJSON ThumbnailConfiguration' {Maybe Natural
Maybe RecordingMode
targetIntervalSeconds :: Maybe Natural
recordingMode :: Maybe RecordingMode
$sel:targetIntervalSeconds:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe Natural
$sel:recordingMode:ThumbnailConfiguration' :: ThumbnailConfiguration -> Maybe RecordingMode
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"recordingMode" 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 RecordingMode
recordingMode,
            (Key
"targetIntervalSeconds" 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
targetIntervalSeconds
          ]
      )