Class: Aws::IVSRealTime::Types::Event

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

An occurrence during a stage session.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_session_id ⇒ String

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

Returns:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_stage_arn ⇒ String

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

Returns:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

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:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#event_time ⇒ Time

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

Returns:

  • (Time) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the event.

Returns:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#new_token ⇒ Types::ExchangedParticipantToken

Participant token created during TOKEN_EXCHANGED event.

Returns:



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

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

Returns:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#previous_token ⇒ Types::ExchangedParticipantToken

Source participant token for TOKEN_EXCHANGED event.

Returns:



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#remote_participant_id ⇒ String

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:

  • (String) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end

#replica ⇒ Boolean

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

Returns:

  • (Boolean) 


1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1016

class Event < Struct.new(
  :name,
  :participant_id,
  :event_time,
  :remote_participant_id,
  :error_code,
  :destination_stage_arn,
  :destination_session_id,
  :replica,
  :previous_token,
  :new_token)
  SENSITIVE = []
  include Aws::Structure
end