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

Class AudioConfiguration

java.lang.Object

software.amazon.awssdk.services.ivs.model.AudioConfiguration

All Implemented Interfaces:

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

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

Object specifying a stream’s audio 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	AudioConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static AudioConfiguration.Builder	builder()
Long	channels()	Number of audio channels.
String	codec()	Codec used for the audio encoding.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	sampleRate()	Number of audio samples recorded per second.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AudioConfiguration.Builder>	serializableBuilderClass()
Long	targetBitrate()	The expected ingest bitrate (bits per second).
AudioConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	track()	Name of the audio track (if the stream has an audio track).

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

channels

public final Long channels()

Number of audio channels.

Returns:

Number of audio channels.

codec

public final String codec()

Codec used for the audio encoding.

Returns:

Codec used for the audio encoding.

sampleRate

public final Long sampleRate()

Number of audio samples recorded per second.

Returns:

Number of audio samples recorded per second.

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.

track

public final String track()

Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is track0 (the sole track).

Returns:

Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is track0 (the sole track).

toBuilder

public AudioConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AudioConfiguration.Builder,AudioConfiguration>

builder

public static AudioConfiguration.Builder builder()

serializableBuilderClass

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