Class NdiMediaStreamInfo

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

Detailed information about a single media stream that is part of an NDI® source. This includes details about the stream type, codec, resolution, frame rate, audio channels, and sample rate.

See Also:

  • Method Details

    • streamType

      public final String streamType()

      The type of media stream (for example, Video or Audio).

      Returns:
      The type of media stream (for example, Video or Audio).

    • codec

      public final String codec()

      The codec used for the media stream. For NDI sources, use speed-hq.

      Returns:
      The codec used for the media stream. For NDI sources, use speed-hq.

    • streamId

      public final Integer streamId()

      A unique identifier for the media stream.

      Returns:
      A unique identifier for the media stream.

    • scanMode

      public final ScanMode scanMode()

      The method used to display video frames. Used when the streamType is Video.

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

      Returns:
      The method used to display video frames. Used when the streamType is Video.
      See Also:

    • scanModeAsString

      public final String scanModeAsString()

      The method used to display video frames. Used when the streamType is Video.

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

      Returns:
      The method used to display video frames. Used when the streamType is Video.
      See Also:

    • frameResolution

      public final FrameResolution frameResolution()

      The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

      Returns:
      The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

    • frameRate

      public final String frameRate()

      The number of video frames displayed per second. Used when the streamType is Video.

      Returns:
      The number of video frames displayed per second. Used when the streamType is Video.

    • channels

      public final Integer channels()

      The number of audio channels in the stream. Used when the streamType is Audio.

      Returns:
      The number of audio channels in the stream. Used when the streamType is Audio.

    • sampleRate

      public final Integer sampleRate()

      The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.

      Returns:
      The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.

    • toBuilder

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

    • builder

      public static NdiMediaStreamInfo.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.