Module Values.EventSource

An occurrence during a stage session.

Sourcetype nonrec t = {
  1. name : EventName.t option;
    (*

    The name of the event.

    *)
  2. participantId : ParticipantId.t option;
    (*

    Unique identifier for the participant who triggered the event. This is assigned by IVS.

    *)
  3. eventTime : Time.t option;
    (*

    ISO 8601 timestamp (returned as a string) for when the event occurred.

    *)
  4. remoteParticipantId : ParticipantId.t option;
    (*

    Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

    *)
  5. errorCode : EventErrorCode.t option;
    (*

    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. B_FRAME_PRESENT β€” The participant's stream includes B-frames. For details, see IVS RTMP Publishing. BITRATE_EXCEEDED β€” The participant exceeded the maximum supported bitrate. For details, see Service Quotas. INSUFFICIENT_CAPABILITIES β€” The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken. INTERNAL_SERVER_EXCEPTION β€” The participant failed to publish to the stage due to an internal server error. INVALID_AUDIO_CODEC β€” The participant is using an invalid audio codec. For details, see Stream Ingest. INVALID_INPUT β€” The participant is using an invalid input stream. INVALID_PROTOCOL β€” The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing. INVALID_STREAM_KEY β€” The participant is using an invalid stream key. For details, see IVS RTMP Publishing. INVALID_VIDEO_CODEC β€” The participant is using an invalid video codec. For details, see Stream Ingest. PUBLISHER_NOT_FOUND β€” The participant tried to subscribe to a publisher that doesn’t exist. QUOTA_EXCEEDED β€” The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas. RESOLUTION_EXCEEDED β€” The participant exceeded the maximum supported resolution. For details, see Service Quotas. REUSE_OF_STREAM_KEY β€” The participant tried to use a stream key that is associated with another active stage session. STREAM_DURATION_EXCEEDED β€” The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.

    *)
  6. destinationStageArn : StageArn.t option;
    (*

    ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

    *)
  7. destinationSessionId : StageSessionId.t option;
    (*

    ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.

    *)
  8. replica : Replica.t option;
    (*

    If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.

    *)
  9. previousToken : ExchangedParticipantToken.t option;
    (*

    Source participant token for TOKEN_EXCHANGED event.

    *)
  10. newToken : ExchangedParticipantToken.t option;
    (*

    Participant token created during TOKEN_EXCHANGED event.

    *)
}
Sourceval make : ?name:??? -> ?participantId:??? -> ?eventTime:??? -> ?remoteParticipantId:??? -> ?errorCode:??? -> ?destinationStageArn:??? -> ?destinationSessionId:??? -> ?replica:??? -> ?previousToken:??? -> ?newToken:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Replica.t | `Enum of string | `String of ParticipantId.t | `Structure of (string * [> `List of [> `Enum of string ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of ParticipantTokenUserId.t | `Timestamp of ParticipantTokenExpirationTime.t ]) list | `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