This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-mediaconvert/include/aws/mediaconvert/model/CaptionDestinationSettings.h

374 lines
16 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/mediaconvert/MediaConvert_EXPORTS.h>
#include <aws/mediaconvert/model/BurninDestinationSettings.h>
#include <aws/mediaconvert/model/CaptionDestinationType.h>
#include <aws/mediaconvert/model/DvbSubDestinationSettings.h>
#include <aws/mediaconvert/model/EmbeddedDestinationSettings.h>
#include <aws/mediaconvert/model/ImscDestinationSettings.h>
#include <aws/mediaconvert/model/SccDestinationSettings.h>
#include <aws/mediaconvert/model/TeletextDestinationSettings.h>
#include <aws/mediaconvert/model/TtmlDestinationSettings.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace MediaConvert
{
namespace Model
{
/**
* Specific settings required by destination type. Note that
* burnin_destination_settings are not available if the source of the caption data
* is Embedded or Teletext.<p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/CaptionDestinationSettings">AWS
* API Reference</a></p>
*/
class AWS_MEDIACONVERT_API CaptionDestinationSettings
{
public:
CaptionDestinationSettings();
CaptionDestinationSettings(Aws::Utils::Json::JsonView jsonValue);
CaptionDestinationSettings& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* Burn-In Destination Settings.
*/
inline const BurninDestinationSettings& GetBurninDestinationSettings() const{ return m_burninDestinationSettings; }
/**
* Burn-In Destination Settings.
*/
inline bool BurninDestinationSettingsHasBeenSet() const { return m_burninDestinationSettingsHasBeenSet; }
/**
* Burn-In Destination Settings.
*/
inline void SetBurninDestinationSettings(const BurninDestinationSettings& value) { m_burninDestinationSettingsHasBeenSet = true; m_burninDestinationSettings = value; }
/**
* Burn-In Destination Settings.
*/
inline void SetBurninDestinationSettings(BurninDestinationSettings&& value) { m_burninDestinationSettingsHasBeenSet = true; m_burninDestinationSettings = std::move(value); }
/**
* Burn-In Destination Settings.
*/
inline CaptionDestinationSettings& WithBurninDestinationSettings(const BurninDestinationSettings& value) { SetBurninDestinationSettings(value); return *this;}
/**
* Burn-In Destination Settings.
*/
inline CaptionDestinationSettings& WithBurninDestinationSettings(BurninDestinationSettings&& value) { SetBurninDestinationSettings(std::move(value)); return *this;}
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline const CaptionDestinationType& GetDestinationType() const{ return m_destinationType; }
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline bool DestinationTypeHasBeenSet() const { return m_destinationTypeHasBeenSet; }
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline void SetDestinationType(const CaptionDestinationType& value) { m_destinationTypeHasBeenSet = true; m_destinationType = value; }
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline void SetDestinationType(CaptionDestinationType&& value) { m_destinationTypeHasBeenSet = true; m_destinationType = std::move(value); }
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline CaptionDestinationSettings& WithDestinationType(const CaptionDestinationType& value) { SetDestinationType(value); return *this;}
/**
* Specify the format for this set of captions on this output. The default format
* is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in,
* DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20,
* choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that
* complies with the SCTE-43 spec. To create a non-compliant output where the
* embedded captions come first, choose Embedded plus SCTE-20
* (EMBEDDED_PLUS_SCTE20).
*/
inline CaptionDestinationSettings& WithDestinationType(CaptionDestinationType&& value) { SetDestinationType(std::move(value)); return *this;}
/**
* DVB-Sub Destination Settings
*/
inline const DvbSubDestinationSettings& GetDvbSubDestinationSettings() const{ return m_dvbSubDestinationSettings; }
/**
* DVB-Sub Destination Settings
*/
inline bool DvbSubDestinationSettingsHasBeenSet() const { return m_dvbSubDestinationSettingsHasBeenSet; }
/**
* DVB-Sub Destination Settings
*/
inline void SetDvbSubDestinationSettings(const DvbSubDestinationSettings& value) { m_dvbSubDestinationSettingsHasBeenSet = true; m_dvbSubDestinationSettings = value; }
/**
* DVB-Sub Destination Settings
*/
inline void SetDvbSubDestinationSettings(DvbSubDestinationSettings&& value) { m_dvbSubDestinationSettingsHasBeenSet = true; m_dvbSubDestinationSettings = std::move(value); }
/**
* DVB-Sub Destination Settings
*/
inline CaptionDestinationSettings& WithDvbSubDestinationSettings(const DvbSubDestinationSettings& value) { SetDvbSubDestinationSettings(value); return *this;}
/**
* DVB-Sub Destination Settings
*/
inline CaptionDestinationSettings& WithDvbSubDestinationSettings(DvbSubDestinationSettings&& value) { SetDvbSubDestinationSettings(std::move(value)); return *this;}
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline const EmbeddedDestinationSettings& GetEmbeddedDestinationSettings() const{ return m_embeddedDestinationSettings; }
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline bool EmbeddedDestinationSettingsHasBeenSet() const { return m_embeddedDestinationSettingsHasBeenSet; }
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline void SetEmbeddedDestinationSettings(const EmbeddedDestinationSettings& value) { m_embeddedDestinationSettingsHasBeenSet = true; m_embeddedDestinationSettings = value; }
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline void SetEmbeddedDestinationSettings(EmbeddedDestinationSettings&& value) { m_embeddedDestinationSettingsHasBeenSet = true; m_embeddedDestinationSettings = std::move(value); }
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline CaptionDestinationSettings& WithEmbeddedDestinationSettings(const EmbeddedDestinationSettings& value) { SetEmbeddedDestinationSettings(value); return *this;}
/**
* Settings specific to embedded/ancillary caption outputs, including 608/708
* Channel destination number.
*/
inline CaptionDestinationSettings& WithEmbeddedDestinationSettings(EmbeddedDestinationSettings&& value) { SetEmbeddedDestinationSettings(std::move(value)); return *this;}
/**
* Settings specific to IMSC caption outputs.
*/
inline const ImscDestinationSettings& GetImscDestinationSettings() const{ return m_imscDestinationSettings; }
/**
* Settings specific to IMSC caption outputs.
*/
inline bool ImscDestinationSettingsHasBeenSet() const { return m_imscDestinationSettingsHasBeenSet; }
/**
* Settings specific to IMSC caption outputs.
*/
inline void SetImscDestinationSettings(const ImscDestinationSettings& value) { m_imscDestinationSettingsHasBeenSet = true; m_imscDestinationSettings = value; }
/**
* Settings specific to IMSC caption outputs.
*/
inline void SetImscDestinationSettings(ImscDestinationSettings&& value) { m_imscDestinationSettingsHasBeenSet = true; m_imscDestinationSettings = std::move(value); }
/**
* Settings specific to IMSC caption outputs.
*/
inline CaptionDestinationSettings& WithImscDestinationSettings(const ImscDestinationSettings& value) { SetImscDestinationSettings(value); return *this;}
/**
* Settings specific to IMSC caption outputs.
*/
inline CaptionDestinationSettings& WithImscDestinationSettings(ImscDestinationSettings&& value) { SetImscDestinationSettings(std::move(value)); return *this;}
/**
* Settings for SCC caption output.
*/
inline const SccDestinationSettings& GetSccDestinationSettings() const{ return m_sccDestinationSettings; }
/**
* Settings for SCC caption output.
*/
inline bool SccDestinationSettingsHasBeenSet() const { return m_sccDestinationSettingsHasBeenSet; }
/**
* Settings for SCC caption output.
*/
inline void SetSccDestinationSettings(const SccDestinationSettings& value) { m_sccDestinationSettingsHasBeenSet = true; m_sccDestinationSettings = value; }
/**
* Settings for SCC caption output.
*/
inline void SetSccDestinationSettings(SccDestinationSettings&& value) { m_sccDestinationSettingsHasBeenSet = true; m_sccDestinationSettings = std::move(value); }
/**
* Settings for SCC caption output.
*/
inline CaptionDestinationSettings& WithSccDestinationSettings(const SccDestinationSettings& value) { SetSccDestinationSettings(value); return *this;}
/**
* Settings for SCC caption output.
*/
inline CaptionDestinationSettings& WithSccDestinationSettings(SccDestinationSettings&& value) { SetSccDestinationSettings(std::move(value)); return *this;}
/**
* Settings for Teletext caption output
*/
inline const TeletextDestinationSettings& GetTeletextDestinationSettings() const{ return m_teletextDestinationSettings; }
/**
* Settings for Teletext caption output
*/
inline bool TeletextDestinationSettingsHasBeenSet() const { return m_teletextDestinationSettingsHasBeenSet; }
/**
* Settings for Teletext caption output
*/
inline void SetTeletextDestinationSettings(const TeletextDestinationSettings& value) { m_teletextDestinationSettingsHasBeenSet = true; m_teletextDestinationSettings = value; }
/**
* Settings for Teletext caption output
*/
inline void SetTeletextDestinationSettings(TeletextDestinationSettings&& value) { m_teletextDestinationSettingsHasBeenSet = true; m_teletextDestinationSettings = std::move(value); }
/**
* Settings for Teletext caption output
*/
inline CaptionDestinationSettings& WithTeletextDestinationSettings(const TeletextDestinationSettings& value) { SetTeletextDestinationSettings(value); return *this;}
/**
* Settings for Teletext caption output
*/
inline CaptionDestinationSettings& WithTeletextDestinationSettings(TeletextDestinationSettings&& value) { SetTeletextDestinationSettings(std::move(value)); return *this;}
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline const TtmlDestinationSettings& GetTtmlDestinationSettings() const{ return m_ttmlDestinationSettings; }
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline bool TtmlDestinationSettingsHasBeenSet() const { return m_ttmlDestinationSettingsHasBeenSet; }
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline void SetTtmlDestinationSettings(const TtmlDestinationSettings& value) { m_ttmlDestinationSettingsHasBeenSet = true; m_ttmlDestinationSettings = value; }
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline void SetTtmlDestinationSettings(TtmlDestinationSettings&& value) { m_ttmlDestinationSettingsHasBeenSet = true; m_ttmlDestinationSettings = std::move(value); }
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline CaptionDestinationSettings& WithTtmlDestinationSettings(const TtmlDestinationSettings& value) { SetTtmlDestinationSettings(value); return *this;}
/**
* Settings specific to TTML caption outputs, including Pass style information
* (TtmlStylePassthrough).
*/
inline CaptionDestinationSettings& WithTtmlDestinationSettings(TtmlDestinationSettings&& value) { SetTtmlDestinationSettings(std::move(value)); return *this;}
private:
BurninDestinationSettings m_burninDestinationSettings;
bool m_burninDestinationSettingsHasBeenSet;
CaptionDestinationType m_destinationType;
bool m_destinationTypeHasBeenSet;
DvbSubDestinationSettings m_dvbSubDestinationSettings;
bool m_dvbSubDestinationSettingsHasBeenSet;
EmbeddedDestinationSettings m_embeddedDestinationSettings;
bool m_embeddedDestinationSettingsHasBeenSet;
ImscDestinationSettings m_imscDestinationSettings;
bool m_imscDestinationSettingsHasBeenSet;
SccDestinationSettings m_sccDestinationSettings;
bool m_sccDestinationSettingsHasBeenSet;
TeletextDestinationSettings m_teletextDestinationSettings;
bool m_teletextDestinationSettingsHasBeenSet;
TtmlDestinationSettings m_ttmlDestinationSettings;
bool m_ttmlDestinationSettingsHasBeenSet;
};
} // namespace Model
} // namespace MediaConvert
} // namespace Aws