AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::IVS::Model::CreateChannelRequest Class Reference

#include <CreateChannelRequest.h>

+ Inheritance diagram for Aws::IVS::Model::CreateChannelRequest:

Public Member Functions

 CreateChannelRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
bool GetAuthorized () const
 
bool AuthorizedHasBeenSet () const
 
void SetAuthorized (bool value)
 
CreateChannelRequestWithAuthorized (bool value)
 
const ChannelLatencyModeGetLatencyMode () const
 
bool LatencyModeHasBeenSet () const
 
void SetLatencyMode (const ChannelLatencyMode &value)
 
void SetLatencyMode (ChannelLatencyMode &&value)
 
CreateChannelRequestWithLatencyMode (const ChannelLatencyMode &value)
 
CreateChannelRequestWithLatencyMode (ChannelLatencyMode &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateChannelRequestWithName (const Aws::String &value)
 
CreateChannelRequestWithName (Aws::String &&value)
 
CreateChannelRequestWithName (const char *value)
 
const Aws::StringGetRecordingConfigurationArn () const
 
bool RecordingConfigurationArnHasBeenSet () const
 
void SetRecordingConfigurationArn (const Aws::String &value)
 
void SetRecordingConfigurationArn (Aws::String &&value)
 
void SetRecordingConfigurationArn (const char *value)
 
CreateChannelRequestWithRecordingConfigurationArn (const Aws::String &value)
 
CreateChannelRequestWithRecordingConfigurationArn (Aws::String &&value)
 
CreateChannelRequestWithRecordingConfigurationArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateChannelRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateChannelRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateChannelRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateChannelRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateChannelRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateChannelRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateChannelRequestAddTags (const char *key, Aws::String &&value)
 
CreateChannelRequestAddTags (Aws::String &&key, const char *value)
 
CreateChannelRequestAddTags (const char *key, const char *value)
 
const ChannelTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ChannelType &value)
 
void SetType (ChannelType &&value)
 
CreateChannelRequestWithType (const ChannelType &value)
 
CreateChannelRequestWithType (ChannelType &&value)
 
- Public Member Functions inherited from Aws::IVS::IVSRequest
virtual ~IVSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IVS::IVSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateChannelRequest.h.

Constructor & Destructor Documentation

◆ CreateChannelRequest()

Aws::IVS::Model::CreateChannelRequest::CreateChannelRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 266 of file CreateChannelRequest.h.

◆ AddTags() [2/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 254 of file CreateChannelRequest.h.

◆ AddTags() [3/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 278 of file CreateChannelRequest.h.

◆ AddTags() [4/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 260 of file CreateChannelRequest.h.

◆ AddTags() [5/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 248 of file CreateChannelRequest.h.

◆ AddTags() [6/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 272 of file CreateChannelRequest.h.

◆ AddTags() [7/7]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::AddTags ( const char *  key,
const char *  value 
)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 284 of file CreateChannelRequest.h.

◆ AuthorizedHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::AuthorizedHasBeenSet ( ) const
inline

Whether the channel is private (enabled for playback authorization). Default: false.

Definition at line 48 of file CreateChannelRequest.h.

◆ GetAuthorized()

bool Aws::IVS::Model::CreateChannelRequest::GetAuthorized ( ) const
inline

Whether the channel is private (enabled for playback authorization). Default: false.

Definition at line 42 of file CreateChannelRequest.h.

◆ GetLatencyMode()

const ChannelLatencyMode& Aws::IVS::Model::CreateChannelRequest::GetLatencyMode ( ) const
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 70 of file CreateChannelRequest.h.

◆ GetName()

const Aws::String& Aws::IVS::Model::CreateChannelRequest::GetName ( ) const
inline

Channel name.

Definition at line 121 of file CreateChannelRequest.h.

◆ GetRecordingConfigurationArn()

const Aws::String& Aws::IVS::Model::CreateChannelRequest::GetRecordingConfigurationArn ( ) const
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 163 of file CreateChannelRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IVS::Model::CreateChannelRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateChannelRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::IVS::Model::CreateChannelRequest::GetTags ( ) const
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 212 of file CreateChannelRequest.h.

◆ GetType()

const ChannelType& Aws::IVS::Model::CreateChannelRequest::GetType ( ) const
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 300 of file CreateChannelRequest.h.

◆ LatencyModeHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::LatencyModeHasBeenSet ( ) const
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 79 of file CreateChannelRequest.h.

◆ NameHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::NameHasBeenSet ( ) const
inline

Channel name.

Definition at line 126 of file CreateChannelRequest.h.

◆ RecordingConfigurationArnHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::RecordingConfigurationArnHasBeenSet ( ) const
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 169 of file CreateChannelRequest.h.

◆ SerializePayload()

Aws::String Aws::IVS::Model::CreateChannelRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthorized()

void Aws::IVS::Model::CreateChannelRequest::SetAuthorized ( bool  value)
inline

Whether the channel is private (enabled for playback authorization). Default: false.

Definition at line 54 of file CreateChannelRequest.h.

◆ SetLatencyMode() [1/2]

void Aws::IVS::Model::CreateChannelRequest::SetLatencyMode ( ChannelLatencyMode &&  value)
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 97 of file CreateChannelRequest.h.

◆ SetLatencyMode() [2/2]

void Aws::IVS::Model::CreateChannelRequest::SetLatencyMode ( const ChannelLatencyMode value)
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 88 of file CreateChannelRequest.h.

◆ SetName() [1/3]

void Aws::IVS::Model::CreateChannelRequest::SetName ( Aws::String &&  value)
inline

Channel name.

Definition at line 136 of file CreateChannelRequest.h.

◆ SetName() [2/3]

void Aws::IVS::Model::CreateChannelRequest::SetName ( const Aws::String value)
inline

Channel name.

Definition at line 131 of file CreateChannelRequest.h.

◆ SetName() [3/3]

void Aws::IVS::Model::CreateChannelRequest::SetName ( const char *  value)
inline

Channel name.

Definition at line 141 of file CreateChannelRequest.h.

◆ SetRecordingConfigurationArn() [1/3]

void Aws::IVS::Model::CreateChannelRequest::SetRecordingConfigurationArn ( Aws::String &&  value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 181 of file CreateChannelRequest.h.

◆ SetRecordingConfigurationArn() [2/3]

void Aws::IVS::Model::CreateChannelRequest::SetRecordingConfigurationArn ( const Aws::String value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 175 of file CreateChannelRequest.h.

◆ SetRecordingConfigurationArn() [3/3]

void Aws::IVS::Model::CreateChannelRequest::SetRecordingConfigurationArn ( const char *  value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 187 of file CreateChannelRequest.h.

◆ SetTags() [1/2]

void Aws::IVS::Model::CreateChannelRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 230 of file CreateChannelRequest.h.

◆ SetTags() [2/2]

void Aws::IVS::Model::CreateChannelRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 224 of file CreateChannelRequest.h.

◆ SetType() [1/2]

void Aws::IVS::Model::CreateChannelRequest::SetType ( ChannelType &&  value)
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 345 of file CreateChannelRequest.h.

◆ SetType() [2/2]

void Aws::IVS::Model::CreateChannelRequest::SetType ( const ChannelType value)
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 330 of file CreateChannelRequest.h.

◆ TagsHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::TagsHasBeenSet ( ) const
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 218 of file CreateChannelRequest.h.

◆ TypeHasBeenSet()

bool Aws::IVS::Model::CreateChannelRequest::TypeHasBeenSet ( ) const
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 315 of file CreateChannelRequest.h.

◆ WithAuthorized()

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithAuthorized ( bool  value)
inline

Whether the channel is private (enabled for playback authorization). Default: false.

Definition at line 60 of file CreateChannelRequest.h.

◆ WithLatencyMode() [1/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithLatencyMode ( ChannelLatencyMode &&  value)
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 115 of file CreateChannelRequest.h.

◆ WithLatencyMode() [2/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithLatencyMode ( const ChannelLatencyMode value)
inline

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Definition at line 106 of file CreateChannelRequest.h.

◆ WithName() [1/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithName ( Aws::String &&  value)
inline

Channel name.

Definition at line 151 of file CreateChannelRequest.h.

◆ WithName() [2/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithName ( const Aws::String value)
inline

Channel name.

Definition at line 146 of file CreateChannelRequest.h.

◆ WithName() [3/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithName ( const char *  value)
inline

Channel name.

Definition at line 156 of file CreateChannelRequest.h.

◆ WithRecordingConfigurationArn() [1/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithRecordingConfigurationArn ( Aws::String &&  value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 199 of file CreateChannelRequest.h.

◆ WithRecordingConfigurationArn() [2/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithRecordingConfigurationArn ( const Aws::String value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 193 of file CreateChannelRequest.h.

◆ WithRecordingConfigurationArn() [3/3]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithRecordingConfigurationArn ( const char *  value)
inline

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Definition at line 205 of file CreateChannelRequest.h.

◆ WithTags() [1/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 242 of file CreateChannelRequest.h.

◆ WithTags() [2/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Array of 1-50 maps, each of the form string:string (key:value).

Definition at line 236 of file CreateChannelRequest.h.

◆ WithType() [1/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithType ( ChannelType &&  value)
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 375 of file CreateChannelRequest.h.

◆ WithType() [2/2]

CreateChannelRequest& Aws::IVS::Model::CreateChannelRequest::WithType ( const ChannelType value)
inline

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

Definition at line 360 of file CreateChannelRequest.h.


The documentation for this class was generated from the following file: