com.amazonaws.services.ivs.model

Class CreateChannelRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ivs.model.CreateChannelRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateChannelRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateChannelRequest()

Method Summary

Modifier and Type	Method and Description
CreateChannelRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateChannelRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateChannelRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAuthorized() Whether the channel is private (enabled for playback authorization).
String	getLatencyMode() Channel latency mode.
String	getName() Channel name.
String	getRecordingConfigurationArn() Recording-configuration ARN.
Map<String,String>	getTags() Array of 1-50 maps, each of the form string:string (key:value).
String	getType() Channel type, which determines the allowable resolution and bitrate.
int	hashCode()
Boolean	isAuthorized() Whether the channel is private (enabled for playback authorization).
void	setAuthorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
void	setLatencyMode(String latencyMode) Channel latency mode.
void	setName(String name) Channel name.
void	setRecordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
void	setTags(Map<String,String> tags) Array of 1-50 maps, each of the form string:string (key:value).
void	setType(String type) Channel type, which determines the allowable resolution and bitrate.
String	toString() Returns a string representation of this object.
CreateChannelRequest	withAuthorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
CreateChannelRequest	withLatencyMode(ChannelLatencyMode latencyMode) Channel latency mode.
CreateChannelRequest	withLatencyMode(String latencyMode) Channel latency mode.
CreateChannelRequest	withName(String name) Channel name.
CreateChannelRequest	withRecordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
CreateChannelRequest	withTags(Map<String,String> tags) Array of 1-50 maps, each of the form string:string (key:value).
CreateChannelRequest	withType(ChannelType type) Channel type, which determines the allowable resolution and bitrate.
CreateChannelRequest	withType(String type) Channel type, which determines the allowable resolution and bitrate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateChannelRequest

public CreateChannelRequest()

Method Detail

setAuthorized

public void setAuthorized(Boolean authorized)

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

Parameters:

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

getAuthorized

public Boolean getAuthorized()

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

Returns:

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

withAuthorized

public CreateChannelRequest withAuthorized(Boolean authorized)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isAuthorized

public Boolean isAuthorized()

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

Returns:

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

setLatencyMode

public void setLatencyMode(String latencyMode)

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.

Parameters:

latencyMode - 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.

See Also:

ChannelLatencyMode

getLatencyMode

public String getLatencyMode()

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.

Returns:

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.

See Also:

ChannelLatencyMode

withLatencyMode

public CreateChannelRequest withLatencyMode(String latencyMode)

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.

Parameters:

latencyMode - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode

withLatencyMode

public CreateChannelRequest withLatencyMode(ChannelLatencyMode latencyMode)

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.

Parameters:

latencyMode - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode

setName

public void setName(String name)

Channel name.

Parameters:

name - Channel name.

getName

public String getName()

Channel name.

Returns:

Channel name.

withName

public CreateChannelRequest withName(String name)

Channel name.

Parameters:

name - Channel name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRecordingConfigurationArn

public void setRecordingConfigurationArn(String recordingConfigurationArn)

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

Parameters:

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

getRecordingConfigurationArn

public String getRecordingConfigurationArn()

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

Returns:

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

withRecordingConfigurationArn

public CreateChannelRequest withRecordingConfigurationArn(String recordingConfigurationArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

setTags

public void setTags(Map<String,String> tags)

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Parameters:

tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

withTags

public CreateChannelRequest withTags(Map<String,String> tags)

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Parameters:

tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateChannelRequest addTagsEntry(String key,
                                         String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateChannelRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Parameters:

type - 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

See Also:

ChannelType

getType

public String getType()

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Returns:

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

See Also:

ChannelType

withType

public CreateChannelRequest withType(String type)

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Parameters:

type - 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelType

withType

public CreateChannelRequest withType(ChannelType type)

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Parameters:

type - 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.

• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateChannelRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()