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

#include <UpdateChannelRequest.h>

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

Public Member Functions

 UpdateChannelRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
UpdateChannelRequestWithArn (const Aws::String &value)
 
UpdateChannelRequestWithArn (Aws::String &&value)
 
UpdateChannelRequestWithArn (const char *value)
 
bool GetAuthorized () const
 
bool AuthorizedHasBeenSet () const
 
void SetAuthorized (bool value)
 
UpdateChannelRequestWithAuthorized (bool value)
 
const ChannelLatencyModeGetLatencyMode () const
 
bool LatencyModeHasBeenSet () const
 
void SetLatencyMode (const ChannelLatencyMode &value)
 
void SetLatencyMode (ChannelLatencyMode &&value)
 
UpdateChannelRequestWithLatencyMode (const ChannelLatencyMode &value)
 
UpdateChannelRequestWithLatencyMode (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)
 
UpdateChannelRequestWithName (const Aws::String &value)
 
UpdateChannelRequestWithName (Aws::String &&value)
 
UpdateChannelRequestWithName (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)
 
UpdateChannelRequestWithRecordingConfigurationArn (const Aws::String &value)
 
UpdateChannelRequestWithRecordingConfigurationArn (Aws::String &&value)
 
UpdateChannelRequestWithRecordingConfigurationArn (const char *value)
 
const ChannelTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ChannelType &value)
 
void SetType (ChannelType &&value)
 
UpdateChannelRequestWithType (const ChannelType &value)
 
UpdateChannelRequestWithType (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 23 of file UpdateChannelRequest.h.

Constructor & Destructor Documentation

◆ UpdateChannelRequest()

Aws::IVS::Model::UpdateChannelRequest::UpdateChannelRequest ( )

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::IVS::Model::UpdateChannelRequest::ArnHasBeenSet ( ) const
inline

ARN of the channel to be updated.

Definition at line 45 of file UpdateChannelRequest.h.

◆ AuthorizedHasBeenSet()

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

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

Definition at line 86 of file UpdateChannelRequest.h.

◆ GetArn()

const Aws::String& Aws::IVS::Model::UpdateChannelRequest::GetArn ( ) const
inline

ARN of the channel to be updated.

Definition at line 40 of file UpdateChannelRequest.h.

◆ GetAuthorized()

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

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

Definition at line 81 of file UpdateChannelRequest.h.

◆ GetLatencyMode()

const ChannelLatencyMode& Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 105 of file UpdateChannelRequest.h.

◆ GetName()

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

Channel name.

Definition at line 151 of file UpdateChannelRequest.h.

◆ GetRecordingConfigurationArn()

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 194 of file UpdateChannelRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file UpdateChannelRequest.h.

◆ GetType()

const ChannelType& Aws::IVS::Model::UpdateChannelRequest::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. 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 259 of file UpdateChannelRequest.h.

◆ LatencyModeHasBeenSet()

bool Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 113 of file UpdateChannelRequest.h.

◆ NameHasBeenSet()

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

Channel name.

Definition at line 156 of file UpdateChannelRequest.h.

◆ RecordingConfigurationArnHasBeenSet()

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 201 of file UpdateChannelRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArn() [1/3]

void Aws::IVS::Model::UpdateChannelRequest::SetArn ( Aws::String &&  value)
inline

ARN of the channel to be updated.

Definition at line 55 of file UpdateChannelRequest.h.

◆ SetArn() [2/3]

void Aws::IVS::Model::UpdateChannelRequest::SetArn ( const Aws::String value)
inline

ARN of the channel to be updated.

Definition at line 50 of file UpdateChannelRequest.h.

◆ SetArn() [3/3]

void Aws::IVS::Model::UpdateChannelRequest::SetArn ( const char *  value)
inline

ARN of the channel to be updated.

Definition at line 60 of file UpdateChannelRequest.h.

◆ SetAuthorized()

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

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

Definition at line 91 of file UpdateChannelRequest.h.

◆ SetLatencyMode() [1/2]

void Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 129 of file UpdateChannelRequest.h.

◆ SetLatencyMode() [2/2]

void Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 121 of file UpdateChannelRequest.h.

◆ SetName() [1/3]

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

Channel name.

Definition at line 166 of file UpdateChannelRequest.h.

◆ SetName() [2/3]

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

Channel name.

Definition at line 161 of file UpdateChannelRequest.h.

◆ SetName() [3/3]

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

Channel name.

Definition at line 171 of file UpdateChannelRequest.h.

◆ SetRecordingConfigurationArn() [1/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 215 of file UpdateChannelRequest.h.

◆ SetRecordingConfigurationArn() [2/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 208 of file UpdateChannelRequest.h.

◆ SetRecordingConfigurationArn() [3/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 222 of file UpdateChannelRequest.h.

◆ SetType() [1/2]

void Aws::IVS::Model::UpdateChannelRequest::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. 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 304 of file UpdateChannelRequest.h.

◆ SetType() [2/2]

void Aws::IVS::Model::UpdateChannelRequest::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. 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 289 of file UpdateChannelRequest.h.

◆ TypeHasBeenSet()

bool Aws::IVS::Model::UpdateChannelRequest::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. 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 274 of file UpdateChannelRequest.h.

◆ WithArn() [1/3]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::WithArn ( Aws::String &&  value)
inline

ARN of the channel to be updated.

Definition at line 70 of file UpdateChannelRequest.h.

◆ WithArn() [2/3]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::WithArn ( const Aws::String value)
inline

ARN of the channel to be updated.

Definition at line 65 of file UpdateChannelRequest.h.

◆ WithArn() [3/3]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::WithArn ( const char *  value)
inline

ARN of the channel to be updated.

Definition at line 75 of file UpdateChannelRequest.h.

◆ WithAuthorized()

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

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

Definition at line 96 of file UpdateChannelRequest.h.

◆ WithLatencyMode() [1/2]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 145 of file UpdateChannelRequest.h.

◆ WithLatencyMode() [2/2]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::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.)

Definition at line 137 of file UpdateChannelRequest.h.

◆ WithName() [1/3]

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

Channel name.

Definition at line 181 of file UpdateChannelRequest.h.

◆ WithName() [2/3]

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

Channel name.

Definition at line 176 of file UpdateChannelRequest.h.

◆ WithName() [3/3]

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

Channel name.

Definition at line 186 of file UpdateChannelRequest.h.

◆ WithRecordingConfigurationArn() [1/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 236 of file UpdateChannelRequest.h.

◆ WithRecordingConfigurationArn() [2/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 229 of file UpdateChannelRequest.h.

◆ WithRecordingConfigurationArn() [3/3]

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

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

Definition at line 243 of file UpdateChannelRequest.h.

◆ WithType() [1/2]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::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. 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 334 of file UpdateChannelRequest.h.

◆ WithType() [2/2]

UpdateChannelRequest& Aws::IVS::Model::UpdateChannelRequest::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. 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 319 of file UpdateChannelRequest.h.


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