Class InputDeviceUhdSettings

    • Method Detail

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

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)