Class Channel
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Channel.Builder,
Channel>
Object specifying a channel.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Channel ARN.final Boolean
Whether the channel is private (enabled for playback authorization).static Channel.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.final Boolean
Whether the channel allows insecure RTMP ingest.final ChannelLatencyMode
Channel latency mode.final String
Channel latency mode.final String
name()
Channel name.final String
Playback-restriction-policy ARN.final String
Channel playback URL.final TranscodePreset
preset()
Optional transcode preset for the channel.final String
Optional transcode preset for the channel.final String
Recording-configuration ARN.static Class
<? extends Channel.Builder> tags()
Tags attached to the resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ChannelType
type()
Channel type, which determines the allowable resolution and bitrate.final String
Channel type, which determines the allowable resolution and bitrate.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
Channel ARN.
- Returns:
- Channel ARN.
-
authorized
Whether the channel is private (enabled for playback authorization). Default:
false
.- Returns:
- Whether the channel is private (enabled for playback authorization). Default:
false
.
-
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.
-
insecureIngest
Whether the channel allows insecure RTMP ingest. Default:
false
.- Returns:
- Whether the channel allows insecure RTMP ingest. Default:
false
.
-
latencyMode
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.If the service returns an enum value that is not available in the current SDK version,
latencyMode
will returnChannelLatencyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlatencyModeAsString()
.- Returns:
- Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
. - See Also:
-
latencyModeAsString
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.If the service returns an enum value that is not available in the current SDK version,
latencyMode
will returnChannelLatencyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlatencyModeAsString()
.- Returns:
- Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
. - See Also:
-
name
Channel name.
- Returns:
- Channel name.
-
playbackRestrictionPolicyArn
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
- Returns:
- Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
-
playbackUrl
Channel playback URL.
- Returns:
- Channel playback URL.
-
preset
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).If the service returns an enum value that is not available in the current SDK version,
preset
will returnTranscodePreset.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompresetAsString()
.- Returns:
- Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
). - See Also:
-
presetAsString
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).If the service returns an enum value that is not available in the current SDK version,
preset
will returnTranscodePreset.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompresetAsString()
.- Returns:
- Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
). - See Also:
-
recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
- Returns:
- Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Tags attached to the resource. 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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Tags attached to the resource. 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.
-
type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types. - See Also:
-
typeAsString
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types.If the service returns an enum value that is not available in the current SDK version,
type
will returnChannelType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Channel.Builder,
Channel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-