Package software.amazon.awssdk.services.ivsrealtime.model

Class AutoParticipantRecordingConfiguration

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.AutoParticipantRecordingConfiguration

All Implemented Interfaces:

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

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

Object specifying a configuration for individual participant recording.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutoParticipantRecordingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static AutoParticipantRecordingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMediaTypes()	For responses, this returns true if the service returned a value for the MediaTypes property.
List<ParticipantRecordingMediaType>	mediaTypes()	Types of media to be recorded.
List<String>	mediaTypesAsStrings()	Types of media to be recorded.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutoParticipantRecordingConfiguration.Builder>	serializableBuilderClass()
String	storageConfigurationArn()	ARN of the StorageConfiguration resource to use for individual participant recording.
ParticipantThumbnailConfiguration	thumbnailConfiguration()	A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
AutoParticipantRecordingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

storageConfigurationArn

public final String storageConfigurationArn()

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

Returns:

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

mediaTypes

public final List<ParticipantRecordingMediaType> mediaTypes()

Types of media to be recorded. Default: AUDIO_VIDEO.

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 hasMediaTypes() method.

Returns:

Types of media to be recorded. Default: AUDIO_VIDEO.

hasMediaTypes

public final boolean hasMediaTypes()

For responses, this returns true if the service returned a value for the MediaTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

mediaTypesAsStrings

public final List<String> mediaTypesAsStrings()

Types of media to be recorded. Default: AUDIO_VIDEO.

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 hasMediaTypes() method.

Returns:

Types of media to be recorded. Default: AUDIO_VIDEO.

thumbnailConfiguration

public final ParticipantThumbnailConfiguration thumbnailConfiguration()

A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

Returns:

A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

toBuilder

public AutoParticipantRecordingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoParticipantRecordingConfiguration.Builder,AutoParticipantRecordingConfiguration>

builder

public static AutoParticipantRecordingConfiguration.Builder builder()

serializableBuilderClass

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