Package software.amazon.awssdk.services.mediaconnect.model

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 single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MediaStream.Builder

Method Summary

Modifier and Type	Method	Description
MediaStreamAttributes	attributes()	Attributes that are related to the media stream.
static MediaStream.Builder	builder()
Integer	clockRate()	The sample rate for the stream.
String	description()	A description that can help you quickly identify what your media stream is used for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fmt()	The format type number (sometimes referred to as RTP payload type) of the media stream.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	mediaStreamId()	A unique identifier for the media stream.
String	mediaStreamName()	A name that helps you distinguish one media stream from another.
MediaStreamType	mediaStreamType()	The type of media stream.
String	mediaStreamTypeAsString()	The type of media stream.
List<SdkField<?>>	sdkFields()
static Class<? extends MediaStream.Builder>	serializableBuilderClass()
MediaStream.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	videoFormat()	The resolution of the video.

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

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:

MediaStreamType

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:

MediaStreamType

videoFormat

public final String videoFormat()

The resolution of the video.

Returns:

The resolution of the video.

toBuilder

public MediaStream.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MediaStream.Builder,MediaStream>

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)

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