beta/
docs
/
overview
OverviewGuidesAPI Reference
Log inSign up
beta/
docs
/
overview
OverviewGuidesAPI Reference
Sign upLogin
API Reference
Introduction
Stream
The stream object
POST create a stream object

Stream

There are two types of stream objects.

  • A child stream object is a single live streaming session.
  • A parent stream object shows the configuration and metadata totals of all its child stream sessions.

Core concepts about the stream object parent-child relationship:

  • The parentId of a child-session stream object is same as the id of its parent stream object.
  • Child-session stream objects are read-only.
  • Parent stream objects are read-write.
  • The playback URL for a live (isActive: true) parent stream object is the same for all its sessions.
  • The recording playback URL for each completed live streaming session is unique and available as a parameter on the child-session stream object.

Attributes

JSON parameterTypeDescription
createdAtnumberTimestamp when the asset was created. Reported in Unix epoch time.
createdByTokenNamestringLivepeer.com user-assigned name for the API key that created the stream object.
idstringUnique identifier for the asset. The asset could be a livestream or single livestream session.
isActivebooleanTrue if the asset is active. An active livestream means segments are being ingested.
kindstringLivepeer.com API object type.
lastSeennumberTimestamp when the asset was last active. Reported in Unix epoch time. An active livestream means segments are being ingested.
namestringRequired with POST
Additional identifier for the asset. Often set to a human readable string. This identifier does not need to be unique.
parentIdstringPoints to a parent stream object. Only used on stream objects that represent a single livestream session.
playbackIdstringUnique identifier used to form the playback URL.
profilesarrayTranscoding rendition settings. The source will be delivered with the renditions in the HLS and does not need to be redefined in the profiles parameter. If no profiles are defined, only the source will be delivered for playback.
profiles..bitrateintegerminimum: 400
kbit/s setting for the transcoded rendition.
profiles..fpsintegerminimum: 0
Framerate setting for the transcoded rendition. When set to 0, the source framerate is adopted for the transcoded rendition framerate. All profiles for a source object must be configured with the same fps.
profiles..heightintegerminimum: 128
Pixel height setting for the transcoded rendition.
profiles..namestringminLength: 1, maxLength: 500
Identifier for the transcoded rendition settings.
profiles..widthintegerminimum: 128
Pixel width setting for the transcoded rendition.
record booleanOn a parent stream object, true means that new sessions are recorded, and false means they are not. On a child-session stream object, the value is read-only; true means that the session is actively being recorded or was recorded, and false means that the session is not being recorded or was not recorded.
sourceSegmentsnumberNumber of asset source segments processed.
sourceSegmentsDurationnumberDuration in seconds of asset source processed.
streamKeystringUnique secret key used to form the RTMP ingest URL.
transcodedSegmentsnumberNumber of asset transcoded rendition segments processed. Should be (sourceSegments * number of profiles).
transcodedSegmentsDurationnumberDuration in seconds of asset transcoded renditions processed. Should be (sourceSegmentsDuration * number of profiles).
userIDstringUnique identifier for the Livepeer.com user account that created the stream object.
Livepeer.com
beta
  • Company
  • Home
  • Contact
  • Team
  • Jobs
  • Livepeer, Inc.
  • 223 Bedford Ave PMB 530
    Brooklyn, NY 11211
  • [email protected]