GET
/
stream
/
{parentId}
/
sessions
Authorization
Path
Query
curl --request GET \
  --url https://livepeer.studio/api/stream/{parentId}/sessions \
  --header 'Authorization: <authorization>'
[
  {
    "createdAt": 1587667174725,
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "ingestRate": 1,
    "isHealthy": true,
    "issues": [
      "<string>"
    ],
    "lastSeen": 1587667174725,
    "mp4Url": "<string>",
    "name": "test_session",
    "outgoingRate": 2,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "playbackId": "eaw4nk06ts2d0mzb",
    "profiles": [
      {
        "bitrate": 401,
        "encoder": "h264",
        "fps": 123,
        "fpsDen": 2,
        "gop": "<string>",
        "height": 129,
        "name": "720p",
        "profile": "H264Baseline",
        "width": 129
      }
    ],
    "record": true,
    "recordingStatus": "waiting",
    "recordingUrl": "<string>",
    "sourceBytes": 1,
    "sourceSegments": 1,
    "sourceSegmentsDuration": 1,
    "transcodedBytes": 2,
    "transcodedSegments": 2,
    "transcodedSegmentsDuration": 2
  }
]

Authorizations

Authorization
string
headerrequired

Bearer api-key

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
createdAt
number

Timestamp (in milliseconds) at which stream object was created

id
string
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

isHealthy
boolean

Indicates whether the stream is healthy or not.

issues
string[]

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

lastSeen
number
mp4Url
string

URL for the stream session recording packaged in an mp4.

name
string
required
outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

parentId
string

Points to parent stream object

playbackId
string

Used to form playback URL

profiles
object[]
record
boolean

Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.

recordingStatus
enum<string>

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.

sourceBytes
number
sourceSegments
number
sourceSegmentsDuration
number

Duration of all the source segments, sec

transcodedBytes
number
transcodedSegments
number
transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

Was this page helpful?

Retrieve all sessionsRetrieve clips of a session