software.amazon.awssdk.services.ivs.model

Interface Channel.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Channel.Builder,Channel>, SdkBuilder<Channel.Builder,Channel>, SdkPojo

Enclosing class:

Channel

public static interface Channel.Builder
extends SdkPojo, CopyableBuilder<Channel.Builder,Channel>

Method Summary

Modifier and Type	Method and Description
Channel.Builder	arn(String arn) Channel ARN.
Channel.Builder	authorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
Channel.Builder	ingestEndpoint(String ingestEndpoint) Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
Channel.Builder	latencyMode(ChannelLatencyMode latencyMode) Channel latency mode.
Channel.Builder	latencyMode(String latencyMode) Channel latency mode.
Channel.Builder	name(String name) Channel name.
Channel.Builder	playbackUrl(String playbackUrl) Channel playback URL.
Channel.Builder	recordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
Channel.Builder	tags(Map<String,String> tags) Array of 1-50 maps, each of the form string:string (key:value).
Channel.Builder	type(ChannelType type) Channel type, which determines the allowable resolution and bitrate.
Channel.Builder	type(String type) Channel type, which determines the allowable resolution and bitrate.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

arn

Channel.Builder arn(String arn)

Channel ARN.

Parameters:

arn - Channel ARN.

Returns:

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

authorized

Channel.Builder authorized(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.

ingestEndpoint

Channel.Builder ingestEndpoint(String ingestEndpoint)

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

Parameters:

ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

Returns:

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

latencyMode

Channel.Builder latencyMode(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. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

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. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

Returns:

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

See Also:

ChannelLatencyMode, ChannelLatencyMode

latencyMode

Channel.Builder latencyMode(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. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

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. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

Returns:

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

See Also:

ChannelLatencyMode, ChannelLatencyMode

name

Channel.Builder name(String name)

Channel name.

Parameters:

name - Channel name.

Returns:

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

playbackUrl

Channel.Builder playbackUrl(String playbackUrl)

Channel playback URL.

Parameters:

playbackUrl - Channel playback URL.

Returns:

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

recordingConfigurationArn

Channel.Builder recordingConfigurationArn(String recordingConfigurationArn)

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Parameters:

recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Returns:

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

tags

Channel.Builder tags(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.

type

Channel.Builder type(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, ChannelType

type

Channel.Builder type(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, ChannelType