LIlivepeer
stream

Retrieve a stream

Changed on
get/stream/{id}

Request

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

Response

Success

idstring
namestring required
kindstring
userTagsobject

User input tags associated with the stream

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)

isActiveboolean

If currently active

isHealthyIsHealthy (unresolved $ref)
issuesHumanIssues (unresolved $ref)
createdByTokenNamestring

Name of the token used to create this object

createdAtnumber

Timestamp (in milliseconds) at which stream object was created

parentIdstring

Points to parent stream object

streamKeystring

Used to form RTMP ingest URL

playbackIdstring

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

projectIdstring

The ID of the project

recordboolean

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

suspendedboolean

If currently suspended

lastTerminatedAtnumber nullable

Timestamp (in milliseconds) when the stream was last terminated

userIdstring
renditionsobject

Changes

  • 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

  • 7c015b7e287cRevision changes
    • info

      added the optional property to the response with the status