AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
StartStreamTranscriptionRequest.h
1
6#pragma once
7#include <aws/transcribestreaming/TranscribeStreamingService_EXPORTS.h>
8#include <aws/transcribestreaming/TranscribeStreamingServiceRequest.h>
9#include <aws/transcribestreaming/model/StartStreamTranscriptionHandler.h>
10#include <aws/core/utils/event/EventStreamDecoder.h>
11#include <memory>
12#include <aws/transcribestreaming/model/LanguageCode.h>
13#include <aws/transcribestreaming/model/MediaEncoding.h>
14#include <aws/core/utils/memory/stl/AWSString.h>
15#include <aws/transcribestreaming/model/AudioStream.h>
16#include <aws/transcribestreaming/model/VocabularyFilterMethod.h>
17#include <aws/transcribestreaming/model/PartialResultsStability.h>
18#include <aws/transcribestreaming/model/ContentIdentificationType.h>
19#include <aws/transcribestreaming/model/ContentRedactionType.h>
20#include <utility>
21
22namespace Aws
23{
24namespace TranscribeStreamingService
25{
26namespace Model
27{
28
32 {
33 public:
34 AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest();
35
36 // Service request name is the Operation name which will send this request out,
37 // each operation should has unique request name, so that we can get operation's name from this request.
38 // Note: this is not true for response, multiple operations may have the same response name,
39 // so we can not get operation's name from response.
40 inline virtual const char* GetServiceRequestName() const override { return "StartStreamTranscription"; }
41
42 inline virtual bool IsEventStreamRequest() const override { return true; }
43 // SerializePayload will not be invoked.
44 // This request is sent by encoding its data in event-streams which is sent as IOStream via GetBody()
45 AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::String SerializePayload() const override { return {}; }
46 AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr<Aws::IOStream> GetBody() const override;
47 AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
48
53
57 inline const StartStreamTranscriptionHandler& GetEventStreamHandler() const { return m_handler; }
58
62 inline void SetEventStreamHandler(const StartStreamTranscriptionHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
63
68
69
71
80 inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
81 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
82 inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
83 inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
85 inline StartStreamTranscriptionRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
87
89
95 inline int GetMediaSampleRateHertz() const{ return m_mediaSampleRateHertz; }
96 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
97 inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
100
102
110 inline const MediaEncoding& GetMediaEncoding() const{ return m_mediaEncoding; }
111 inline bool MediaEncodingHasBeenSet() const { return m_mediaEncodingHasBeenSet; }
112 inline void SetMediaEncoding(const MediaEncoding& value) { m_mediaEncodingHasBeenSet = true; m_mediaEncoding = value; }
113 inline void SetMediaEncoding(MediaEncoding&& value) { m_mediaEncodingHasBeenSet = true; m_mediaEncoding = std::move(value); }
115 inline StartStreamTranscriptionRequest& WithMediaEncoding(MediaEncoding&& value) { SetMediaEncoding(std::move(value)); return *this;}
117
119
133 inline const Aws::String& GetVocabularyName() const{ return m_vocabularyName; }
134 inline bool VocabularyNameHasBeenSet() const { return m_vocabularyNameHasBeenSet; }
135 inline void SetVocabularyName(const Aws::String& value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName = value; }
136 inline void SetVocabularyName(Aws::String&& value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName = std::move(value); }
137 inline void SetVocabularyName(const char* value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName.assign(value); }
139 inline StartStreamTranscriptionRequest& WithVocabularyName(Aws::String&& value) { SetVocabularyName(std::move(value)); return *this;}
140 inline StartStreamTranscriptionRequest& WithVocabularyName(const char* value) { SetVocabularyName(value); return *this;}
142
144
149 inline const Aws::String& GetSessionId() const{ return m_sessionId; }
150 inline bool SessionIdHasBeenSet() const { return m_sessionIdHasBeenSet; }
151 inline void SetSessionId(const Aws::String& value) { m_sessionIdHasBeenSet = true; m_sessionId = value; }
152 inline void SetSessionId(Aws::String&& value) { m_sessionIdHasBeenSet = true; m_sessionId = std::move(value); }
153 inline void SetSessionId(const char* value) { m_sessionIdHasBeenSet = true; m_sessionId.assign(value); }
154 inline StartStreamTranscriptionRequest& WithSessionId(const Aws::String& value) { SetSessionId(value); return *this;}
155 inline StartStreamTranscriptionRequest& WithSessionId(Aws::String&& value) { SetSessionId(std::move(value)); return *this;}
156 inline StartStreamTranscriptionRequest& WithSessionId(const char* value) { SetSessionId(value); return *this;}
158
160
166 AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr<AudioStream> GetAudioStream() const { return m_audioStream; }
167 AWS_TRANSCRIBESTREAMINGSERVICE_API void SetAudioStream(const std::shared_ptr<AudioStream>& value) { m_audioStream = value; }
168 AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest& WithAudioStream(const std::shared_ptr<AudioStream>& value) { SetAudioStream(value); return *this;}
169
171
173
187 inline const Aws::String& GetVocabularyFilterName() const{ return m_vocabularyFilterName; }
188 inline bool VocabularyFilterNameHasBeenSet() const { return m_vocabularyFilterNameHasBeenSet; }
189 inline void SetVocabularyFilterName(const Aws::String& value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName = value; }
190 inline void SetVocabularyFilterName(Aws::String&& value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName = std::move(value); }
191 inline void SetVocabularyFilterName(const char* value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName.assign(value); }
194 inline StartStreamTranscriptionRequest& WithVocabularyFilterName(const char* value) { SetVocabularyFilterName(value); return *this;}
196
198
204 inline const VocabularyFilterMethod& GetVocabularyFilterMethod() const{ return m_vocabularyFilterMethod; }
205 inline bool VocabularyFilterMethodHasBeenSet() const { return m_vocabularyFilterMethodHasBeenSet; }
206 inline void SetVocabularyFilterMethod(const VocabularyFilterMethod& value) { m_vocabularyFilterMethodHasBeenSet = true; m_vocabularyFilterMethod = value; }
207 inline void SetVocabularyFilterMethod(VocabularyFilterMethod&& value) { m_vocabularyFilterMethodHasBeenSet = true; m_vocabularyFilterMethod = std::move(value); }
211
213
220 inline bool GetShowSpeakerLabel() const{ return m_showSpeakerLabel; }
221 inline bool ShowSpeakerLabelHasBeenSet() const { return m_showSpeakerLabelHasBeenSet; }
222 inline void SetShowSpeakerLabel(bool value) { m_showSpeakerLabelHasBeenSet = true; m_showSpeakerLabel = value; }
225
227
239 inline bool GetEnableChannelIdentification() const{ return m_enableChannelIdentification; }
240 inline bool EnableChannelIdentificationHasBeenSet() const { return m_enableChannelIdentificationHasBeenSet; }
241 inline void SetEnableChannelIdentification(bool value) { m_enableChannelIdentificationHasBeenSet = true; m_enableChannelIdentification = value; }
244
246
253 inline int GetNumberOfChannels() const{ return m_numberOfChannels; }
254 inline bool NumberOfChannelsHasBeenSet() const { return m_numberOfChannelsHasBeenSet; }
255 inline void SetNumberOfChannels(int value) { m_numberOfChannelsHasBeenSet = true; m_numberOfChannels = value; }
258
260
267 inline bool GetEnablePartialResultsStabilization() const{ return m_enablePartialResultsStabilization; }
268 inline bool EnablePartialResultsStabilizationHasBeenSet() const { return m_enablePartialResultsStabilizationHasBeenSet; }
269 inline void SetEnablePartialResultsStabilization(bool value) { m_enablePartialResultsStabilizationHasBeenSet = true; m_enablePartialResultsStabilization = value; }
272
274
282 inline const PartialResultsStability& GetPartialResultsStability() const{ return m_partialResultsStability; }
283 inline bool PartialResultsStabilityHasBeenSet() const { return m_partialResultsStabilityHasBeenSet; }
284 inline void SetPartialResultsStability(const PartialResultsStability& value) { m_partialResultsStabilityHasBeenSet = true; m_partialResultsStability = value; }
285 inline void SetPartialResultsStability(PartialResultsStability&& value) { m_partialResultsStabilityHasBeenSet = true; m_partialResultsStability = std::move(value); }
289
291
303 inline const ContentIdentificationType& GetContentIdentificationType() const{ return m_contentIdentificationType; }
304 inline bool ContentIdentificationTypeHasBeenSet() const { return m_contentIdentificationTypeHasBeenSet; }
305 inline void SetContentIdentificationType(const ContentIdentificationType& value) { m_contentIdentificationTypeHasBeenSet = true; m_contentIdentificationType = value; }
306 inline void SetContentIdentificationType(ContentIdentificationType&& value) { m_contentIdentificationTypeHasBeenSet = true; m_contentIdentificationType = std::move(value); }
310
312
324 inline const ContentRedactionType& GetContentRedactionType() const{ return m_contentRedactionType; }
325 inline bool ContentRedactionTypeHasBeenSet() const { return m_contentRedactionTypeHasBeenSet; }
326 inline void SetContentRedactionType(const ContentRedactionType& value) { m_contentRedactionTypeHasBeenSet = true; m_contentRedactionType = value; }
327 inline void SetContentRedactionType(ContentRedactionType&& value) { m_contentRedactionTypeHasBeenSet = true; m_contentRedactionType = std::move(value); }
331
333
348 inline const Aws::String& GetPiiEntityTypes() const{ return m_piiEntityTypes; }
349 inline bool PiiEntityTypesHasBeenSet() const { return m_piiEntityTypesHasBeenSet; }
350 inline void SetPiiEntityTypes(const Aws::String& value) { m_piiEntityTypesHasBeenSet = true; m_piiEntityTypes = value; }
351 inline void SetPiiEntityTypes(Aws::String&& value) { m_piiEntityTypesHasBeenSet = true; m_piiEntityTypes = std::move(value); }
352 inline void SetPiiEntityTypes(const char* value) { m_piiEntityTypesHasBeenSet = true; m_piiEntityTypes.assign(value); }
354 inline StartStreamTranscriptionRequest& WithPiiEntityTypes(Aws::String&& value) { SetPiiEntityTypes(std::move(value)); return *this;}
355 inline StartStreamTranscriptionRequest& WithPiiEntityTypes(const char* value) { SetPiiEntityTypes(value); return *this;}
357
359
369 inline const Aws::String& GetLanguageModelName() const{ return m_languageModelName; }
370 inline bool LanguageModelNameHasBeenSet() const { return m_languageModelNameHasBeenSet; }
371 inline void SetLanguageModelName(const Aws::String& value) { m_languageModelNameHasBeenSet = true; m_languageModelName = value; }
372 inline void SetLanguageModelName(Aws::String&& value) { m_languageModelNameHasBeenSet = true; m_languageModelName = std::move(value); }
373 inline void SetLanguageModelName(const char* value) { m_languageModelNameHasBeenSet = true; m_languageModelName.assign(value); }
376 inline StartStreamTranscriptionRequest& WithLanguageModelName(const char* value) { SetLanguageModelName(value); return *this;}
378
380
396 inline bool GetIdentifyLanguage() const{ return m_identifyLanguage; }
397 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
398 inline void SetIdentifyLanguage(bool value) { m_identifyLanguageHasBeenSet = true; m_identifyLanguage = value; }
401
403
416 inline const Aws::String& GetLanguageOptions() const{ return m_languageOptions; }
417 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
418 inline void SetLanguageOptions(const Aws::String& value) { m_languageOptionsHasBeenSet = true; m_languageOptions = value; }
419 inline void SetLanguageOptions(Aws::String&& value) { m_languageOptionsHasBeenSet = true; m_languageOptions = std::move(value); }
420 inline void SetLanguageOptions(const char* value) { m_languageOptionsHasBeenSet = true; m_languageOptions.assign(value); }
422 inline StartStreamTranscriptionRequest& WithLanguageOptions(Aws::String&& value) { SetLanguageOptions(std::move(value)); return *this;}
423 inline StartStreamTranscriptionRequest& WithLanguageOptions(const char* value) { SetLanguageOptions(value); return *this;}
425
427
433 inline const LanguageCode& GetPreferredLanguage() const{ return m_preferredLanguage; }
434 inline bool PreferredLanguageHasBeenSet() const { return m_preferredLanguageHasBeenSet; }
435 inline void SetPreferredLanguage(const LanguageCode& value) { m_preferredLanguageHasBeenSet = true; m_preferredLanguage = value; }
436 inline void SetPreferredLanguage(LanguageCode&& value) { m_preferredLanguageHasBeenSet = true; m_preferredLanguage = std::move(value); }
440
442
456 inline bool GetIdentifyMultipleLanguages() const{ return m_identifyMultipleLanguages; }
457 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
458 inline void SetIdentifyMultipleLanguages(bool value) { m_identifyMultipleLanguagesHasBeenSet = true; m_identifyMultipleLanguages = value; }
461
463
476 inline const Aws::String& GetVocabularyNames() const{ return m_vocabularyNames; }
477 inline bool VocabularyNamesHasBeenSet() const { return m_vocabularyNamesHasBeenSet; }
478 inline void SetVocabularyNames(const Aws::String& value) { m_vocabularyNamesHasBeenSet = true; m_vocabularyNames = value; }
479 inline void SetVocabularyNames(Aws::String&& value) { m_vocabularyNamesHasBeenSet = true; m_vocabularyNames = std::move(value); }
480 inline void SetVocabularyNames(const char* value) { m_vocabularyNamesHasBeenSet = true; m_vocabularyNames.assign(value); }
482 inline StartStreamTranscriptionRequest& WithVocabularyNames(Aws::String&& value) { SetVocabularyNames(std::move(value)); return *this;}
483 inline StartStreamTranscriptionRequest& WithVocabularyNames(const char* value) { SetVocabularyNames(value); return *this;}
485
487
501 inline const Aws::String& GetVocabularyFilterNames() const{ return m_vocabularyFilterNames; }
502 inline bool VocabularyFilterNamesHasBeenSet() const { return m_vocabularyFilterNamesHasBeenSet; }
503 inline void SetVocabularyFilterNames(const Aws::String& value) { m_vocabularyFilterNamesHasBeenSet = true; m_vocabularyFilterNames = value; }
504 inline void SetVocabularyFilterNames(Aws::String&& value) { m_vocabularyFilterNamesHasBeenSet = true; m_vocabularyFilterNames = std::move(value); }
505 inline void SetVocabularyFilterNames(const char* value) { m_vocabularyFilterNamesHasBeenSet = true; m_vocabularyFilterNames.assign(value); }
510 private:
511
512 LanguageCode m_languageCode;
513 bool m_languageCodeHasBeenSet = false;
514
515 int m_mediaSampleRateHertz;
516 bool m_mediaSampleRateHertzHasBeenSet = false;
517
518 MediaEncoding m_mediaEncoding;
519 bool m_mediaEncodingHasBeenSet = false;
520
521 Aws::String m_vocabularyName;
522 bool m_vocabularyNameHasBeenSet = false;
523
524 Aws::String m_sessionId;
525 bool m_sessionIdHasBeenSet = false;
526
527 std::shared_ptr<AudioStream> m_audioStream;
528
529 Aws::String m_vocabularyFilterName;
530 bool m_vocabularyFilterNameHasBeenSet = false;
531
532 VocabularyFilterMethod m_vocabularyFilterMethod;
533 bool m_vocabularyFilterMethodHasBeenSet = false;
534
535 bool m_showSpeakerLabel;
536 bool m_showSpeakerLabelHasBeenSet = false;
537
538 bool m_enableChannelIdentification;
539 bool m_enableChannelIdentificationHasBeenSet = false;
540
541 int m_numberOfChannels;
542 bool m_numberOfChannelsHasBeenSet = false;
543
544 bool m_enablePartialResultsStabilization;
545 bool m_enablePartialResultsStabilizationHasBeenSet = false;
546
547 PartialResultsStability m_partialResultsStability;
548 bool m_partialResultsStabilityHasBeenSet = false;
549
550 ContentIdentificationType m_contentIdentificationType;
551 bool m_contentIdentificationTypeHasBeenSet = false;
552
553 ContentRedactionType m_contentRedactionType;
554 bool m_contentRedactionTypeHasBeenSet = false;
555
556 Aws::String m_piiEntityTypes;
557 bool m_piiEntityTypesHasBeenSet = false;
558
559 Aws::String m_languageModelName;
560 bool m_languageModelNameHasBeenSet = false;
561
562 bool m_identifyLanguage;
563 bool m_identifyLanguageHasBeenSet = false;
564
565 Aws::String m_languageOptions;
566 bool m_languageOptionsHasBeenSet = false;
567
568 LanguageCode m_preferredLanguage;
569 bool m_preferredLanguageHasBeenSet = false;
570
571 bool m_identifyMultipleLanguages;
572 bool m_identifyMultipleLanguagesHasBeenSet = false;
573
574 Aws::String m_vocabularyNames;
575 bool m_vocabularyNamesHasBeenSet = false;
576
577 Aws::String m_vocabularyFilterNames;
578 bool m_vocabularyFilterNamesHasBeenSet = false;
581
582 };
583
584} // namespace Model
585} // namespace TranscribeStreamingService
586} // namespace Aws
StartStreamTranscriptionRequest & WithContentIdentificationType(const ContentIdentificationType &value)
StartStreamTranscriptionRequest & WithVocabularyName(const Aws::String &value)
AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
StartStreamTranscriptionRequest & WithVocabularyFilterName(Aws::String &&value)
StartStreamTranscriptionRequest & WithContentIdentificationType(ContentIdentificationType &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest & WithAudioStream(const std::shared_ptr< AudioStream > &value)
StartStreamTranscriptionRequest & WithMediaEncoding(const MediaEncoding &value)
StartStreamTranscriptionRequest & WithPreferredLanguage(LanguageCode &&value)
StartStreamTranscriptionRequest & WithVocabularyFilterName(const Aws::String &value)
StartStreamTranscriptionRequest & WithLanguageCode(const LanguageCode &value)
StartStreamTranscriptionRequest & WithPreferredLanguage(const LanguageCode &value)
StartStreamTranscriptionRequest & WithPiiEntityTypes(const Aws::String &value)
AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::String SerializePayload() const override
StartStreamTranscriptionRequest & WithVocabularyFilterMethod(VocabularyFilterMethod &&value)
StartStreamTranscriptionRequest & WithPartialResultsStability(PartialResultsStability &&value)
StartStreamTranscriptionRequest & WithMediaEncoding(MediaEncoding &&value)
StartStreamTranscriptionRequest & WithVocabularyFilterNames(const Aws::String &value)
StartStreamTranscriptionRequest & WithContentRedactionType(ContentRedactionType &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API void SetAudioStream(const std::shared_ptr< AudioStream > &value)
StartStreamTranscriptionRequest & WithEventStreamHandler(const StartStreamTranscriptionHandler &value)
StartStreamTranscriptionRequest & WithVocabularyNames(const Aws::String &value)
StartStreamTranscriptionRequest & WithLanguageModelName(const Aws::String &value)
AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr< Aws::IOStream > GetBody() const override
StartStreamTranscriptionRequest & WithContentRedactionType(const ContentRedactionType &value)
StartStreamTranscriptionRequest & WithSessionId(const Aws::String &value)
StartStreamTranscriptionRequest & WithVocabularyFilterMethod(const VocabularyFilterMethod &value)
AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr< AudioStream > GetAudioStream() const
StartStreamTranscriptionRequest & WithLanguageOptions(const Aws::String &value)
StartStreamTranscriptionRequest & WithVocabularyFilterNames(Aws::String &&value)
StartStreamTranscriptionRequest & WithPartialResultsStability(const PartialResultsStability &value)
void ResetEventStreamHandler(EventStreamHandler *handler)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String