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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Event.Builder

Method Summary

Modifier and Type	Method	Description
static Event.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventErrorCode	errorCode()	If the event is an error event, the error code is provided to give insight into the specific error that occurred.
String	errorCodeAsString()	If the event is an error event, the error code is provided to give insight into the specific error that occurred.
Instant	eventTime()	ISO 8601 timestamp (returned as a string) for when the event occurred.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EventName	name()	The name of the event.
String	nameAsString()	The name of the event.
String	participantId()	Unique identifier for the participant who triggered the event.
String	remoteParticipantId()	Unique identifier for the remote participant.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Event.Builder>	serializableBuilderClass()
Event.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

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:

EventName

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:

EventName

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:

EventErrorCode

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:

EventErrorCode

toBuilder

public Event.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Event.Builder,Event>

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)

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