From 1b994a685e09254880936b4dedaf1889b1ba0ef9 Mon Sep 17 00:00:00 2001 From: Arjun Attam Date: Mon, 7 Aug 2023 15:32:52 +0530 Subject: [PATCH] content --- .../features/recordings/overview.mdx | 2 +- .../start-external-stream-for-room.mdx | 25 +++++++++++---- .../start-live-stream-for-room.mdx | 19 +++++++---- .../recordings/start-recording-for-room.mdx | 32 ++++++++++++------- .../v2/how-to-guides/recordings/overview.mdx | 2 -- 5 files changed, 52 insertions(+), 28 deletions(-) diff --git a/docs/get-started/v2/get-started/features/recordings/overview.mdx b/docs/get-started/v2/get-started/features/recordings/overview.mdx index 7045805fa9..59ef19e745 100755 --- a/docs/get-started/v2/get-started/features/recordings/overview.mdx +++ b/docs/get-started/v2/get-started/features/recordings/overview.mdx @@ -74,7 +74,7 @@ After the recording is stopped and processed, a [recording asset](/server-side/v ### Customizing the recording - No-code customization on the 100ms Dashboard: Modify the video resolution, which roles to be recorded -- Get audio-only recording: possible via the [REST API to start recording](/server-side/v2/how-to-guides/recordings/overview) +- Get audio-only recording: possible via the [REST API to start recording](/server-side/v2/how-to-guides/recordings/customize) - [Customize the composition UI](./../ui-composition) ### Legacy composite through SFU recording diff --git a/docs/server-side/v2/api-reference/external-streams/start-external-stream-for-room.mdx b/docs/server-side/v2/api-reference/external-streams/start-external-stream-for-room.mdx index 4b81965d79..13bc1f2336 100644 --- a/docs/server-side/v2/api-reference/external-streams/start-external-stream-for-room.mdx +++ b/docs/server-side/v2/api-reference/external-streams/start-external-stream-for-room.mdx @@ -55,13 +55,24 @@ curl --location --request POST 'https://api.100ms.live/v2/external-streams/room/ ## Parameters -| Name | Type | Description | Required | -|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------- |----------| -| meeting_url | `string` | Single click meeting URL for the stream | No | -| rtmp_urls | `array` | List of RTMP output URLs to stream to (up to 3 `rtmp://` / `rtmps://` URLs supported) | Yes | -| recording | `bool` | Flag to enable recording | No | -| resolution | `object` | Video resolution for stream | No | -| destination | `string` | Name of destination from template to pick up configuration. If more than one RTMP destination present in the template then destination is mandatory | No | +| Name | Type | Description | Required | +|--------------|----------|-------------------------------- |----------| +| meeting_url | `string` | Single click meeting URL for the stream | No[1] | +| rtmp_urls | `array` | List of RTMP output URLs to stream to (up to 3 `rtmp://` / `rtmps://` URLs supported) | Yes | +| recording | `bool` | Flag to enable recording | No | +| resolution | `object` | Video resolution for stream | No | +| destination | `string` | Name of destination from template to pick up configuration | No[2] | + + + +> [1] `meeting_url` is **required** when +> - External streaming is not enabled on the dashboard +> - The template of this room does not have a subdomain (templates created through the REST API don't have subdomains) + + +> [2] (Advanced usage only) `destination` is **required** when +> - There are multiple destinations of this type on the template + ##### meeting_url diff --git a/docs/server-side/v2/api-reference/live-streams/start-live-stream-for-room.mdx b/docs/server-side/v2/api-reference/live-streams/start-live-stream-for-room.mdx index 2dacb73bcf..4495f0fcc0 100644 --- a/docs/server-side/v2/api-reference/live-streams/start-live-stream-for-room.mdx +++ b/docs/server-side/v2/api-reference/live-streams/start-live-stream-for-room.mdx @@ -58,13 +58,20 @@ curl --location --request POST 'https://api.100ms.live/v2/live-streams/room/ [1] `meeting_url` is **required** when +> - Live streaming is not enabled on the dashboard +> - The template of this room does not have a subdomain (templates created through the REST API don't have subdomains) + + +> [2] (Advanced usage only) `destination` is **required** when +> - There are multiple destinations of this type on the template ##### meeting_url diff --git a/docs/server-side/v2/api-reference/recordings/start-recording-for-room.mdx b/docs/server-side/v2/api-reference/recordings/start-recording-for-room.mdx index 6ad40d4ca5..58222a7390 100644 --- a/docs/server-side/v2/api-reference/recordings/start-recording-for-room.mdx +++ b/docs/server-side/v2/api-reference/recordings/start-recording-for-room.mdx @@ -85,16 +85,28 @@ curl --location --request POST 'https://api.100ms.live/v2/recordings/room/ - ## Parameters -| Name | Type | Description | Required | -| ------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| meeting_url | `string` | Single click meeting URL for the stream. | No | -| resolution | `object` | Video resolution for stream. | No | -| audio_only | `boolean` | Pass `true` to get an audio-only recording asset. | No | -| destination | `string` | Name of destination from template to pick up configuration. If more than one recording destination present in the template then destination is mandatory | No | -| transcription | `object` | Post call transcription configuration. | No | +| Name | Type | Description | Required | +| ------------- | --------- | --------------- | -------- | +| meeting_url | `string` | Single click meeting URL for the stream | No[1] | +| resolution | `object` | Video resolution for stream | No | +| destination | `string` | Name of destination from template to pick up configuration | No[2] | +| audio_only | `boolean` | Pass `true` to get an audio-only recording | No | +| transcription | `object` | Post call transcription configuration | No | + + +> [1] `meeting_url` is **required** when +> - Composite recordings is not enabled on the dashboard ([see how](/get-started/v2/get-started/features/recordings/overview)) +> - The template of this room does not have a subdomain (templates created through the REST API don't have subdomains) + + +> [2] (Advanced usage only) `destination` is **required** when +> - There are multiple destinations of this type on the template + +### meeting_url + + ### transcription @@ -120,7 +132,3 @@ curl --location --request POST 'https://api.100ms.live/v2/recordings/room/ diff --git a/docs/server-side/v2/how-to-guides/recordings/overview.mdx b/docs/server-side/v2/how-to-guides/recordings/overview.mdx index c018483279..5348c82ced 100644 --- a/docs/server-side/v2/how-to-guides/recordings/overview.mdx +++ b/docs/server-side/v2/how-to-guides/recordings/overview.mdx @@ -3,8 +3,6 @@ title: Start and stop recording nav: 5.1 --- -import MeetingUrlConfig from '@/common/meeting-url.md'; - This guide focuses on using room composite (browser-based) recordings. Learn more in [recordings overview](/get-started/v2/get-started/features/recordings/overview). A composite recording is a single MP4 file that records all peers and their tracks (audio, video and screen share). It captures the experience that a peer has in the room and is equivalent to recordings generated from Google Meet and Zoom.