software.amazon.awssdk.services.ivs.model

Class Channel

java.lang.Object

software.amazon.awssdk.services.ivs.model.Channel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Channel.Builder,Channel>

@Generated(value="software.amazon.awssdk:codegen")
public final class Channel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>

Object specifying a channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Channel ARN.
Boolean	authorized() Whether the channel is private (enabled for playback authorization).
static Channel.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	ingestEndpoint() Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
ChannelLatencyMode	latencyMode() Channel latency mode.
String	latencyModeAsString() Channel latency mode.
String	name() Channel name.
String	playbackUrl() Channel playback URL.
String	recordingConfigurationArn() Recording-configuration ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends Channel.Builder>	serializableBuilderClass()
Map<String,String>	tags() Array of 1-50 maps, each of the form string:string (key:value).
Channel.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ChannelType	type() Channel type, which determines the allowable resolution and bitrate.
String	typeAsString() Channel type, which determines the allowable resolution and bitrate.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public final String arn()

Channel ARN.

Returns:

Channel ARN.

name

public final String name()

Channel name.

Returns:

Channel name.

latencyMode

public final 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.)

If the service returns an enum value that is not available in the current SDK version, latencyMode will return ChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latencyModeAsString().

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

See Also:

ChannelLatencyMode

latencyModeAsString

public final String latencyModeAsString()

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

If the service returns an enum value that is not available in the current SDK version, latencyMode will return ChannelLatencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latencyModeAsString().

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

See Also:

ChannelLatencyMode

type

public final 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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

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

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

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

See Also:

ChannelType

typeAsString

public final String typeAsString()

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. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

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

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

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

See Also:

ChannelType

recordingConfigurationArn

public final String recordingConfigurationArn()

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

Returns:

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

ingestEndpoint

public final String ingestEndpoint()

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

Returns:

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

playbackUrl

public final String playbackUrl()

Channel playback URL.

Returns:

Channel playback URL.

authorized

public final Boolean authorized()

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

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

toBuilder

public Channel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>

builder

public static Channel.Builder builder()

serializableBuilderClass

public static Class<? extends Channel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo