Package software.amazon.awssdk.services.ivs.model

Class CreateChannelRequest

    • Method Detail

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

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

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

      • 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:
        TranscodePreset

      • 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:
        TranscodePreset

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

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

        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:
        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

        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:
        ChannelType

      • 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:
        ChannelType

      • 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