Class MediaStream

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

A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.

See Also:

  • Method Details

    • attributes

      public final MediaStreamAttributes attributes()

      Attributes that are related to the media stream.

      Returns:
      Attributes that are related to the media stream.

    • clockRate

      public final Integer clockRate()

      The sample rate for the stream. This value is measured in Hz.

      Returns:
      The sample rate for the stream. This value is measured in Hz.

    • description

      public final String description()

      A description that can help you quickly identify what your media stream is used for.

      Returns:
      A description that can help you quickly identify what your media stream is used for.

    • fmt

      public final Integer fmt()

      The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

      Returns:
      The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

    • mediaStreamId

      public final Integer mediaStreamId()

      A unique identifier for the media stream.

      Returns:
      A unique identifier for the media stream.

    • mediaStreamName

      public final String mediaStreamName()

      A name that helps you distinguish one media stream from another.

      Returns:
      A name that helps you distinguish one media stream from another.

    • mediaStreamType

      public final MediaStreamType mediaStreamType()

      The type of media stream.

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

      Returns:
      The type of media stream.
      See Also:

    • mediaStreamTypeAsString

      public final String mediaStreamTypeAsString()

      The type of media stream.

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

      Returns:
      The type of media stream.
      See Also:

    • videoFormat

      public final String videoFormat()

      The resolution of the video.

      Returns:
      The resolution of the video.

    • toBuilder

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

    • builder

      public static MediaStream.Builder builder()

    • serializableBuilderClass

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