LIlivepeer
session

Retrieve a session

Changed on
get/session/{id}

Request

  • Base URL
    https://livepeer.studio/api
  • URL
    https://livepeer.studio/api/session/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the session

Response

Success

idstring
kindstring
userIdstring
namestring required
lastSeennumber
sourceSegmentsnumber
transcodedSegmentsnumber
sourceSegmentsDurationnumber

Duration of all the source segments, sec

transcodedSegmentsDurationnumber

Duration of all the transcoded segments, sec

sourceBytesnumber
transcodedBytesnumber
ingestRatenumber

Rate at which sourceBytes increases (bytes/second)

outgoingRatenumber

Rate at which transcodedBytes increases (bytes/second)

isHealthyIsHealthy (unresolved $ref)
issuesHumanIssues (unresolved $ref)
createdAtnumber

Timestamp (in milliseconds) at which stream object was created

parentIdstring

Points to parent stream object

projectIdstring

The ID of the project

recordboolean

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

recordingStatus'waiting' | 'ready' | 'failed' | 'deleted' | 'none'

The status of the recording process of this stream session.

recordingUrlstring

URL for accessing the recording of this stream session.

mp4Urlstring

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

playbackIdstring

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

profilesProfiles (unresolved $ref)
recordingSpecRecordingSpec (unresolved $ref)

Changes

  • b9ec2e3c4b79Revision changes
    • warning

      added the new deleted enum value to the response property for the response status

  • 82356f03be94Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • warning

      added the new HEVC enum value to the /// response property for the response status

    • warning

      added the new VP8 enum value to the /// response property for the response status

    • warning

      added the new VP9 enum value to the /// response property for the response status

    • info

      the response's property default value {"name":"240p0","fps":0,"bitrate":250000,"width":426,"height":240} {"name":"360p0","fps":0,"bitrate":800000,"width":640,"height":360} {"name":"480p0","fps":0,"bitrate":1600000,"width":854,"height":480} {"name":"720p0","fps":0,"bitrate":3000000,"width":1280,"height":720} was added for the status