Class MediaStreamSourceConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MediaStreamSourceConfiguration.Builder,
MediaStreamSourceConfiguration>
The media stream that is associated with the source, and the parameters for that association.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final EncodingName
The format that was used to encode the data.final String
The format that was used to encode the data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputConfigurations property.final List
<InputConfiguration> The media streams that you want to associate with the source.final String
A name that helps you distinguish one media stream from another.static Class
<? extends MediaStreamSourceConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
encodingName
The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
If the service returns an enum value that is not available in the current SDK version,
encodingName
will returnEncodingName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingNameAsString()
.- Returns:
- The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
- See Also:
-
encodingNameAsString
The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
If the service returns an enum value that is not available in the current SDK version,
encodingName
will returnEncodingName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingNameAsString()
.- Returns:
- The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
- See Also:
-
hasInputConfigurations
public final boolean hasInputConfigurations()For responses, this returns true if the service returned a value for the InputConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
inputConfigurations
The media streams that you want to associate with the source.
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
hasInputConfigurations()
method.- Returns:
- The media streams that you want to associate with the source.
-
mediaStreamName
A name that helps you distinguish one media stream from another.
- Returns:
- A name that helps you distinguish one media stream from another.
-
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 interfaceToCopyableBuilder<MediaStreamSourceConfiguration.Builder,
MediaStreamSourceConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-