Package software.amazon.awssdk.services.ivs.model

Class VideoConfiguration

java.lang.Object

software.amazon.awssdk.services.ivs.model.VideoConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VideoConfiguration.Builder,VideoConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class VideoConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VideoConfiguration.Builder,VideoConfiguration>

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VideoConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	avcLevel()	Indicates the degree of required decoder performance for a profile.
String	avcProfile()	Indicates to the decoder the requirements for decoding the stream.
static VideoConfiguration.Builder	builder()
String	codec()	Codec used for the video encoding.
String	encoder()	Software or hardware used to encode the video.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	level()	Indicates the degree of required decoder performance for a profile.
String	profile()	Indicates to the decoder the requirements for decoding the stream.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VideoConfiguration.Builder>	serializableBuilderClass()
Long	targetBitrate()	The expected ingest bitrate (bits per second).
Long	targetFramerate()	The expected ingest framerate.
VideoConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	track()	Name of the video track.
Long	videoHeight()	Video-resolution height in pixels.
Long	videoWidth()	Video-resolution width in pixels.

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

avcLevel

public final String avcLevel()

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

Returns:

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

avcProfile

public final String avcProfile()

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

Returns:

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

codec

public final String codec()

Codec used for the video encoding.

Returns:

Codec used for the video encoding.

encoder

public final String encoder()

Software or hardware used to encode the video.

Returns:

Software or hardware used to encode the video.

level

public final String level()

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as avcLevel.

Returns:

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as avcLevel.

profile

public final String profile()

Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as avcProfile.

Returns:

Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as avcProfile.

targetBitrate

public final Long targetBitrate()

The expected ingest bitrate (bits per second). This is configured in the encoder.

Returns:

The expected ingest bitrate (bits per second). This is configured in the encoder.

targetFramerate

public final Long targetFramerate()

The expected ingest framerate. This is configured in the encoder.

Returns:

The expected ingest framerate. This is configured in the encoder.

track

public final String track()

Name of the video track. If multitrack is not enabled, this is track0 (the sole track).

Returns:

Name of the video track. If multitrack is not enabled, this is track0 (the sole track).

videoHeight

public final Long videoHeight()

Video-resolution height in pixels.

Returns:

Video-resolution height in pixels.

videoWidth

public final Long videoWidth()

Video-resolution width in pixels.

Returns:

Video-resolution width in pixels.

toBuilder

public VideoConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VideoConfiguration.Builder,VideoConfiguration>

builder

public static VideoConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo