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

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

Overview

Object describing a participant that has joined a stage.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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>) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#browser_name ⇒ String

The participant’s browser.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#browser_version ⇒ String

The participant’s browser version.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  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) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#isp_name ⇒ String

The participant’s Internet Service Provider.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#os_name ⇒ String

The participant’s operating system.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#os_version ⇒ String

The participant’s operating system version.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

Unique identifier for this participant, assigned by IVS.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

Type of ingest protocol that the participant employs for broadcasting.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#published ⇒ Boolean

Whether the participant ever published to the stage session.

Returns:

  • (Boolean) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  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) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  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.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#recording_state ⇒ String

The participant’s recording state.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#sdk_version ⇒ String

The participant’s SDK version.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  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) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1884

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)
  SENSITIVE = []
  include Aws::Structure
end