diff --git a/docs/guides/livestream/getting-started-with-livestreaming.mdx b/docs/guides/livestream/getting-started-with-livestreaming.mdx index 3635b5e41d..2d1bfa7176 100644 --- a/docs/guides/livestream/getting-started-with-livestreaming.mdx +++ b/docs/guides/livestream/getting-started-with-livestreaming.mdx @@ -198,7 +198,7 @@ If you’re a host you’ll see the option to **Go live** and **End live** strea className="livestream-end-live" /> -# Use Cases +## Use Cases The following are some of the most common Dyte livestreaming use cases: diff --git a/docs/guides/livestream/livestream-apis.mdx b/docs/guides/livestream/livestream-apis.mdx index 2c37d117fc..6d29f7d1e9 100644 --- a/docs/guides/livestream/livestream-apis.mdx +++ b/docs/guides/livestream/livestream-apis.mdx @@ -7,7 +7,7 @@ This topic talks about how you can use livestreaming properties, events, and fun Livestreaming is often used for events, such as concerts, conferences, and sports games, as well as for online classes, gaming, and social media platforms. It allows remote viewers to participate in the event or experience, interact with the content creators or other viewers via chat, comments, or reactions, and participate in the real-time conversation. -# Properties +## Properties **playbackUrl**: This URL allows you to watch the live video stream. It is the location of the video file and can be accessed through a web browser or media player. @@ -20,7 +20,7 @@ Livestreaming is often used for events, such as concerts, conferences, and sport **viewerCount**: The number of people viewing the livestream, including hosts and viewers. -# Methods +## Methods Use the following methods to start and stop the livestreaming. @@ -36,7 +36,7 @@ Users with the permission `canLivestream` set to true can stop a livestream. `await meeting.livestream.stop();` -# Events +## Events Here is a list of events that the `meeting.livestream` module emits: diff --git a/docs/guides/livestream/state-management-apis.mdx b/docs/guides/livestream/state-management-apis.mdx index 9016482afe..1b4e29a60f 100644 --- a/docs/guides/livestream/state-management-apis.mdx +++ b/docs/guides/livestream/state-management-apis.mdx @@ -7,11 +7,11 @@ This topic talks about how you can use livestreaming state management APIs. Usin The foundation of Dyte's livestreaming is based on a stage, which can be accessed by hosts and viewers. While hosts can directly enter the stage, viewers can request to join it. The stage is broadcasted live to all viewers. Here's how you can interact with stage APIs: -# Access the stage APIs +## Access the stage APIs -The stage module can be accessed under `meeting.stage` namespace. +The stage module can be accessed under [`meeting.stage`](https://docs.dyte.io/react-web-core/reference/DyteStage) namespace. -# Properties +## Properties Dyte's livestreaming state management APIs provides useful properties to help you manage your stage effectively. One of these properties is the `status` attribute, which can take on various values based on the user's activity. The status can assume the following values: @@ -22,7 +22,7 @@ Dyte's livestreaming state management APIs provides useful properties to help yo A user with permission to join livestream directly can only assume `ON_STAGE` and `ACCEPTED_TO_JOIN_STAGE` status values. -# Host controls +## Host controls Dyte’s stage management APIs allow hosts to receive and manage stage requests as well as leave and join the stage. @@ -68,7 +68,7 @@ You can get the user IDs from the `stageAccessRequestUpdate` event. `await meeting.stage.kick(userIds);` -# Participant controls +## Participant controls Dyte’s stage management APIs allow participants to receive and manage stage requests as well as leave and join the stage. @@ -86,7 +86,7 @@ You can call this method in order to cancel your stage request. `await meeting.stage.cancelRequestAccess();` -# Events +## Events Here is a list of events that the `meeting.stage` module emits: diff --git a/docs/guides/recording/start-recording.mdx b/docs/guides/recording/start-recording.mdx index 9e23eccc9a..37736923f7 100644 --- a/docs/guides/recording/start-recording.mdx +++ b/docs/guides/recording/start-recording.mdx @@ -14,6 +14,8 @@ There are two ways to start a recording a Dyte meeting: [creating a meeting](/api/?v=v2#/operations/create_meeting) - Using the [Start Recording API](/api/?v=v2#/operations/start_recording) +Dyte stores recordings for a period of 7 days, after which they will expire and no longer be accessible. It is important to either download a copy of your recording or [set up storage](https://docs.dyte.io/guides/recording/custom-cloud-storage#set-storage-configuration) before the link expires. + :::info Note 1. Our system does not currently support recordings of brief durations that are less than five seconds. In such cases, it is possible that the recording APIs may experience occasional failures. Due to limitations in encoding recordings of short duration, these failures may result in an ERRORED state. @@ -24,7 +26,7 @@ There are two ways to start a recording a Dyte meeting: 24 hours have elapsed since the recording's start time. This option can be configured to any value up to 24 hours by passing the `max_seconds` parameter in the [start recording](/api/?v=v2#/operations/start_recording) API request. -::: + ::: ## Using the `record_on_start` parameter @@ -122,5 +124,3 @@ curl --request POST \ } } ``` - - diff --git a/static/release-notes/web-core.json b/static/release-notes/web-core.json index 916681ed8e..03aebc9059 100644 --- a/static/release-notes/web-core.json +++ b/static/release-notes/web-core.json @@ -4,19 +4,17 @@ "createdAt": 1678333268, "fixes": [], "features": [ - "**Interactive Livestream Release (LL-HLS)** \n 1. Broadcast a meeting to 100,000 viewers with Low latency (3-6 seconds)\n 2. Interactive Chat and Polls \n 3. Viewers can raise hands or the host can invite Viewers to join the stage" + "**Interactive Livestream Release (LL-HLS)** \n 1. Broadcast a meeting to up to 100,000 viewers with low latency of just 3 to 6 seconds.\n 2. Interactive chat and polls. \n 3. Viewers can raise hands to join the stage or the host can invite viewers to join the stage. \n For more information, see [ILS Overview](https://docs.dyte.io/guides/livestream/livestream-overview) and [Getting Started with ILS](https://docs.dyte.io/guides/livestream/getting-started-with-livestreaming)." ], "new_api": [ - "New DyteStage module at [meeting.stage](./reference/DyteStage) to manage the Stage during Livestreaming", - "New DyteLiveStream module at [meeting.livestream](./Reference/DyteLivestream) to start / stop the Livestreaming" + "A new `DyteStage` module introduced at [meeting.stage](./reference/DyteStage) to manage the stage during livestreaming. \n For more information, see [Livestreaming State Management APIs](https://docs.dyte.io/guides/livestream/state-management-apis).", + "A new 'DyteLiveStream' module introduced at [meeting.livestream](./Reference/DyteLivestream) to start and stop the livestreaming. \n For more information, see [Livestreaming: Properties, Functions, and Events](https://docs.dyte.io/guides/livestream/livestream-apis)." ] }, { "version": "1.5.x", "createdAt": 1677609000, - "fixes": [ - "Handle WeWork Solistice Camera gracefully" - ], + "fixes": ["Handle WeWork Solistice Camera gracefully"], "features": [ "Initial support for our upcoming Interactive Livestream product (LL-HLS)", "Webcam quality can now be controlled from the preset, allows customer to select a higher base quality in the preset editor (beta)"