GET
/
stream
/
{parentId}
/
sessions
curl --request GET \
  --url https://livepeer.studio/api/stream/{parentId}/sessions \
  --header 'Authorization: Bearer <api-key>'
[
  {
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "kind": "stream",
    "userId": "66E2161C-7670-4D05-B71D-DA2D6979556F",
    "name": "test_session",
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isHealthy": null,
    "issues": null,
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "record": true,
    "recordingStatus": "waiting",
    "recordingUrl": "<string>",
    "mp4Url": "<string>",
    "playbackId": "eaw4nk06ts2d0mzb",
    "profiles": [
      {
        "width": 1280,
        "name": "720p",
        "height": 129,
        "bitrate": 3000000,
        "fps": 30,
        "fpsDen": 1,
        "quality": 23,
        "gop": 2,
        "profile": "H264Baseline",
        "encoder": "H.264"
      }
    ]
  }
]

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

parentId
string
required

ID of the parent stream

Query Parameters

record
integer

Flag indicating if the response should only include recorded sessions

Response

200 - application/json
id
string
kind
string
deprecated
userId
string
deprecated
name
string
required
lastSeen
number
sourceSegments
number
transcodedSegments
number
sourceSegmentsDuration
number

Duration of all the source segments, sec

transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

sourceBytes
number
transcodedBytes
number
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

isHealthy
boolean | null

Indicates whether the stream is healthy or not.

issues
string[] | null

A string array of human-readable errors describing issues affecting the stream, if any.

createdAt
number

Timestamp (in milliseconds) at which stream object was created

parentId
string

Points to parent stream object

record
boolean

Whether the stream should be recorded. Uses default settings. For more customization, create and configure an object store.

recordingStatus
enum<string>

The status of the recording process of this stream session.

Available options:
waiting,
ready,
none
recordingUrl
string

URL for accessing the recording of this stream session.

mp4Url
string

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

playbackId
string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

profiles
object[]