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:

  • Method Details

    • 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. To disable individual participant recording, set this to ""; other fields in this object will get reset to their defaults when sending "".

      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. To disable individual participant recording, set this to ""; other fields in this object will get reset to their defaults when sending "".

    • 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.

    • recordingReconnectWindowSeconds

      public final Integer recordingReconnectWindowSeconds()

      If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.

      The default value is 0, which disables merging.

      Returns:
      If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.

      The default value is 0, which disables merging.

    • hlsConfiguration

      public final ParticipantRecordingHlsConfiguration hlsConfiguration()

      HLS configuration object for individual participant recording.

      Returns:
      HLS configuration object for individual participant recording.

    • recordParticipantReplicas

      public final Boolean recordParticipantReplicas()

      Optional field to disable replica participant recording. If this is set to false when a participant is a replica, replica participants are not recorded. Default: true.

      Returns:
      Optional field to disable replica participant recording. If this is set to false when a participant is a replica, replica participants are not recorded. Default: true.

    • toBuilder

      public AutoParticipantRecordingConfiguration.Builder 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 interface ToCopyableBuilder<AutoParticipantRecordingConfiguration.Builder,AutoParticipantRecordingConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.