{-# 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.MediaPackageVOD.Types.HlsManifest
-- 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.MediaPackageVOD.Types.HlsManifest where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MediaPackageVOD.Types.AdMarkers
import Amazonka.MediaPackageVOD.Types.StreamSelection
import qualified Amazonka.Prelude as Prelude

-- | An HTTP Live Streaming (HLS) manifest configuration.
--
-- /See:/ 'newHlsManifest' smart constructor.
data HlsManifest = HlsManifest'
  { -- | This setting controls how ad markers are included in the packaged
    -- OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the
    -- output. \"PASSTHROUGH\" causes the manifest to contain a copy of the
    -- SCTE-35 ad markers (comments) taken directly from the input HTTP Live
    -- Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and
    -- blackout tags based on SCTE-35 messages in the input source.
    HlsManifest -> Maybe AdMarkers
adMarkers :: Prelude.Maybe AdMarkers,
    -- | When enabled, an I-Frame only stream will be included in the output.
    HlsManifest -> Maybe Bool
includeIframeOnlyStream :: Prelude.Maybe Prelude.Bool,
    -- | An optional string to include in the name of the manifest.
    HlsManifest -> Maybe Text
manifestName :: Prelude.Maybe Prelude.Text,
    -- | The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
    -- inserted into manifests. Additionally, when an interval is specified
    -- ID3Timed Metadata messages will be generated every 5 seconds using the
    -- ingest time of the content. If the interval is not specified, or set to
    -- 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests
    -- and no ID3Timed Metadata messages will be generated. Note that
    -- irrespective of this parameter, if any ID3 Timed Metadata is found in
    -- HTTP Live Streaming (HLS) input, it will be passed through to HLS
    -- output.
    HlsManifest -> Maybe Int
programDateTimeIntervalSeconds :: Prelude.Maybe Prelude.Int,
    -- | When enabled, the EXT-X-KEY tag will be repeated in output manifests.
    HlsManifest -> Maybe Bool
repeatExtXKey :: Prelude.Maybe Prelude.Bool,
    HlsManifest -> Maybe StreamSelection
streamSelection :: Prelude.Maybe StreamSelection
  }
  deriving (HlsManifest -> HlsManifest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HlsManifest -> HlsManifest -> Bool
$c/= :: HlsManifest -> HlsManifest -> Bool
== :: HlsManifest -> HlsManifest -> Bool
$c== :: HlsManifest -> HlsManifest -> Bool
Prelude.Eq, ReadPrec [HlsManifest]
ReadPrec HlsManifest
Int -> ReadS HlsManifest
ReadS [HlsManifest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HlsManifest]
$creadListPrec :: ReadPrec [HlsManifest]
readPrec :: ReadPrec HlsManifest
$creadPrec :: ReadPrec HlsManifest
readList :: ReadS [HlsManifest]
$creadList :: ReadS [HlsManifest]
readsPrec :: Int -> ReadS HlsManifest
$creadsPrec :: Int -> ReadS HlsManifest
Prelude.Read, Int -> HlsManifest -> ShowS
[HlsManifest] -> ShowS
HlsManifest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HlsManifest] -> ShowS
$cshowList :: [HlsManifest] -> ShowS
show :: HlsManifest -> String
$cshow :: HlsManifest -> String
showsPrec :: Int -> HlsManifest -> ShowS
$cshowsPrec :: Int -> HlsManifest -> ShowS
Prelude.Show, forall x. Rep HlsManifest x -> HlsManifest
forall x. HlsManifest -> Rep HlsManifest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HlsManifest x -> HlsManifest
$cfrom :: forall x. HlsManifest -> Rep HlsManifest x
Prelude.Generic)

