Module Values.StreamSummarySource

Summary information about a stream.

Sourcetype nonrec t = {
  1. channelArn : ChannelArn.t option;
    (*

    Channel ARN for the stream.

    *)
  2. streamId : StreamId.t option;
    (*

    Unique identifier for a live or previously live stream in the specified channel.

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

    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

    *)
  4. health : StreamHealth.t option;
    (*

    The stream’s health.

    *)
  5. viewerCount : StreamViewerCount.t option;
    (*

    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

    *)
  6. startTime : StreamStartTime.t option;
    (*

    Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

    *)
}
Sourceval make : ?channelArn:??? -> ?streamId:??? -> ?state:??? -> ?health:??? -> ?viewerCount:??? -> ?startTime:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Long of StreamViewerCount.t | `String of ChannelArn.t | `Timestamp of StreamStartTime.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