AWS SDK for C++  1.8.71
AWS SDK for C++
StartStreamTranscriptionRequest.h
Go to the documentation of this file.
1 
6 #pragma once
11 #include <memory>
17 #include <utility>
18 
19 namespace Aws
20 {
21 namespace TranscribeStreamingService
22 {
23 namespace Model
24 {
25 
29  {
30  public:
32 
33  // Service request name is the Operation name which will send this request out,
34  // each operation should has unique request name, so that we can get operation's name from this request.
35  // Note: this is not true for response, multiple operations may have the same response name,
36  // so we can not get operation's name from response.
37  inline virtual const char* GetServiceRequestName() const override { return "StartStreamTranscription"; }
38 
39  inline virtual bool IsEventStreamRequest() const override { return true; }
40  // SerializePayload will not be invoked.
41  // This request is sent by encoding its data in event-streams which is sent as IOStream via GetBody()
42  Aws::String SerializePayload() const override { return {}; }
43  std::shared_ptr<Aws::IOStream> GetBody() const override;
44  Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
45 
50 
54  inline const StartStreamTranscriptionHandler& GetEventStreamHandler() const { return m_handler; }
55 
59  inline void SetEventStreamHandler(const StartStreamTranscriptionHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
60 
64  inline StartStreamTranscriptionRequest& WithEventStreamHandler(const StartStreamTranscriptionHandler& value) { SetEventStreamHandler(value); return *this; }
65 
66 
70  inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
71 
75  inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
76 
80  inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
81 
85  inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
86 
90  inline StartStreamTranscriptionRequest& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;}
91 
95  inline StartStreamTranscriptionRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
96 
97 
102  inline int GetMediaSampleRateHertz() const{ return m_mediaSampleRateHertz; }
103 
108  inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
109 
114  inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
115 
120  inline StartStreamTranscriptionRequest& WithMediaSampleRateHertz(int value) { SetMediaSampleRateHertz(value); return *this;}
121 
122 
127  inline const MediaEncoding& GetMediaEncoding() const{ return m_mediaEncoding; }
128 
133  inline bool MediaEncodingHasBeenSet() const { return m_mediaEncodingHasBeenSet; }
134 
139  inline void SetMediaEncoding(const MediaEncoding& value) { m_mediaEncodingHasBeenSet = true; m_mediaEncoding = value; }
140 
145  inline void SetMediaEncoding(MediaEncoding&& value) { m_mediaEncodingHasBeenSet = true; m_mediaEncoding = std::move(value); }
146 
151  inline StartStreamTranscriptionRequest& WithMediaEncoding(const MediaEncoding& value) { SetMediaEncoding(value); return *this;}
152 
157  inline StartStreamTranscriptionRequest& WithMediaEncoding(MediaEncoding&& value) { SetMediaEncoding(std::move(value)); return *this;}
158 
159 
163  inline const Aws::String& GetVocabularyName() const{ return m_vocabularyName; }
164 
168  inline bool VocabularyNameHasBeenSet() const { return m_vocabularyNameHasBeenSet; }
169 
173  inline void SetVocabularyName(const Aws::String& value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName = value; }
174 
178  inline void SetVocabularyName(Aws::String&& value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName = std::move(value); }
179 
183  inline void SetVocabularyName(const char* value) { m_vocabularyNameHasBeenSet = true; m_vocabularyName.assign(value); }
184 
188  inline StartStreamTranscriptionRequest& WithVocabularyName(const Aws::String& value) { SetVocabularyName(value); return *this;}
189 
193  inline StartStreamTranscriptionRequest& WithVocabularyName(Aws::String&& value) { SetVocabularyName(std::move(value)); return *this;}
194 
198  inline StartStreamTranscriptionRequest& WithVocabularyName(const char* value) { SetVocabularyName(value); return *this;}
199 
200 
206  inline const Aws::String& GetSessionId() const{ return m_sessionId; }
207 
213  inline bool SessionIdHasBeenSet() const { return m_sessionIdHasBeenSet; }
214 
220  inline void SetSessionId(const Aws::String& value) { m_sessionIdHasBeenSet = true; m_sessionId = value; }
221 
227  inline void SetSessionId(Aws::String&& value) { m_sessionIdHasBeenSet = true; m_sessionId = std::move(value); }
228 
234  inline void SetSessionId(const char* value) { m_sessionIdHasBeenSet = true; m_sessionId.assign(value); }
235 
241  inline StartStreamTranscriptionRequest& WithSessionId(const Aws::String& value) { SetSessionId(value); return *this;}
242 
248  inline StartStreamTranscriptionRequest& WithSessionId(Aws::String&& value) { SetSessionId(std::move(value)); return *this;}
249 
255  inline StartStreamTranscriptionRequest& WithSessionId(const char* value) { SetSessionId(value); return *this;}
256 
257 
262  std::shared_ptr<AudioStream> GetAudioStream() const { return m_audioStream; }
263 
268  void SetAudioStream(const std::shared_ptr<AudioStream>& value) { m_audioStream = value; }
269 
274  StartStreamTranscriptionRequest& WithAudioStream(const std::shared_ptr<AudioStream>& value) { SetAudioStream(value); return *this;}
275 
276 
281  inline const Aws::String& GetVocabularyFilterName() const{ return m_vocabularyFilterName; }
282 
287  inline bool VocabularyFilterNameHasBeenSet() const { return m_vocabularyFilterNameHasBeenSet; }
288 
293  inline void SetVocabularyFilterName(const Aws::String& value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName = value; }
294 
299  inline void SetVocabularyFilterName(Aws::String&& value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName = std::move(value); }
300 
305  inline void SetVocabularyFilterName(const char* value) { m_vocabularyFilterNameHasBeenSet = true; m_vocabularyFilterName.assign(value); }
306 
311  inline StartStreamTranscriptionRequest& WithVocabularyFilterName(const Aws::String& value) { SetVocabularyFilterName(value); return *this;}
312 
317  inline StartStreamTranscriptionRequest& WithVocabularyFilterName(Aws::String&& value) { SetVocabularyFilterName(std::move(value)); return *this;}
318 
323  inline StartStreamTranscriptionRequest& WithVocabularyFilterName(const char* value) { SetVocabularyFilterName(value); return *this;}
324 
325 
334  inline const VocabularyFilterMethod& GetVocabularyFilterMethod() const{ return m_vocabularyFilterMethod; }
335 
344  inline bool VocabularyFilterMethodHasBeenSet() const { return m_vocabularyFilterMethodHasBeenSet; }
345 
354  inline void SetVocabularyFilterMethod(const VocabularyFilterMethod& value) { m_vocabularyFilterMethodHasBeenSet = true; m_vocabularyFilterMethod = value; }
355 
364  inline void SetVocabularyFilterMethod(VocabularyFilterMethod&& value) { m_vocabularyFilterMethodHasBeenSet = true; m_vocabularyFilterMethod = std::move(value); }
365 
374  inline StartStreamTranscriptionRequest& WithVocabularyFilterMethod(const VocabularyFilterMethod& value) { SetVocabularyFilterMethod(value); return *this;}
375 
384  inline StartStreamTranscriptionRequest& WithVocabularyFilterMethod(VocabularyFilterMethod&& value) { SetVocabularyFilterMethod(std::move(value)); return *this;}
385 
386 
391  inline bool GetShowSpeakerLabel() const{ return m_showSpeakerLabel; }
392 
397  inline bool ShowSpeakerLabelHasBeenSet() const { return m_showSpeakerLabelHasBeenSet; }
398 
403  inline void SetShowSpeakerLabel(bool value) { m_showSpeakerLabelHasBeenSet = true; m_showSpeakerLabel = value; }
404 
409  inline StartStreamTranscriptionRequest& WithShowSpeakerLabel(bool value) { SetShowSpeakerLabel(value); return *this;}
410 
411 
421  inline bool GetEnableChannelIdentification() const{ return m_enableChannelIdentification; }
422 
432  inline bool EnableChannelIdentificationHasBeenSet() const { return m_enableChannelIdentificationHasBeenSet; }
433 
443  inline void SetEnableChannelIdentification(bool value) { m_enableChannelIdentificationHasBeenSet = true; m_enableChannelIdentification = value; }
444 
454  inline StartStreamTranscriptionRequest& WithEnableChannelIdentification(bool value) { SetEnableChannelIdentification(value); return *this;}
455 
456 
460  inline int GetNumberOfChannels() const{ return m_numberOfChannels; }
461 
465  inline bool NumberOfChannelsHasBeenSet() const { return m_numberOfChannelsHasBeenSet; }
466 
470  inline void SetNumberOfChannels(int value) { m_numberOfChannelsHasBeenSet = true; m_numberOfChannels = value; }
471 
475  inline StartStreamTranscriptionRequest& WithNumberOfChannels(int value) { SetNumberOfChannels(value); return *this;}
476 
477  private:
478 
479  LanguageCode m_languageCode;
480  bool m_languageCodeHasBeenSet;
481 
482  int m_mediaSampleRateHertz;
483  bool m_mediaSampleRateHertzHasBeenSet;
484 
485  MediaEncoding m_mediaEncoding;
486  bool m_mediaEncodingHasBeenSet;
487 
488  Aws::String m_vocabularyName;
489  bool m_vocabularyNameHasBeenSet;
490 
491  Aws::String m_sessionId;
492  bool m_sessionIdHasBeenSet;
493 
494  std::shared_ptr<AudioStream> m_audioStream;
495 
496  Aws::String m_vocabularyFilterName;
497  bool m_vocabularyFilterNameHasBeenSet;
498 
499  VocabularyFilterMethod m_vocabularyFilterMethod;
500  bool m_vocabularyFilterMethodHasBeenSet;
501 
502  bool m_showSpeakerLabel;
503  bool m_showSpeakerLabelHasBeenSet;
504 
505  bool m_enableChannelIdentification;
506  bool m_enableChannelIdentificationHasBeenSet;
507 
508  int m_numberOfChannels;
509  bool m_numberOfChannelsHasBeenSet;
512 
513  };
514 
515 } // namespace Model
516 } // namespace TranscribeStreamingService
517 } // namespace Aws
StartStreamTranscriptionRequest & WithVocabularyFilterName(const Aws::String &value)
StartStreamTranscriptionRequest & WithLanguageCode(const LanguageCode &value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
StartStreamTranscriptionRequest & WithEventStreamHandler(const StartStreamTranscriptionHandler &value)
StartStreamTranscriptionRequest & WithAudioStream(const std::shared_ptr< AudioStream > &value)
StartStreamTranscriptionRequest & WithVocabularyFilterMethod(VocabularyFilterMethod &&value)
StartStreamTranscriptionRequest & WithVocabularyFilterMethod(const VocabularyFilterMethod &value)
StartStreamTranscriptionRequest & WithMediaEncoding(const MediaEncoding &value)
StartStreamTranscriptionRequest & WithVocabularyName(const Aws::String &value)
StartStreamTranscriptionRequest & WithLanguageCode(LanguageCode &&value)
StartStreamTranscriptionRequest & WithSessionId(const Aws::String &value)
#define AWS_TRANSCRIBESTREAMINGSERVICE_API
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
StartStreamTranscriptionRequest & WithMediaEncoding(MediaEncoding &&value)
StartStreamTranscriptionRequest & WithVocabularyFilterName(Aws::String &&value)