Interface Event.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Event.Builder,Event>, SdkBuilder<Event.Builder,Event>, SdkPojo
Enclosing class:
Event
@Mutable @NotThreadSafe public static interface Event.Builder extends SdkPojo, CopyableBuilder<Event.Builder,Event>

  • Method Details

    • name

      Event.Builder name(String name)

      The name of the event.

      Parameters:
      name - The name of the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      Event.Builder name(EventName name)

      The name of the event.

      Parameters:
      name - The name of the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • participantId

      Event.Builder participantId(String participantId)

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

      Parameters:
      participantId - Unique identifier for the participant who triggered the event. This is assigned by IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTime

      Event.Builder eventTime(Instant eventTime)

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

      Parameters:
      eventTime - ISO 8601 timestamp (returned as a string) for when the event occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteParticipantId

      Event.Builder remoteParticipantId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • errorCode

      Event.Builder errorCode(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorCode

      Event.Builder errorCode(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationStageArn

      Event.Builder destinationStageArn(String destinationStageArn)

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

      Parameters:
      destinationStageArn - ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationSessionId

      Event.Builder destinationSessionId(String destinationSessionId)

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

      Parameters:
      destinationSessionId - ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replica

      Event.Builder replica(Boolean replica)

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

      Parameters:
      replica - If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.