Class Channel

java.lang.Object
software.amazon.awssdk.services.ivs.model.Channel
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Channel.Builder,Channel>
@Generated("software.amazon.awssdk:codegen") public final class Channel extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>

Object specifying a channel.

See Also:

  • Method Details

    • arn

      public final String arn()

      Channel ARN.

      Returns:
      Channel ARN.

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

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

    • insecureIngest

      public final Boolean insecureIngest()

      Whether the channel allows insecure RTMP ingest. Default: false.

      Returns:
      Whether the channel allows insecure RTMP ingest. Default: false.

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

      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.
      See Also:

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

      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.
      See Also:

    • name

      public final String name()

      Channel name.

      Returns:
      Channel name.

    • playbackRestrictionPolicyArn

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

      public final String playbackUrl()

      Channel playback URL.

      Returns:
      Channel playback URL.

    • preset

      public final TranscodePreset preset()

      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

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

      Returns:
      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
      See Also:

    • presetAsString

      public final String presetAsString()

      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

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

      Returns:
      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
      See Also:

    • recordingConfigurationArn

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

    • srt

      public final Srt srt()

      Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

      Returns:
      Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

    • 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 the isEmpty() 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

      public final Map<String,String> tags()

      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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 Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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

      public final ChannelType 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 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 input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
      See Also:

    • typeAsString

      public final String 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 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 input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
      See Also:

    • toBuilder

      public Channel.Builder 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 interface ToCopyableBuilder<Channel.Builder,Channel>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.