Package com.amazonaws.ivs.broadcast

Class ParticipantInfo

java.lang.Object

com.amazonaws.ivs.broadcast.ParticipantInfo

@RequiresApi(api=28)
public class ParticipantInfo
extends Object

Information about a participant. The properties in this class will remain constant throughout its lifetime, with the exception of `userInfo`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ParticipantInfo.Capabilities

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,String>	attributes	Attributes associated with this participant
final EnumSet<ParticipantInfo.Capabilities>	capabilities	This represents the capabilities that can be performed on this participant, such as publish or subscribe.
final boolean	isLocal	This represents if the participant is local (associated with the token used on this device to join the Stage).
final String	participantId	An ID assigned to this participant, and it's guaranteed to be unique in one Stage session
final String	userId	A user ID associated with this participant
final HashMap<String,String>	userInfo	This object exists for use by the developer, to store information that might be associated with this participant.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

participantId

public final String participantId

An ID assigned to this participant, and it's guaranteed to be unique in one Stage session

userId

public final String userId

A user ID associated with this participant

isLocal

public final boolean isLocal

This represents if the participant is local (associated with the token used on this device to join the Stage).

capabilities

public final EnumSet<ParticipantInfo.Capabilities> capabilities

This represents the capabilities that can be performed on this participant, such as publish or subscribe.

userInfo

public final HashMap<String,String> userInfo

This object exists for use by the developer, to store information that might be associated with this participant. This object will never be accessed by the SDK, and changes will not be synced to remote SDK `userInfo` objects.

attributes

public final Map<String,String> attributes

Attributes associated with this participant