Skip to content

Add livestream session info #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xcadams merged 4 commits into from
Jan 24, 2023
Merged

Add livestream session info #312

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fcbdad1
Add livestream session info
Shih-Yu Jan 18, 2023
a8cc5be
Fix formating
Shih-Yu Jan 19, 2023
c63507b
Update pages/reference/api/create-stream.en-US.mdx
Shih-Yu Jan 23, 2023
aaf8d97
fix: move to callout
0xcadams Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions pages/reference/api/create-stream.en-US.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@
title: POST Create stream
---

import { Callout } from 'nextra-theme-docs';

# `POST` Create a stream

`POST /stream` creates a `stream` object. The configuration on this parent
`stream` object is inherited by all future child `session` objects.

It is important to note, that the stream object is the core building block of the Livepeer Studio platform.
In Livepeer Studio, the stream object has unique configuration data and metadata about all livestream sessions that are associated with the stream.

<Callout>
Historically, a stream object with a `parentId` represented a single
livestream session. This type of "child-session" stream object will be
deprecated in an upcoming version of the API in favor of the session object.
</Callout>

The only parameter you are required to set is the `name` of your stream, but we
also highly recommend that you define the `profiles` parameter with 720p, 480p
and 360p renditions.
Expand Down