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/CaptionSourceSettings.h

328 lines
13 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/AncillarySourceSettings.h>
#include <aws/mediaconvert/model/DvbSubSourceSettings.h>
#include <aws/mediaconvert/model/EmbeddedSourceSettings.h>
#include <aws/mediaconvert/model/FileSourceSettings.h>
#include <aws/mediaconvert/model/CaptionSourceType.h>
#include <aws/mediaconvert/model/TeletextSourceSettings.h>
#include <aws/mediaconvert/model/TrackSourceSettings.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace MediaConvert
{
namespace Model
{
/**
* If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file,
* specify the URI of the input captions source file. If your input captions are
* IMSC in an IMF package, use TrackSourceSettings instead of
* FileSoureSettings.<p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/CaptionSourceSettings">AWS
* API Reference</a></p>
*/
class AWS_MEDIACONVERT_API CaptionSourceSettings
{
public:
CaptionSourceSettings();
CaptionSourceSettings(Aws::Utils::Json::JsonView jsonValue);
CaptionSourceSettings& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* Settings for ancillary captions source.
*/
inline const AncillarySourceSettings& GetAncillarySourceSettings() const{ return m_ancillarySourceSettings; }
/**
* Settings for ancillary captions source.
*/
inline bool AncillarySourceSettingsHasBeenSet() const { return m_ancillarySourceSettingsHasBeenSet; }
/**
* Settings for ancillary captions source.
*/
inline void SetAncillarySourceSettings(const AncillarySourceSettings& value) { m_ancillarySourceSettingsHasBeenSet = true; m_ancillarySourceSettings = value; }
/**
* Settings for ancillary captions source.
*/
inline void SetAncillarySourceSettings(AncillarySourceSettings&& value) { m_ancillarySourceSettingsHasBeenSet = true; m_ancillarySourceSettings = std::move(value); }
/**
* Settings for ancillary captions source.
*/
inline CaptionSourceSettings& WithAncillarySourceSettings(const AncillarySourceSettings& value) { SetAncillarySourceSettings(value); return *this;}
/**
* Settings for ancillary captions source.
*/
inline CaptionSourceSettings& WithAncillarySourceSettings(AncillarySourceSettings&& value) { SetAncillarySourceSettings(std::move(value)); return *this;}
/**
* DVB Sub Source Settings
*/
inline const DvbSubSourceSettings& GetDvbSubSourceSettings() const{ return m_dvbSubSourceSettings; }
/**
* DVB Sub Source Settings
*/
inline bool DvbSubSourceSettingsHasBeenSet() const { return m_dvbSubSourceSettingsHasBeenSet; }
/**
* DVB Sub Source Settings
*/
inline void SetDvbSubSourceSettings(const DvbSubSourceSettings& value) { m_dvbSubSourceSettingsHasBeenSet = true; m_dvbSubSourceSettings = value; }
/**
* DVB Sub Source Settings
*/
inline void SetDvbSubSourceSettings(DvbSubSourceSettings&& value) { m_dvbSubSourceSettingsHasBeenSet = true; m_dvbSubSourceSettings = std::move(value); }
/**
* DVB Sub Source Settings
*/
inline CaptionSourceSettings& WithDvbSubSourceSettings(const DvbSubSourceSettings& value) { SetDvbSubSourceSettings(value); return *this;}
/**
* DVB Sub Source Settings
*/
inline CaptionSourceSettings& WithDvbSubSourceSettings(DvbSubSourceSettings&& value) { SetDvbSubSourceSettings(std::move(value)); return *this;}
/**
* Settings for embedded captions Source
*/
inline const EmbeddedSourceSettings& GetEmbeddedSourceSettings() const{ return m_embeddedSourceSettings; }
/**
* Settings for embedded captions Source
*/
inline bool EmbeddedSourceSettingsHasBeenSet() const { return m_embeddedSourceSettingsHasBeenSet; }
/**
* Settings for embedded captions Source
*/
inline void SetEmbeddedSourceSettings(const EmbeddedSourceSettings& value) { m_embeddedSourceSettingsHasBeenSet = true; m_embeddedSourceSettings = value; }
/**
* Settings for embedded captions Source
*/
inline void SetEmbeddedSourceSettings(EmbeddedSourceSettings&& value) { m_embeddedSourceSettingsHasBeenSet = true; m_embeddedSourceSettings = std::move(value); }
/**
* Settings for embedded captions Source
*/
inline CaptionSourceSettings& WithEmbeddedSourceSettings(const EmbeddedSourceSettings& value) { SetEmbeddedSourceSettings(value); return *this;}
/**
* Settings for embedded captions Source
*/
inline CaptionSourceSettings& WithEmbeddedSourceSettings(EmbeddedSourceSettings&& value) { SetEmbeddedSourceSettings(std::move(value)); return *this;}
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline const FileSourceSettings& GetFileSourceSettings() const{ return m_fileSourceSettings; }
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline bool FileSourceSettingsHasBeenSet() const { return m_fileSourceSettingsHasBeenSet; }
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline void SetFileSourceSettings(const FileSourceSettings& value) { m_fileSourceSettingsHasBeenSet = true; m_fileSourceSettings = value; }
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline void SetFileSourceSettings(FileSourceSettings&& value) { m_fileSourceSettingsHasBeenSet = true; m_fileSourceSettings = std::move(value); }
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline CaptionSourceSettings& WithFileSourceSettings(const FileSourceSettings& value) { SetFileSourceSettings(value); return *this;}
/**
* If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file,
* specify the URI of the input caption source file. If your caption source is IMSC
* in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
*/
inline CaptionSourceSettings& WithFileSourceSettings(FileSourceSettings&& value) { SetFileSourceSettings(std::move(value)); return *this;}
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline const CaptionSourceType& GetSourceType() const{ return m_sourceType; }
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; }
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline void SetSourceType(const CaptionSourceType& value) { m_sourceTypeHasBeenSet = true; m_sourceType = value; }
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline void SetSourceType(CaptionSourceType&& value) { m_sourceTypeHasBeenSet = true; m_sourceType = std::move(value); }
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline CaptionSourceSettings& WithSourceType(const CaptionSourceType& value) { SetSourceType(value); return *this;}
/**
* Use Source (SourceType) to identify the format of your input captions. The
* service cannot auto-detect caption format.
*/
inline CaptionSourceSettings& WithSourceType(CaptionSourceType&& value) { SetSourceType(std::move(value)); return *this;}
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline const TeletextSourceSettings& GetTeletextSourceSettings() const{ return m_teletextSourceSettings; }
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline bool TeletextSourceSettingsHasBeenSet() const { return m_teletextSourceSettingsHasBeenSet; }
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline void SetTeletextSourceSettings(const TeletextSourceSettings& value) { m_teletextSourceSettingsHasBeenSet = true; m_teletextSourceSettings = value; }
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline void SetTeletextSourceSettings(TeletextSourceSettings&& value) { m_teletextSourceSettingsHasBeenSet = true; m_teletextSourceSettings = std::move(value); }
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline CaptionSourceSettings& WithTeletextSourceSettings(const TeletextSourceSettings& value) { SetTeletextSourceSettings(value); return *this;}
/**
* Settings specific to Teletext caption sources, including Page number.
*/
inline CaptionSourceSettings& WithTeletextSourceSettings(TeletextSourceSettings&& value) { SetTeletextSourceSettings(std::move(value)); return *this;}
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline const TrackSourceSettings& GetTrackSourceSettings() const{ return m_trackSourceSettings; }
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline bool TrackSourceSettingsHasBeenSet() const { return m_trackSourceSettingsHasBeenSet; }
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline void SetTrackSourceSettings(const TrackSourceSettings& value) { m_trackSourceSettingsHasBeenSet = true; m_trackSourceSettings = value; }
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline void SetTrackSourceSettings(TrackSourceSettings&& value) { m_trackSourceSettingsHasBeenSet = true; m_trackSourceSettings = std::move(value); }
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline CaptionSourceSettings& WithTrackSourceSettings(const TrackSourceSettings& value) { SetTrackSourceSettings(value); return *this;}
/**
* Settings specific to caption sources that are specified by track number.
* Currently, this is only IMSC captions in an IMF package. If your caption source
* is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
* TrackSourceSettings.
*/
inline CaptionSourceSettings& WithTrackSourceSettings(TrackSourceSettings&& value) { SetTrackSourceSettings(std::move(value)); return *this;}
private:
AncillarySourceSettings m_ancillarySourceSettings;
bool m_ancillarySourceSettingsHasBeenSet;
DvbSubSourceSettings m_dvbSubSourceSettings;
bool m_dvbSubSourceSettingsHasBeenSet;
EmbeddedSourceSettings m_embeddedSourceSettings;
bool m_embeddedSourceSettingsHasBeenSet;
FileSourceSettings m_fileSourceSettings;
bool m_fileSourceSettingsHasBeenSet;
CaptionSourceType m_sourceType;
bool m_sourceTypeHasBeenSet;
TeletextSourceSettings m_teletextSourceSettings;
bool m_teletextSourceSettingsHasBeenSet;
TrackSourceSettings m_trackSourceSettings;
bool m_trackSourceSettingsHasBeenSet;
};
} // namespace Model
} // namespace MediaConvert
} // namespace Aws