Module Values.ParticipantSummarySource

Summary object describing a participant that has joined a stage.

Sourcetype nonrec t = {
  1. participantId : ParticipantId.t option;
    (*

    Unique identifier for this participant, assigned by IVS.

    *)
  2. userId : UserId.t option;
    (*

    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.

    *)
  3. state : ParticipantState.t option;
    (*

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

    *)
  4. firstJoinTime : Time.t option;
    (*

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

    *)
  5. published : Published.t option;
    (*

    Whether the participant ever published to the stage session.

    *)
  6. recordingState : ParticipantRecordingState.t option;
    (*

    The participant’s recording state.

    *)
  7. replicationType : ReplicationType.t option;
    (*

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

    *)
  8. replicationState : ReplicationState.t option;
    (*

    The participant's replication state.

    *)
  9. sourceStageArn : StageArn.t option;
    (*

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

    *)
  10. sourceSessionId : StageSessionId.t option;
    (*

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

    *)
  11. redundantIngest : RedundantIngest.t option;
    (*

    Indicates whether redundant ingest is enabled for the participant.

    *)
  12. ingestConfigurationArn : IngestConfigurationArn.t option;
    (*

    The participant’s ingest configuration.

    *)
}
Sourceval make : ?participantId:??? -> ?userId:??? -> ?state:??? -> ?firstJoinTime:??? -> ?published:??? -> ?recordingState:??? -> ?replicationType:??? -> ?replicationState:??? -> ?sourceStageArn:??? -> ?sourceSessionId:??? -> ?redundantIngest:??? -> ?ingestConfigurationArn:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Published.t | `Enum of string | `String of ParticipantId.t | `Timestamp of Time.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t