-- |
-- Create a value of 'HlsManifest' 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:
--
-- 'adMarkers', 'hlsManifest_adMarkers' - This setting controls how ad markers are included in the packaged
-- OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the
-- output. \"PASSTHROUGH\" causes the manifest to contain a copy of the
-- SCTE-35 ad markers (comments) taken directly from the input HTTP Live
-- Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and
-- blackout tags based on SCTE-35 messages in the input source.
--
-- 'includeIframeOnlyStream', 'hlsManifest_includeIframeOnlyStream' - When enabled, an I-Frame only stream will be included in the output.
--
-- 'manifestName', 'hlsManifest_manifestName' - An optional string to include in the name of the manifest.
--
-- 'programDateTimeIntervalSeconds', 'hlsManifest_programDateTimeIntervalSeconds' - The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
-- inserted into manifests. Additionally, when an interval is specified
-- ID3Timed Metadata messages will be generated every 5 seconds using the
-- ingest time of the content. If the interval is not specified, or set to
-- 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests
-- and no ID3Timed Metadata messages will be generated. Note that
-- irrespective of this parameter, if any ID3 Timed Metadata is found in
-- HTTP Live Streaming (HLS) input, it will be passed through to HLS
-- output.
--
-- 'repeatExtXKey', 'hlsManifest_repeatExtXKey' - When enabled, the EXT-X-KEY tag will be repeated in output manifests.
--
-- 'streamSelection', 'hlsManifest_streamSelection' - Undocumented member.
newHlsManifest ::
  HlsManifest
newHlsManifest :: HlsManifest
newHlsManifest =
  HlsManifest'
    { $sel:adMarkers:HlsManifest' :: Maybe AdMarkers
adMarkers = forall a. Maybe a
Prelude.Nothing,
      $sel:includeIframeOnlyStream:HlsManifest' :: Maybe Bool
includeIframeOnlyStream = forall a. Maybe a
Prelude.Nothing,
      $sel:manifestName:HlsManifest' :: Maybe Text
manifestName = forall a. Maybe a
Prelude.Nothing,
      $sel:programDateTimeIntervalSeconds:HlsManifest' :: Maybe Int
programDateTimeIntervalSeconds = forall a. Maybe a
Prelude.Nothing,
      $sel:repeatExtXKey:HlsManifest' :: Maybe Bool
repeatExtXKey = forall a. Maybe a
Prelude.Nothing,
      $sel:streamSelection:HlsManifest' :: Maybe StreamSelection
streamSelection = forall a. Maybe a
Prelude.Nothing
    }

-- | This setting controls how ad markers are included in the packaged
-- OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the
-- output. \"PASSTHROUGH\" causes the manifest to contain a copy of the
-- SCTE-35 ad markers (comments) taken directly from the input HTTP Live
-- Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and
-- blackout tags based on SCTE-35 messages in the input source.
hlsManifest_adMarkers :: Lens.Lens' HlsManifest (Prelude.Maybe AdMarkers)
hlsManifest_adMarkers :: Lens' HlsManifest (Maybe AdMarkers)
hlsManifest_adMarkers = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe AdMarkers
adMarkers :: Maybe AdMarkers
$sel:adMarkers:HlsManifest' :: HlsManifest -> Maybe AdMarkers
adMarkers} -> Maybe AdMarkers
adMarkers) (\s :: HlsManifest
s@HlsManifest' {} Maybe AdMarkers
a -> HlsManifest
s {$sel:adMarkers:HlsManifest' :: Maybe AdMarkers
adMarkers = Maybe AdMarkers
a} :: HlsManifest)

-- | When enabled, an I-Frame only stream will be included in the output.
hlsManifest_includeIframeOnlyStream :: Lens.Lens' HlsManifest (Prelude.Maybe Prelude.Bool)
hlsManifest_includeIframeOnlyStream :: Lens' HlsManifest (Maybe Bool)
hlsManifest_includeIframeOnlyStream = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe Bool
includeIframeOnlyStream :: Maybe Bool
$sel:includeIframeOnlyStream:HlsManifest' :: HlsManifest -> Maybe Bool
includeIframeOnlyStream} -> Maybe Bool
includeIframeOnlyStream) (\s :: HlsManifest
s@HlsManifest' {} Maybe Bool
a -> HlsManifest
s {$sel:includeIframeOnlyStream:HlsManifest' :: Maybe Bool
includeIframeOnlyStream = Maybe Bool
a} :: HlsManifest)

