Class Event

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

An occurrence during a stage session.

See Also:

  • Method Details

    • name

      public final EventName name()

      The name of the event.

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

      Returns:
      The name of the event.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the event.

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

      Returns:
      The name of the event.
      See Also:

    • participantId

      public final String participantId()

      Unique identifier for the participant who triggered the event. This is assigned by IVS.

      Returns:
      Unique identifier for the participant who triggered the event. This is assigned by IVS.

    • eventTime

      public final Instant eventTime()

      ISO 8601 timestamp (returned as a string) for when the event occurred.

      Returns:
      ISO 8601 timestamp (returned as a string) for when the event occurred.

    • remoteParticipantId

      public final String remoteParticipantId()

      Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

      Returns:
      Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

    • errorCode

      public final EventErrorCode errorCode()

      If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

      • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

      • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

      • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

      • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

      • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

      • INVALID_INPUT — The participant is using an invalid input stream.

      • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

      • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

      • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

      • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

      • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

      • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

      • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

      • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

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

      Returns:
      If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

      • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

      • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

      • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

      • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

      • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

      • INVALID_INPUT — The participant is using an invalid input stream.

      • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

      • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

      • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

      • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

      • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

      • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

      • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

      • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

      • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

      • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

      • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

      • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

      • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

      • INVALID_INPUT — The participant is using an invalid input stream.

      • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

      • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

      • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

      • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

      • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

      • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

      • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

      • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

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

      Returns:
      If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.

      • B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.

      • BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.

      • INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.

      • INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.

      • INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.

      • INVALID_INPUT — The participant is using an invalid input stream.

      • INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.

      • INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.

      • INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.

      • PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.

      • QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.

      • RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.

      • REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.

      • STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

      See Also:

    • destinationStageArn

      public final String destinationStageArn()

      ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

      Returns:
      ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

    • destinationSessionId

      public final String destinationSessionId()

      ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

      Returns:
      ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

    • replica

      public final Boolean replica()

      If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.

      Returns:
      If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.

    • toBuilder

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

    • builder

      public static Event.Builder builder()

    • serializableBuilderClass

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