Overview

The Sessions API is used to retrieve sessions object from pipeline.

Session Object

id · string

Unique identifier for the session.

name · string

Name of the session.

lastSeen · number

Timestamp of the last activity in the session.

sourceSegments · number

Number of source segments in the session.

transcodedSegments · number

Number of transcoded segments in the session.

sourceSegmentsDuration · number

Duration of all the source segments in seconds.

transcodedSegmentsDuration · number

Duration of all the transcoded segments in seconds.

sourceBytes · number

Total bytes of source segments.

transcodedBytes · number

Total bytes of transcoded segments.

ingestRate · number

Rate at which sourceBytes increases (bytes/second).

outgoingRate · number

Rate at which transcodedBytes increases (bytes/second).

isHealthy · object

Reference to the stream-health-payload schema for health status.

issues · object

Reference to the stream-health-payload schema for human-readable issues.

createdAt · number

Timestamp (in milliseconds) at which the session was created.

parentId · string

Identifier of the parent stream object.

record · boolean

Indicates whether the stream should be recorded.

recordingStatus · string

Status of the recording process of this stream session.

recordingUrl · string

URL for accessing the recording of this stream session.

mp4Url · string

URL for the stream session recording packaged in an MP4 format.

playbackId · string

Identifier used to form the playback URL.

profiles · array

Array of profiles detailing various streaming qualities.

Response

{
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "name": "test_session",
  "lastSeen": 1587667174725,
  "sourceSegments": 1,
  "transcodedSegments": 2,
  "sourceSegmentsDuration": 1,
  "transcodedSegmentsDuration": 2,
  "sourceBytes": 1,
  "transcodedBytes": 2,
  "ingestRate": 1,
  "outgoingRate": 2,
  "isHealthy": true,
  "issues": [
    "Buffer underflow",
    "Network congestion"
  ],
  "createdAt": 1587667174725,
  "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "record": "boolean",
  "recordingStatus": "waiting",
  "recordingUrl": "https://lp-playback.com/hls/29eb9byolvwdbkue/index.m3u8",
  "mp4Url": "https://lp-playback.com/hls/29eb9byolvwdqkue/720.mp4",
  "playbackId": "eaw4nk06ts2d0mzb",
  "profiles": [
    {
      "name": "720p",
      "width": 1280,
      "height": 720,
      "bitrate": 3000,
      "fps": 30
    }
  ]
}