/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeService { namespace Model { /** *

Provides information about your subtitle file, including format, start index, * and Amazon S3 location.

See Also:

AWS * API Reference

*/ class SubtitlesOutput { public: AWS_TRANSCRIBESERVICE_API SubtitlesOutput(); AWS_TRANSCRIBESERVICE_API SubtitlesOutput(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API SubtitlesOutput& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline const Aws::Vector& GetFormats() const{ return m_formats; } /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline bool FormatsHasBeenSet() const { return m_formatsHasBeenSet; } /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline void SetFormats(const Aws::Vector& value) { m_formatsHasBeenSet = true; m_formats = value; } /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline void SetFormats(Aws::Vector&& value) { m_formatsHasBeenSet = true; m_formats = std::move(value); } /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline SubtitlesOutput& WithFormats(const Aws::Vector& value) { SetFormats(value); return *this;} /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline SubtitlesOutput& WithFormats(Aws::Vector&& value) { SetFormats(std::move(value)); return *this;} /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline SubtitlesOutput& AddFormats(const SubtitleFormat& value) { m_formatsHasBeenSet = true; m_formats.push_back(value); return *this; } /** *

Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both formats * are shown.

*/ inline SubtitlesOutput& AddFormats(SubtitleFormat&& value) { m_formatsHasBeenSet = true; m_formats.push_back(std::move(value)); return *this; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline const Aws::Vector& GetSubtitleFileUris() const{ return m_subtitleFileUris; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline bool SubtitleFileUrisHasBeenSet() const { return m_subtitleFileUrisHasBeenSet; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline void SetSubtitleFileUris(const Aws::Vector& value) { m_subtitleFileUrisHasBeenSet = true; m_subtitleFileUris = value; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline void SetSubtitleFileUris(Aws::Vector&& value) { m_subtitleFileUrisHasBeenSet = true; m_subtitleFileUris = std::move(value); } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline SubtitlesOutput& WithSubtitleFileUris(const Aws::Vector& value) { SetSubtitleFileUris(value); return *this;} /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline SubtitlesOutput& WithSubtitleFileUris(Aws::Vector&& value) { SetSubtitleFileUris(std::move(value)); return *this;} /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline SubtitlesOutput& AddSubtitleFileUris(const Aws::String& value) { m_subtitleFileUrisHasBeenSet = true; m_subtitleFileUris.push_back(value); return *this; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline SubtitlesOutput& AddSubtitleFileUris(Aws::String&& value) { m_subtitleFileUrisHasBeenSet = true; m_subtitleFileUris.push_back(std::move(value)); return *this; } /** *

The Amazon S3 location of your transcript. You can use this URI to access or * download your subtitle file. Your subtitle file is stored in the same location * as your transcript. If you specified both WebVTT and SubRip subtitle formats, * two URIs are provided.

If you included OutputBucketName in * your transcription job request, this is the URI of that bucket. If you also * included OutputKey in your request, your output is located in the * path you specified in your request.

If you didn't include * OutputBucketName in your transcription job request, your subtitle * file is stored in a service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access to your subtitle * file.

Temporary URIs for service-managed Amazon S3 buckets are * only valid for 15 minutes. If you get an AccesDenied error, you can * get a new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request.

*/ inline SubtitlesOutput& AddSubtitleFileUris(const char* value) { m_subtitleFileUrisHasBeenSet = true; m_subtitleFileUris.push_back(value); return *this; } /** *

Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used.

*/ inline int GetOutputStartIndex() const{ return m_outputStartIndex; } /** *

Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used.

*/ inline bool OutputStartIndexHasBeenSet() const { return m_outputStartIndexHasBeenSet; } /** *

Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used.

*/ inline void SetOutputStartIndex(int value) { m_outputStartIndexHasBeenSet = true; m_outputStartIndex = value; } /** *

Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used.

*/ inline SubtitlesOutput& WithOutputStartIndex(int value) { SetOutputStartIndex(value); return *this;} private: Aws::Vector m_formats; bool m_formatsHasBeenSet = false; Aws::Vector m_subtitleFileUris; bool m_subtitleFileUrisHasBeenSet = false; int m_outputStartIndex; bool m_outputStartIndexHasBeenSet = false; }; } // namespace Model } // namespace TranscribeService } // namespace Aws