-- | An optional string to include in the name of the manifest.
hlsManifest_manifestName :: Lens.Lens' HlsManifest (Prelude.Maybe Prelude.Text)
hlsManifest_manifestName :: Lens' HlsManifest (Maybe Text)
hlsManifest_manifestName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe Text
manifestName :: Maybe Text
$sel:manifestName:HlsManifest' :: HlsManifest -> Maybe Text
manifestName} -> Maybe Text
manifestName) (\s :: HlsManifest
s@HlsManifest' {} Maybe Text
a -> HlsManifest
s {$sel:manifestName:HlsManifest' :: Maybe Text
manifestName = Maybe Text
a} :: HlsManifest)

-- | The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
-- inserted into manifests. Additionally, when an interval is specified
-- ID3Timed Metadata messages will be generated every 5 seconds using the
-- ingest time of the content. If the interval is not specified, or set to
-- 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests
-- and no ID3Timed Metadata messages will be generated. Note that
-- irrespective of this parameter, if any ID3 Timed Metadata is found in
-- HTTP Live Streaming (HLS) input, it will be passed through to HLS
-- output.
hlsManifest_programDateTimeIntervalSeconds :: Lens.Lens' HlsManifest (Prelude.Maybe Prelude.Int)
hlsManifest_programDateTimeIntervalSeconds :: Lens' HlsManifest (Maybe Int)
hlsManifest_programDateTimeIntervalSeconds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe Int
programDateTimeIntervalSeconds :: Maybe Int
$sel:programDateTimeIntervalSeconds:HlsManifest' :: HlsManifest -> Maybe Int
programDateTimeIntervalSeconds} -> Maybe Int
programDateTimeIntervalSeconds) (\s :: HlsManifest
s@HlsManifest' {} Maybe Int
a -> HlsManifest
s {$sel:programDateTimeIntervalSeconds:HlsManifest' :: Maybe Int
programDateTimeIntervalSeconds = Maybe Int
a} :: HlsManifest)

-- | When enabled, the EXT-X-KEY tag will be repeated in output manifests.
hlsManifest_repeatExtXKey :: Lens.Lens' HlsManifest (Prelude.Maybe Prelude.Bool)
hlsManifest_repeatExtXKey :: Lens' HlsManifest (Maybe Bool)
hlsManifest_repeatExtXKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe Bool
repeatExtXKey :: Maybe Bool
$sel:repeatExtXKey:HlsManifest' :: HlsManifest -> Maybe Bool
repeatExtXKey} -> Maybe Bool
repeatExtXKey) (\s :: HlsManifest
s@HlsManifest' {} Maybe Bool
a -> HlsManifest
s {$sel:repeatExtXKey:HlsManifest' :: Maybe Bool
repeatExtXKey = Maybe Bool
a} :: HlsManifest)

-- | Undocumented member.
hlsManifest_streamSelection :: Lens.Lens' HlsManifest (Prelude.Maybe StreamSelection)
hlsManifest_streamSelection :: Lens' HlsManifest (Maybe StreamSelection)
hlsManifest_streamSelection = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HlsManifest' {Maybe StreamSelection
streamSelection :: Maybe StreamSelection
$sel:streamSelection:HlsManifest' :: HlsManifest -> Maybe StreamSelection
streamSelection} -> Maybe StreamSelection
streamSelection) (\s :: HlsManifest
s@HlsManifest' {} Maybe StreamSelection
a -> HlsManifest
s {$sel:streamSelection:HlsManifest' :: Maybe StreamSelection
streamSelection = Maybe StreamSelection
a} :: HlsManifest)

instance Data.FromJSON HlsManifest where
  parseJSON :: Value -> Parser HlsManifest
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"HlsManifest"
      ( \Object
x ->
          Maybe AdMarkers
-> Maybe Bool
-> Maybe Text
-> Maybe Int
-> Maybe Bool
-> Maybe StreamSelection
-> HlsManifest
HlsManifest'
            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
"adMarkers")
            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
