Interface Participant.Builder

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

  • Method Details

    • participantId

      Participant.Builder participantId(String participantId)

      Unique identifier for this participant, assigned by IVS.

      Parameters:
      participantId - Unique identifier for this participant, assigned by IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      Participant.Builder userId(String userId)

      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.

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

    • state

      Participant.Builder state(String state)

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

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Participant.Builder state(ParticipantState state)

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

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firstJoinTime

      Participant.Builder firstJoinTime(Instant firstJoinTime)

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

      Parameters:
      firstJoinTime - ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Participant.Builder attributes(Map<String,String> attributes)

      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.

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

    • published

      Participant.Builder published(Boolean published)

      Whether the participant ever published to the stage session.

      Parameters:
      published - Whether the participant ever published to the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ispName

      Participant.Builder ispName(String ispName)

      The participant’s Internet Service Provider.

      Parameters:
      ispName - The participant’s Internet Service Provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • osName

      Participant.Builder osName(String osName)

      The participant’s operating system.

      Parameters:
      osName - The participant’s operating system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • osVersion

      Participant.Builder osVersion(String osVersion)

      The participant’s operating system version.

      Parameters:
      osVersion - The participant’s operating system version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserName

      Participant.Builder browserName(String browserName)

      The participant’s browser.

      Parameters:
      browserName - The participant’s browser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserVersion

      Participant.Builder browserVersion(String browserVersion)

      The participant’s browser version.

      Parameters:
      browserVersion - The participant’s browser version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sdkVersion

      Participant.Builder sdkVersion(String sdkVersion)

      The participant’s SDK version.

      Parameters:
      sdkVersion - The participant’s SDK version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordingS3BucketName

      Participant.Builder recordingS3BucketName(String recordingS3BucketName)

      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.

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

    • recordingS3Prefix

      Participant.Builder recordingS3Prefix(String recordingS3Prefix)

      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.

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

    • recordingState

      Participant.Builder recordingState(String recordingState)

      The participant’s recording state.

      Parameters:
      recordingState - The participant’s recording state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recordingState

      Participant.Builder recordingState(ParticipantRecordingState recordingState)

      The participant’s recording state.

      Parameters:
      recordingState - The participant’s recording state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      Participant.Builder protocol(String protocol)

      Type of ingest protocol that the participant employs for broadcasting.

      Parameters:
      protocol - Type of ingest protocol that the participant employs for broadcasting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      Participant.Builder protocol(ParticipantProtocol protocol)

      Type of ingest protocol that the participant employs for broadcasting.

      Parameters:
      protocol - Type of ingest protocol that the participant employs for broadcasting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationType

      Participant.Builder replicationType(String replicationType)

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

      Parameters:
      replicationType - Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationType

      Participant.Builder replicationType(ReplicationType replicationType)

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

      Parameters:
      replicationType - Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationState

      Participant.Builder replicationState(String replicationState)

      The participant's replication state.

      Parameters:
      replicationState - The participant's replication state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationState

      Participant.Builder replicationState(ReplicationState replicationState)

      The participant's replication state.

      Parameters:
      replicationState - The participant's replication state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceStageArn

      Participant.Builder sourceStageArn(String sourceStageArn)

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

      Parameters:
      sourceStageArn - Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceSessionId

      Participant.Builder sourceSessionId(String sourceSessionId)

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

      Parameters:
      sourceSessionId - ID of the session within the source stage, if replicationType is REPLICA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.