pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-medialive/include/aws/medialive/model/EbuTtDDestinationSettings.h

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/medialive/MediaLive_EXPORTS.h>
#include <aws/medialive/model/EbuTtDFillLineGapControl.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/medialive/model/EbuTtDDestinationStyleControl.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace MediaLive
{
namespace Model
{

  /**
   * Ebu Tt DDestination Settings<p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/EbuTtDDestinationSettings">AWS
   * API Reference</a></p>
   */
  class AWS_MEDIALIVE_API EbuTtDDestinationSettings
  {
  public:
    EbuTtDDestinationSettings();
    EbuTtDDestinationSettings(Aws::Utils::Json::JsonView jsonValue);
    EbuTtDDestinationSettings& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline const EbuTtDFillLineGapControl& GetFillLineGap() const{ return m_fillLineGap; }

    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline bool FillLineGapHasBeenSet() const { return m_fillLineGapHasBeenSet; }

    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline void SetFillLineGap(const EbuTtDFillLineGapControl& value) { m_fillLineGapHasBeenSet = true; m_fillLineGap = value; }

    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline void SetFillLineGap(EbuTtDFillLineGapControl&& value) { m_fillLineGapHasBeenSet = true; m_fillLineGap = std::move(value); }

    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline EbuTtDDestinationSettings& WithFillLineGap(const EbuTtDFillLineGapControl& value) { SetFillLineGap(value); return *this;}

    /**
     * Specifies how to handle the gap between the lines (in multi-line captions).

-
     * enabled: Fill with the captions background color (as specified in the input
     * captions).
- disabled: Leave the gap unfilled.
     */
    inline EbuTtDDestinationSettings& WithFillLineGap(EbuTtDFillLineGapControl&& value) { SetFillLineGap(std::move(value)); return *this;}


    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline const Aws::String& GetFontFamily() const{ return m_fontFamily; }

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline bool FontFamilyHasBeenSet() const { return m_fontFamilyHasBeenSet; }

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline void SetFontFamily(const Aws::String& value) { m_fontFamilyHasBeenSet = true; m_fontFamily = value; }

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline void SetFontFamily(Aws::String&& value) { m_fontFamilyHasBeenSet = true; m_fontFamily = std::move(value); }

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline void SetFontFamily(const char* value) { m_fontFamilyHasBeenSet = true; m_fontFamily.assign(value); }

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline EbuTtDDestinationSettings& WithFontFamily(const Aws::String& value) { SetFontFamily(value); return *this;}

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline EbuTtDDestinationSettings& WithFontFamily(Aws::String&& value) { SetFontFamily(std::move(value)); return *this;}

    /**
     * Specifies the font family to include in the font data attached to the EBU-TT
     * captions. Valid only if styleControl is set to include. If you leave this field
     * empty, the font family is set to "monospaced". (If styleControl is set to
     * exclude, the font family is always set to "monospaced".)

You specify only the
     * font family. All other style information (color, bold, position and so on) is
     * copied from the input captions. The size is always set to 100% to allow the
     * downstream player to choose the size.

- Enter a list of font families, as a
     * comma-separated list of font names, in order of preference. The name can be a
     * font family (such as “Arial”), or a generic font family (such as “serif”), or
     * “default” (to let the downstream player choose the font).
- Leave blank to set
     * the family to “monospace”.
     */
    inline EbuTtDDestinationSettings& WithFontFamily(const char* value) { SetFontFamily(value); return *this;}


    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline const EbuTtDDestinationStyleControl& GetStyleControl() const{ return m_styleControl; }

    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline bool StyleControlHasBeenSet() const { return m_styleControlHasBeenSet; }

    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline void SetStyleControl(const EbuTtDDestinationStyleControl& value) { m_styleControlHasBeenSet = true; m_styleControl = value; }

    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline void SetStyleControl(EbuTtDDestinationStyleControl&& value) { m_styleControlHasBeenSet = true; m_styleControl = std::move(value); }

    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline EbuTtDDestinationSettings& WithStyleControl(const EbuTtDDestinationStyleControl& value) { SetStyleControl(value); return *this;}

    /**
     * Specifies the style information (font color, font position, and so on) to
     * include in the font data that is attached to the EBU-TT captions.

- include:
     * Take the style information (font color, font position, and so on) from the
     * source captions and include that information in the font data attached to the
     * EBU-TT captions. This option is valid only if the source captions are Embedded
     * or Teletext.
- exclude: In the font data attached to the EBU-TT captions, set
     * the font family to "monospaced". Do not include any other style information.
     */
    inline EbuTtDDestinationSettings& WithStyleControl(EbuTtDDestinationStyleControl&& value) { SetStyleControl(std::move(value)); return *this;}

  private:

    EbuTtDFillLineGapControl m_fillLineGap;
    bool m_fillLineGapHasBeenSet;

    Aws::String m_fontFamily;
    bool m_fontFamilyHasBeenSet;

    EbuTtDDestinationStyleControl m_styleControl;
    bool m_styleControlHasBeenSet;
  };

} // namespace Model
} // namespace MediaLive
} // namespace Aws