From fcbdad16ebc595ccd5c73bd909129b49674e89b8 Mon Sep 17 00:00:00 2001 From: Shih-Yu Hwang <53620329+Shih-Yu@users.noreply.github.com> Date: Wed, 18 Jan 2023 17:04:16 -0600 Subject: [PATCH 1/4] Add livestream session info Fixing issue related to https://github.com/livepeer/docs/issues/308 --- pages/reference/api/create-stream.en-US.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pages/reference/api/create-stream.en-US.mdx b/pages/reference/api/create-stream.en-US.mdx index 3cc4ee16b..d0f3e922f 100644 --- a/pages/reference/api/create-stream.en-US.mdx +++ b/pages/reference/api/create-stream.en-US.mdx @@ -7,6 +7,13 @@ title: POST Create 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. + + +Note: historically, a stream object with a parentIdrepresented 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. + + 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. From a8cc5be2e1263a713a8b3d683d0d57cf28e24574 Mon Sep 17 00:00:00 2001 From: Shih-Yu Hwang <53620329+Shih-Yu@users.noreply.github.com> Date: Thu, 19 Jan 2023 09:48:46 -0600 Subject: [PATCH 2/4] Fix formating --- pages/reference/api/create-stream.en-US.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/reference/api/create-stream.en-US.mdx b/pages/reference/api/create-stream.en-US.mdx index d0f3e922f..997bbaa29 100644 --- a/pages/reference/api/create-stream.en-US.mdx +++ b/pages/reference/api/create-stream.en-US.mdx @@ -10,9 +10,9 @@ title: POST Create stream 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. - -Note: historically, a stream object with a parentIdrepresented 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. - + +>Note: historically, a stream object with a parentIdrepresented 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. + 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 From c63507b1b591a62ad5eb8ea2877b9bcff909373b Mon Sep 17 00:00:00 2001 From: Shih-Yu Hwang <53620329+Shih-Yu@users.noreply.github.com> Date: Mon, 23 Jan 2023 16:18:58 -0600 Subject: [PATCH 3/4] Update pages/reference/api/create-stream.en-US.mdx Co-authored-by: Chase Adams --- pages/reference/api/create-stream.en-US.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/reference/api/create-stream.en-US.mdx b/pages/reference/api/create-stream.en-US.mdx index 997bbaa29..92306aa6b 100644 --- a/pages/reference/api/create-stream.en-US.mdx +++ b/pages/reference/api/create-stream.en-US.mdx @@ -11,7 +11,7 @@ It is important to note, that the stream object is the core building block of th In Livepeer Studio, the stream object has unique configuration data and metadata about all livestream sessions that are associated with the stream. ->Note: historically, a stream object with a parentIdrepresented 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. +>Note: 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. The only parameter you are required to set is the `name` of your stream, but we From aaf8d978bbecaaec06606074ea768e1914e2c2fc Mon Sep 17 00:00:00 2001 From: Chase Adams Date: Tue, 24 Jan 2023 09:24:24 -0700 Subject: [PATCH 4/4] fix: move to callout --- pages/reference/api/create-stream.en-US.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/pages/reference/api/create-stream.en-US.mdx b/pages/reference/api/create-stream.en-US.mdx index 92306aa6b..5ee224fde 100644 --- a/pages/reference/api/create-stream.en-US.mdx +++ b/pages/reference/api/create-stream.en-US.mdx @@ -2,6 +2,8 @@ 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 @@ -10,9 +12,11 @@ title: POST Create stream 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. - ->Note: 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. - + + 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. + 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