Class: Aws::IVSRealTime::Types::Participant

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::Participant

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

Object describing a participant that has joined a stage.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

  Application-provided attributes to encode into the token and attach to a stage.

• #browser_name ⇒ String

  The participant’s browser.

• #browser_version ⇒ String

  The participant’s browser version.

• #first_join_time ⇒ Time

  ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

• #isp_name ⇒ String

  The participant’s Internet Service Provider.

• #os_name ⇒ String

  The participant’s operating system.

• #os_version ⇒ String

  The participant’s operating system version.

• #participant_id ⇒ String

  Unique identifier for this participant, assigned by IVS.

• #protocol ⇒ String

  Type of ingest protocol that the participant employs for broadcasting.

• #published ⇒ Boolean

  Whether the participant ever published to the stage session.

• #recording_s3_bucket_name ⇒ String

  Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or ‘“”` (empty string), if recording is not enabled.

• #recording_s3_prefix ⇒ String

  S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or ‘“”` (empty string), if recording is not enabled.

• #recording_state ⇒ String

  The participant’s recording state.

• #replication_state ⇒ String

  The participant’s replication state.

• #replication_type ⇒ String

  Indicates if the participant has been replicated to another stage or is a replica from another stage.

• #sdk_version ⇒ String

  The participant’s SDK version.

• #source_session_id ⇒ String

  ID of the session within the source stage, if ‘replicationType` is `REPLICA`.

• #source_stage_arn ⇒ String

  Source stage ARN from which this participant is replicated, if ‘replicationType` is `REPLICA`.

• #state ⇒ String

  Whether the participant is connected to or disconnected from the stage.

• #user_id ⇒ String

  Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information*.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#browser_name ⇒ String

The participant’s browser.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#browser_version ⇒ String

The participant’s browser version.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#first_join_time ⇒ Time

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Returns:

• (Time)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#isp_name ⇒ String

The participant’s Internet Service Provider.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#os_name ⇒ String

The participant’s operating system.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#os_version ⇒ String

The participant’s operating system version.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

Unique identifier for this participant, assigned by IVS.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

Type of ingest protocol that the participant employs for broadcasting.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#published ⇒ Boolean

Whether the participant ever published to the stage session.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#recording_s3_bucket_name ⇒ String

Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or ‘“”` (empty string), if recording is not enabled.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#recording_s3_prefix ⇒ String

S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or ‘“”` (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See [ Merge Fragmented Individual Participant Recordings](/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag).

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#recording_state ⇒ String

The participant’s recording state.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#replication_state ⇒ String

The participant’s replication state.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#replication_type ⇒ String

Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: ‘NONE`.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#sdk_version ⇒ String

The participant’s SDK version.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_session_id ⇒ String

ID of the session within the source stage, if ‘replicationType` is `REPLICA`.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#source_stage_arn ⇒ String

Source stage ARN from which this participant is replicated, if ‘replicationType` is `REPLICA`.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Whether the participant is connected to or disconnected from the stage.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information*.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2123

class Participant < Struct.new(
  :participant_id,
  :user_id,
  :state,
  :first_join_time,
  :attributes,
  :published,
  :isp_name,
  :os_name,
  :os_version,
  :browser_name,
  :browser_version,
  :sdk_version,
  :recording_s3_bucket_name,
  :recording_s3_prefix,
  :recording_state,
  :protocol,
  :replication_type,
  :replication_state,
  :source_stage_arn,
  :source_session_id)
  SENSITIVE = []
  include Aws::Structure
end