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

Stream

The stream object represents a livestream. When the stream object has a parentId attribute, it represents a single livestream session.

Create a stream object to create a livestream with configuration details for live broadcasting software and generate a playback URL for stream viewers. name is the only parameter required to POST.

POST /stream

You can also retrieve the stream object to get stream (or livestream session) status, transcoding settings and attributes.

GET /stream

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.
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]