"includeIframeOnlyStream")
            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
"manifestName")
            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
"programDateTimeIntervalSeconds")
            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
"repeatExtXKey")
            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
"streamSelection")
      )

instance Prelude.Hashable HlsManifest where
  hashWithSalt :: Int -> HlsManifest -> Int
hashWithSalt Int
_salt HlsManifest' {Maybe Bool
Maybe Int
Maybe Text
Maybe AdMarkers
Maybe StreamSelection
streamSelection :: Maybe StreamSelection
repeatExtXKey :: Maybe Bool
programDateTimeIntervalSeconds :: Maybe Int
manifestName :: Maybe Text
includeIframeOnlyStream :: Maybe Bool
adMarkers :: Maybe AdMarkers
$sel:streamSelection:HlsManifest' :: HlsManifest -> Maybe StreamSelection
$sel:repeatExtXKey:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:programDateTimeIntervalSeconds:HlsManifest' :: HlsManifest -> Maybe Int
$sel:manifestName:HlsManifest' :: HlsManifest -> Maybe Text
$sel:includeIframeOnlyStream:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:adMarkers:HlsManifest' :: HlsManifest -> Maybe AdMarkers
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AdMarkers
adMarkers
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
includeIframeOnlyStream
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
manifestName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
programDateTimeIntervalSeconds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
repeatExtXKey
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe StreamSelection
streamSelection

instance Prelude.NFData HlsManifest where
  rnf :: HlsManifest -> ()
rnf HlsManifest' {Maybe Bool
Maybe Int
Maybe Text
Maybe AdMarkers
Maybe StreamSelection
streamSelection :: Maybe StreamSelection
repeatExtXKey :: Maybe Bool
programDateTimeIntervalSeconds :: Maybe Int
manifestName :: Maybe Text
includeIframeOnlyStream :: Maybe Bool
adMarkers :: Maybe AdMarkers
$sel:streamSelection:HlsManifest' :: HlsManifest -> Maybe StreamSelection
$sel:repeatExtXKey:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:programDateTimeIntervalSeconds:HlsManifest' :: HlsManifest -> Maybe Int
$sel:manifestName:HlsManifest' :: HlsManifest -> Maybe Text
$sel:includeIframeOnlyStream:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:adMarkers:HlsManifest' :: HlsManifest -> Maybe AdMarkers
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AdMarkers
adMarkers
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
includeIframeOnlyStream
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
manifestName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
programDateTimeIntervalSeconds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
repeatExtXKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe StreamSelection
streamSelection

instance Data.ToJSON HlsManifest where
  toJSON :: HlsManifest -> Value
toJSON HlsManifest' {Maybe Bool
Maybe Int
Maybe Text
Maybe AdMarkers
Maybe StreamSelection
streamSelection :: Maybe StreamSelection
repeatExtXKey :: Maybe Bool
programDateTimeIntervalSeconds :: Maybe Int
manifestName :: Maybe Text
includeIframeOnlyStream :: Maybe Bool
adMarkers :: Maybe AdMarkers
$sel:streamSelection:HlsManifest' :: HlsManifest -> Maybe StreamSelection
$sel:repeatExtXKey:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:programDateTimeIntervalSeconds:HlsManifest' :: HlsManifest -> Maybe Int
$sel:manifestName:HlsManifest' :: HlsManifest -> Maybe Text
$sel:includeIframeOnlyStream:HlsManifest' :: HlsManifest -> Maybe Bool
$sel:adMarkers:HlsManifest' :: HlsManifest -> Maybe AdMarkers
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"adMarkers" 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 AdMarkers
adMarkers,
            (Key
"includeIframeOnlyStream" 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
includeIframeOnlyStream,
            (Key
"manifestName" 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 Text
manifestName,
            (Key
"programDateTimeIntervalSeconds" 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 Int
programDateTimeIntervalSeconds,
            (Key
"repeatExtXKey" 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
repeatExtXKey,
            (Key
"streamSelection" 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 StreamSelection
streamSelection
          ]
      )