Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlow.MediaStreamProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.MediaStreamProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.MediaStreamProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconnect.*;
 MediaStreamProperty mediaStreamProperty = MediaStreamProperty.builder()
         .mediaStreamId(123)
         .mediaStreamName("mediaStreamName")
         .mediaStreamType("mediaStreamType")
         // the properties below are optional
         .attributes(MediaStreamAttributesProperty.builder()
                 .fmtp(FmtpProperty.builder()
                         .channelOrder("channelOrder")
                         .colorimetry("colorimetry")
                         .exactFramerate("exactFramerate")
                         .par("par")
                         .range("range")
                         .scanMode("scanMode")
                         .tcs("tcs")
                         .build())
                 .lang("lang")
                 .build())
         .clockRate(123)
         .description("description")
         .fmt(123)
         .videoFormat("videoFormat")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.MediaStreamProperty.Builder	A builder for CfnFlow.MediaStreamProperty
static final class	CfnFlow.MediaStreamProperty.Jsii$Proxy	An implementation for CfnFlow.MediaStreamProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.MediaStreamProperty.Builder	builder()
default Object	getAttributes()	Attributes that are related to the media stream.
default Number	getClockRate()	The sample rate for the stream.
default String	getDescription()	A description that can help you quickly identify what your media stream is used for.
default Number	getFmt()	The format type number (sometimes referred to as RTP payload type) of the media stream.
Number	getMediaStreamId()	A unique identifier for the media stream.
String	getMediaStreamName()	A name that helps you distinguish one media stream from another.
String	getMediaStreamType()	The type of media stream.
default String	getVideoFormat()	The resolution of the video.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMediaStreamId

@Stability(Stable)
@NotNull
Number getMediaStreamId()

A unique identifier for the media stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamid

getMediaStreamName

@Stability(Stable)
@NotNull
String getMediaStreamName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamname

getMediaStreamType

@Stability(Stable)
@NotNull
String getMediaStreamType()

The type of media stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-mediastreamtype

getAttributes

@Stability(Stable)
@Nullable
default Object getAttributes()

Attributes that are related to the media stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-attributes

getClockRate

@Stability(Stable)
@Nullable
default Number getClockRate()

The sample rate for the stream.

This value in measured in kHz.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-clockrate

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-description

getFmt

@Stability(Stable)
@Nullable
default Number getFmt()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-fmt

getVideoFormat

@Stability(Stable)
@Nullable
default String getVideoFormat()

The resolution of the video.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-mediastream.html#cfn-mediaconnect-flow-mediastream-videoformat

builder

@Stability(Stable)
static CfnFlow.MediaStreamProperty.Builder builder()

Returns:

a CfnFlow.MediaStreamProperty.Builder of CfnFlow.MediaStreamProperty