AWS SDK for C++

AWS SDK for C++ Version 1.11.606

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() = default;
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 inline virtual bool HasEventStreamResponse() const override { return true; }
44 // SerializePayload will not be invoked.
45 // This request is sent by encoding its data in event-streams which is sent as IOStream via GetBody()
46 AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::String SerializePayload() const override { return {}; }
47 AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr<Aws::IOStream> GetBody() const override;
48 AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
49
54
59
63 inline void SetEventStreamHandler(const StartStreamTranscriptionHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
64
69
70
72
81 inline LanguageCode GetLanguageCode() const { return m_languageCode; }
82 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
83 inline void SetLanguageCode(LanguageCode value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
86
88
94 inline int GetMediaSampleRateHertz() const { return m_mediaSampleRateHertz; }
95 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
96 inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
99
101
109 inline MediaEncoding GetMediaEncoding() const { return m_mediaEncoding; }
110 inline bool MediaEncodingHasBeenSet() const { return m_mediaEncodingHasBeenSet; }
111 inline void SetMediaEncoding(MediaEncoding value) { m_mediaEncodingHasBeenSet = true; m_mediaEncoding = value; }
114
116
130 inline const Aws::String& GetVocabularyName() const { return m_vocabularyName; }
131 inline bool VocabularyNameHasBeenSet() const { return m_vocabularyNameHasBeenSet; }
132 template<typename VocabularyNameT = Aws::String>
133 void SetVocabularyName(VocabularyNameT&& value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName = std::forward<VocabularyNameT>(value); }
134 template<typename VocabularyNameT = Aws::String>
135 StartStreamTranscriptionRequest& WithVocabularyName(VocabularyNameT&& value) { SetVocabularyName(std::forward<VocabularyNameT>(value)); return *this;}
137
139
144 inline const Aws::String& GetSessionId() const { return m_sessionId; }
145 inline bool SessionIdHasBeenSet() const { return m_sessionIdHasBeenSet; }
146 template<typename SessionIdT = Aws::String>
147 void SetSessionId(SessionIdT&& value) { m_sessionIdHasBeenSet = true; m_sessionId = std::forward<SessionIdT>(value); }
148 template<typename SessionIdT = Aws::String>
149 StartStreamTranscriptionRequest& WithSessionId(SessionIdT&& value) { SetSessionId(std::forward<SessionIdT>(value)); return *this;}
151
153
159 AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr<AudioStream> GetAudioStream() const { return m_audioStream; }
160 AWS_TRANSCRIBESTREAMINGSERVICE_API void SetAudioStream(const std::shared_ptr<AudioStream>& value) { m_audioStreamHasBeenSet = true; m_audioStream = value; }
161 AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest& WithAudioStream(const std::shared_ptr<AudioStream>& value) { SetAudioStream(value); return *this;}
162
164
166
180 inline const Aws::String& GetVocabularyFilterName() const { return m_vocabularyFilterName; }
181 inline bool VocabularyFilterNameHasBeenSet() const { return m_vocabularyFilterNameHasBeenSet; }
182 template<typename VocabularyFilterNameT = Aws::String>
183 void SetVocabularyFilterName(VocabularyFilterNameT&& value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName = std::forward<VocabularyFilterNameT>(value); }
184 template<typename VocabularyFilterNameT = Aws::String>
185 StartStreamTranscriptionRequest& WithVocabularyFilterName(VocabularyFilterNameT&& value) { SetVocabularyFilterName(std::forward<VocabularyFilterNameT>(value)); return *this;}
187
189
195 inline VocabularyFilterMethod GetVocabularyFilterMethod() const { return m_vocabularyFilterMethod; }
196 inline bool VocabularyFilterMethodHasBeenSet() const { return m_vocabularyFilterMethodHasBeenSet; }
197 inline void SetVocabularyFilterMethod(VocabularyFilterMethod value) { m_vocabularyFilterMethodHasBeenSet = true; m_vocabularyFilterMethod = value; }
200
202
209 inline bool GetShowSpeakerLabel() const { return m_showSpeakerLabel; }
210 inline bool ShowSpeakerLabelHasBeenSet() const { return m_showSpeakerLabelHasBeenSet; }
211 inline void SetShowSpeakerLabel(bool value) { m_showSpeakerLabelHasBeenSet = true; m_showSpeakerLabel = value; }
214
216
228 inline bool GetEnableChannelIdentification() const { return m_enableChannelIdentification; }
229 inline bool EnableChannelIdentificationHasBeenSet() const { return m_enableChannelIdentificationHasBeenSet; }
230 inline void SetEnableChannelIdentification(bool value) { m_enableChannelIdentificationHasBeenSet = true; m_enableChannelIdentification = value; }
233
235
242 inline int GetNumberOfChannels() const { return m_numberOfChannels; }
243 inline bool NumberOfChannelsHasBeenSet() const { return m_numberOfChannelsHasBeenSet; }
244 inline void SetNumberOfChannels(int value) { m_numberOfChannelsHasBeenSet = true; m_numberOfChannels = value; }
247
249
256 inline bool GetEnablePartialResultsStabilization() const { return m_enablePartialResultsStabilization; }
257 inline bool EnablePartialResultsStabilizationHasBeenSet() const { return m_enablePartialResultsStabilizationHasBeenSet; }
258 inline void SetEnablePartialResultsStabilization(bool value) { m_enablePartialResultsStabilizationHasBeenSet = true; m_enablePartialResultsStabilization = value; }
261
263
271 inline PartialResultsStability GetPartialResultsStability() const { return m_partialResultsStability; }
272 inline bool PartialResultsStabilityHasBeenSet() const { return m_partialResultsStabilityHasBeenSet; }
273 inline void SetPartialResultsStability(PartialResultsStability value) { m_partialResultsStabilityHasBeenSet = true; m_partialResultsStability = value; }
276
278
290 inline ContentIdentificationType GetContentIdentificationType() const { return m_contentIdentificationType; }
291 inline bool ContentIdentificationTypeHasBeenSet() const { return m_contentIdentificationTypeHasBeenSet; }
292 inline void SetContentIdentificationType(ContentIdentificationType value) { m_contentIdentificationTypeHasBeenSet = true; m_contentIdentificationType = value; }
295
297
309 inline ContentRedactionType GetContentRedactionType() const { return m_contentRedactionType; }
310 inline bool ContentRedactionTypeHasBeenSet() const { return m_contentRedactionTypeHasBeenSet; }
311 inline void SetContentRedactionType(ContentRedactionType value) { m_contentRedactionTypeHasBeenSet = true; m_contentRedactionType = value; }
314
316
331 inline const Aws::String& GetPiiEntityTypes() const { return m_piiEntityTypes; }
332 inline bool PiiEntityTypesHasBeenSet() const { return m_piiEntityTypesHasBeenSet; }
333 template<typename PiiEntityTypesT = Aws::String>
334 void SetPiiEntityTypes(PiiEntityTypesT&& value) { m_piiEntityTypesHasBeenSet = true; m_piiEntityTypes = std::forward<PiiEntityTypesT>(value); }
335 template<typename PiiEntityTypesT = Aws::String>
336 StartStreamTranscriptionRequest& WithPiiEntityTypes(PiiEntityTypesT&& value) { SetPiiEntityTypes(std::forward<PiiEntityTypesT>(value)); return *this;}
338
340
350 inline const Aws::String& GetLanguageModelName() const { return m_languageModelName; }
351 inline bool LanguageModelNameHasBeenSet() const { return m_languageModelNameHasBeenSet; }
352 template<typename LanguageModelNameT = Aws::String>
353 void SetLanguageModelName(LanguageModelNameT&& value) { m_languageModelNameHasBeenSet = true; m_languageModelName = std::forward<LanguageModelNameT>(value); }
354 template<typename LanguageModelNameT = Aws::String>
355 StartStreamTranscriptionRequest& WithLanguageModelName(LanguageModelNameT&& value) { SetLanguageModelName(std::forward<LanguageModelNameT>(value)); return *this;}
357
359
375 inline bool GetIdentifyLanguage() const { return m_identifyLanguage; }
376 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
377 inline void SetIdentifyLanguage(bool value) { m_identifyLanguageHasBeenSet = true; m_identifyLanguage = value; }
380
382
395 inline const Aws::String& GetLanguageOptions() const { return m_languageOptions; }
396 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
397 template<typename LanguageOptionsT = Aws::String>
398 void SetLanguageOptions(LanguageOptionsT&& value) { m_languageOptionsHasBeenSet = true; m_languageOptions = std::forward<LanguageOptionsT>(value); }
399 template<typename LanguageOptionsT = Aws::String>
400 StartStreamTranscriptionRequest& WithLanguageOptions(LanguageOptionsT&& value) { SetLanguageOptions(std::forward<LanguageOptionsT>(value)); return *this;}
402
404
410 inline LanguageCode GetPreferredLanguage() const { return m_preferredLanguage; }
411 inline bool PreferredLanguageHasBeenSet() const { return m_preferredLanguageHasBeenSet; }
412 inline void SetPreferredLanguage(LanguageCode value) { m_preferredLanguageHasBeenSet = true; m_preferredLanguage = value; }
415
417
431 inline bool GetIdentifyMultipleLanguages() const { return m_identifyMultipleLanguages; }
432 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
433 inline void SetIdentifyMultipleLanguages(bool value) { m_identifyMultipleLanguagesHasBeenSet = true; m_identifyMultipleLanguages = value; }
436
438
451 inline const Aws::String& GetVocabularyNames() const { return m_vocabularyNames; }
452 inline bool VocabularyNamesHasBeenSet() const { return m_vocabularyNamesHasBeenSet; }
453 template<typename VocabularyNamesT = Aws::String>
454 void SetVocabularyNames(VocabularyNamesT&& value) { m_vocabularyNamesHasBeenSet = true; m_vocabularyNames = std::forward<VocabularyNamesT>(value); }
455 template<typename VocabularyNamesT = Aws::String>
456 StartStreamTranscriptionRequest& WithVocabularyNames(VocabularyNamesT&& value) { SetVocabularyNames(std::forward<VocabularyNamesT>(value)); return *this;}
458
460
474 inline const Aws::String& GetVocabularyFilterNames() const { return m_vocabularyFilterNames; }
475 inline bool VocabularyFilterNamesHasBeenSet() const { return m_vocabularyFilterNamesHasBeenSet; }
476 template<typename VocabularyFilterNamesT = Aws::String>
477 void SetVocabularyFilterNames(VocabularyFilterNamesT&& value) { m_vocabularyFilterNamesHasBeenSet = true; m_vocabularyFilterNames = std::forward<VocabularyFilterNamesT>(value); }
478 template<typename VocabularyFilterNamesT = Aws::String>
479 StartStreamTranscriptionRequest& WithVocabularyFilterNames(VocabularyFilterNamesT&& value) { SetVocabularyFilterNames(std::forward<VocabularyFilterNamesT>(value)); return *this;}
481 private:
482
483 LanguageCode m_languageCode{LanguageCode::NOT_SET};
484 bool m_languageCodeHasBeenSet = false;
485
486 int m_mediaSampleRateHertz{0};
487 bool m_mediaSampleRateHertzHasBeenSet = false;
488
489 MediaEncoding m_mediaEncoding{MediaEncoding::NOT_SET};
490 bool m_mediaEncodingHasBeenSet = false;
491
492 Aws::String m_vocabularyName;
493 bool m_vocabularyNameHasBeenSet = false;
494
495 Aws::String m_sessionId;
496 bool m_sessionIdHasBeenSet = false;
497
498 std::shared_ptr<AudioStream> m_audioStream;
499 bool m_audioStreamHasBeenSet = false;
500
501 Aws::String m_vocabularyFilterName;
502 bool m_vocabularyFilterNameHasBeenSet = false;
503
505 bool m_vocabularyFilterMethodHasBeenSet = false;
506
507 bool m_showSpeakerLabel{false};
508 bool m_showSpeakerLabelHasBeenSet = false;
509
510 bool m_enableChannelIdentification{false};
511 bool m_enableChannelIdentificationHasBeenSet = false;
512
513 int m_numberOfChannels{0};
514 bool m_numberOfChannelsHasBeenSet = false;
515
516 bool m_enablePartialResultsStabilization{false};
517 bool m_enablePartialResultsStabilizationHasBeenSet = false;
518
520 bool m_partialResultsStabilityHasBeenSet = false;
521
523 bool m_contentIdentificationTypeHasBeenSet = false;
524
526 bool m_contentRedactionTypeHasBeenSet = false;
527
528 Aws::String m_piiEntityTypes;
529 bool m_piiEntityTypesHasBeenSet = false;
530
531 Aws::String m_languageModelName;
532 bool m_languageModelNameHasBeenSet = false;
533
534 bool m_identifyLanguage{false};
535 bool m_identifyLanguageHasBeenSet = false;
536
537 Aws::String m_languageOptions;
538 bool m_languageOptionsHasBeenSet = false;
539
540 LanguageCode m_preferredLanguage{LanguageCode::NOT_SET};
541 bool m_preferredLanguageHasBeenSet = false;
542
543 bool m_identifyMultipleLanguages{false};
544 bool m_identifyMultipleLanguagesHasBeenSet = false;
545
546 Aws::String m_vocabularyNames;
547 bool m_vocabularyNamesHasBeenSet = false;
548
549 Aws::String m_vocabularyFilterNames;
550 bool m_vocabularyFilterNamesHasBeenSet = false;
551 StartStreamTranscriptionHandler m_handler;
552 Aws::Utils::Event::EventStreamDecoder m_decoder{Utils::Event::EventStreamDecoder(&m_handler)};
553
554 };
555
556} // namespace Model
557} // namespace TranscribeStreamingService
558} // namespace Aws
AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
StartStreamTranscriptionRequest & WithVocabularyFilterNames(VocabularyFilterNamesT &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest & WithAudioStream(const std::shared_ptr< AudioStream > &value)
AWS_TRANSCRIBESTREAMINGSERVICE_API StartStreamTranscriptionRequest()=default
StartStreamTranscriptionRequest & WithPiiEntityTypes(PiiEntityTypesT &&value)
StartStreamTranscriptionRequest & WithContentIdentificationType(ContentIdentificationType value)
StartStreamTranscriptionRequest & WithContentRedactionType(ContentRedactionType value)
StartStreamTranscriptionRequest & WithPartialResultsStability(PartialResultsStability value)
StartStreamTranscriptionRequest & WithVocabularyNames(VocabularyNamesT &&value)
StartStreamTranscriptionRequest & WithLanguageModelName(LanguageModelNameT &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::String SerializePayload() const override
AWS_TRANSCRIBESTREAMINGSERVICE_API void SetAudioStream(const std::shared_ptr< AudioStream > &value)
StartStreamTranscriptionRequest & WithEventStreamHandler(const StartStreamTranscriptionHandler &value)
StartStreamTranscriptionRequest & WithVocabularyName(VocabularyNameT &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr< Aws::IOStream > GetBody() const override
StartStreamTranscriptionRequest & WithVocabularyFilterMethod(VocabularyFilterMethod value)
StartStreamTranscriptionRequest & WithVocabularyFilterName(VocabularyFilterNameT &&value)
AWS_TRANSCRIBESTREAMINGSERVICE_API std::shared_ptr< AudioStream > GetAudioStream() const
StartStreamTranscriptionRequest & WithLanguageOptions(LanguageOptionsT &&value)
void ResetEventStreamHandler(EventStreamHandler *handler)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String