Class AttendeeCapabilities

java.lang.Object
software.amazon.awssdk.services.chimesdkmeetings.model.AttendeeCapabilities
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AttendeeCapabilities.Builder,AttendeeCapabilities>
@Generated("software.amazon.awssdk:codegen") public final class AttendeeCapabilities extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttendeeCapabilities.Builder,AttendeeCapabilities>

The media capabilities of an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to and .

When using capabilities, be aware of these corner cases:

  • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

  • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and an attendee unmutes their microphone, audio flows from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

See Also:

  • Method Details

    • audio

      public final MediaCapabilities audio()

      The audio capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, audio will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioAsString().

      Returns:
      The audio capability assigned to an attendee.
      See Also:

    • audioAsString

      public final String audioAsString()

      The audio capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, audio will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioAsString().

      Returns:
      The audio capability assigned to an attendee.
      See Also:

    • video

      public final MediaCapabilities video()

      The video capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, video will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoAsString().

      Returns:
      The video capability assigned to an attendee.
      See Also:

    • videoAsString

      public final String videoAsString()

      The video capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, video will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from videoAsString().

      Returns:
      The video capability assigned to an attendee.
      See Also:

    • content

      public final MediaCapabilities content()

      The content capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, content will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentAsString().

      Returns:
      The content capability assigned to an attendee.
      See Also:

    • contentAsString

      public final String contentAsString()

      The content capability assigned to an attendee.

      If the service returns an enum value that is not available in the current SDK version, content will return MediaCapabilities.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentAsString().

      Returns:
      The content capability assigned to an attendee.
      See Also:

    • toBuilder

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

    • builder

      public static AttendeeCapabilities.Builder builder()

    • serializableBuilderClass

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