Package software.amazon.awssdk.services.medialive.model

Class InputDeviceUhdSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.InputDeviceUhdSettings

All Implemented Interfaces:

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

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

Settings that describe the active source from the input device, and the video characteristics of that source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputDeviceUhdSettings.Builder

Method Summary

Modifier and Type	Method	Description
InputDeviceActiveInput	activeInput()	If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
String	activeInputAsString()	If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
List<InputDeviceUhdAudioChannelPairConfig>	audioChannelPairs()	An array of eight audio configurations, one for each audio pair in the source.
static InputDeviceUhdSettings.Builder	builder()
InputDeviceCodec	codec()	The codec for the video that the device produces.
String	codecAsString()	The codec for the video that the device produces.
InputDeviceConfiguredInput	configuredInput()	The source at the input device that is currently active.
String	configuredInputAsString()	The source at the input device that is currently active.
InputDeviceState	deviceState()	The state of the input device.
String	deviceStateAsString()	The state of the input device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Double	framerate()	The frame rate of the video source.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudioChannelPairs()	For responses, this returns true if the service returned a value for the AudioChannelPairs property.
int	hashCode()
Integer	height()	The height of the video source, in pixels.
Integer	latencyMs()	The Link device's buffer size (latency) in milliseconds (ms).
Integer	maxBitrate()	The current maximum bitrate for ingesting this source, in bits per second.
InputDeviceMediaConnectSettings	mediaconnectSettings()	Information about the MediaConnect flow attached to the device.
InputDeviceScanType	scanType()	The scan type of the video source.
String	scanTypeAsString()	The scan type of the video source.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InputDeviceUhdSettings.Builder>	serializableBuilderClass()
InputDeviceUhdSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	width()	The width of the video source, in pixels.

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

activeInput

public final InputDeviceActiveInput activeInput()

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

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

Returns:

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

See Also:

InputDeviceActiveInput

activeInputAsString

public final String activeInputAsString()

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

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

Returns:

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

See Also:

InputDeviceActiveInput

configuredInput

public final InputDeviceConfiguredInput configuredInput()

The source at the input device that is currently active. You can specify this source.

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

Returns:

The source at the input device that is currently active. You can specify this source.

See Also:

InputDeviceConfiguredInput

configuredInputAsString

public final String configuredInputAsString()

The source at the input device that is currently active. You can specify this source.

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

Returns:

The source at the input device that is currently active. You can specify this source.

See Also:

InputDeviceConfiguredInput

deviceState

public final InputDeviceState deviceState()

The state of the input device.

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

Returns:

The state of the input device.

See Also:

InputDeviceState

deviceStateAsString

public final String deviceStateAsString()

The state of the input device.

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

Returns:

The state of the input device.

See Also:

InputDeviceState

framerate

public final Double framerate()

The frame rate of the video source.

Returns:

The frame rate of the video source.

height

public final Integer height()

The height of the video source, in pixels.

Returns:

The height of the video source, in pixels.

maxBitrate

public final Integer maxBitrate()

The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.

Returns:

The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.

scanType

public final InputDeviceScanType scanType()

The scan type of the video source.

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

Returns:

The scan type of the video source.

See Also:

InputDeviceScanType

scanTypeAsString

public final String scanTypeAsString()

The scan type of the video source.

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

Returns:

The scan type of the video source.

See Also:

InputDeviceScanType

width

public final Integer width()

The width of the video source, in pixels.

Returns:

The width of the video source, in pixels.

latencyMs

public final Integer latencyMs()

The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.

Returns:

The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.

codec

public final InputDeviceCodec codec()

The codec for the video that the device produces.

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

Returns:

The codec for the video that the device produces.

See Also:

InputDeviceCodec

codecAsString

public final String codecAsString()

The codec for the video that the device produces.

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

Returns:

The codec for the video that the device produces.

See Also:

InputDeviceCodec

mediaconnectSettings

public final InputDeviceMediaConnectSettings mediaconnectSettings()

Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.

Returns:

Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.

hasAudioChannelPairs

public final boolean hasAudioChannelPairs()

For responses, this returns true if the service returned a value for the AudioChannelPairs 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.

audioChannelPairs

public final List<InputDeviceUhdAudioChannelPairConfig> audioChannelPairs()

An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow.

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 hasAudioChannelPairs() method.

Returns:

An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow.

toBuilder

public InputDeviceUhdSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InputDeviceUhdSettings.Builder,InputDeviceUhdSettings>

builder

public static InputDeviceUhdSettings.Builder builder()

serializableBuilderClass

public static Class<? extends InputDeviceUhdSettings.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo