From 9ea3a712031284ad3e87947ad3ac759b7809da50 Mon Sep 17 00:00:00 2001 From: vivekd-100ms Date: Tue, 24 Oct 2023 16:38:56 +0530 Subject: [PATCH 1/3] Add autoStopTimeout docs --- .../v2/api-reference/policy/create-template-via-api.mdx | 8 ++++++-- docs/server-side/v2/changelog/release-notes.mdx | 3 +++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx index aa74aae7e6..1af6833caa 100644 --- a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx +++ b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx @@ -737,6 +737,8 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | thumbnails | `object` | Object of type `thumbnails`. This can be used to configure thumbnail's dimension | No | | presignDuration | `int` | Indicates the expiry of the pre-signed URLs—the duration for which the pre-signed URL should be signed | No | | role | `string` | Indicates the role use to start browser recording | Yes | +| autoStart | `boolean`| Indicates whether this destination should be used while starting recordings automatically on room join | No | +| autoStopTimeout | `int` | Maximum duration to wait before automatically stopping recording after all peers leave | No | ### rtmpDestinations object @@ -745,16 +747,17 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | name | `string` | The name you can assign to identify the RTMP destination | Yes | | width | `int` | Indicates the width of the screen to be recorded in pixels. For example, 1280 pixels | No | | height | `int` | Indicates the height of the screen to be recorded in pixels. For example, 720 pixels | No | -| maxDuration | `int` | Set maximum duration for RTMP stream, in seconds. For example, 1800 seconds(30 mins) | No | +| maxDuration | `int` | Set maximum duration for RTMP stream, in seconds. For example, 1800 seconds(30 mins) | No | | rtmpUrls | `object` | Object of type `rtmpUrls`. This can be used to configure the RTMP URLs(max 3) you wish to broadcast the stream to. | No | | recordingEnabled | `boolean` | If recording is required this can be set as true. This value has no effect on streaming. | No | +| autoStopTimeout | `int` | Maximum duration to wait before automatically stopping RTMP after all peers leave | No | ### hlsDestinations object | Name | Type | Description | Required | | :---------------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- | | name | `string` | The name you can assign to identify the HLS destination | Yes | -| maxDuration | `int` | Sets maximum duration for the live stream, in seconds. For example, 1800 seconds(30 minutes) | No | +| maxDuration | `int` | Sets maximum duration for the live stream, in seconds. For example, 1800 seconds(30 minutes) | No | | layers | `object` | Object of type `layers`. This can be used to configure the various dimensions to be supported for HLS streaming. The layers are expected to be in descending order of resolution and video bitrate | No | | playlistType | `string` | Indicates the type of playlist. Can be of type `event` or `live`. | No | | numPlaylistSegments | `int` | Indicates the number of media segments in the playlist. Applicable only for `live` playlistType. Each segment is 2 seconds. Min/max/default = 3/150/5. | No | @@ -762,6 +765,7 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | enableMetadataInsertion | `boolean` | Set this to true to enable metadata insertion along with the stream. | No | | enableStaticUrl | `boolean` | If recording is required this can be set as true. This value has no effect on streaming. | No | | recording | `object` | Object of type `recording`. This can be used to enable HLS recording and configure the layers, thumbnails, etc. | No | +| autoStopTimeout | `int` | Maximum duration to wait before automatically stopping HLS after all peers leave | No | #### HLS - recording object diff --git a/docs/server-side/v2/changelog/release-notes.mdx b/docs/server-side/v2/changelog/release-notes.mdx index da68bac70a..5b88551cd8 100644 --- a/docs/server-side/v2/changelog/release-notes.mdx +++ b/docs/server-side/v2/changelog/release-notes.mdx @@ -5,6 +5,9 @@ nav: 5.1 This Changelog highlights notable changes to the 100ms server-side API, such as API additions, improvements, and deprecations. Also, we've included developer experience improvements to this page to keep you on track with items that will enhance your integration journey. +## 2023-10-24 +- Added new field `autoStopTimeout` in `destinations` objects in template + ## 2023-10-17 - Added support for RTMP ingestion to live stream on 100ms from a RTMP broadcaster. Added documentation for: - [Create RTMP stream key for a specific room](/server-side/v2/api-reference/stream-key/create-rtmp-stream-key) From df14fe4af0c51d0baac79b3036018215ca593e86 Mon Sep 17 00:00:00 2001 From: vivekd-100ms Date: Tue, 24 Oct 2023 17:45:57 +0530 Subject: [PATCH 2/3] Updated description for autoStart --- .../v2/api-reference/policy/create-template-via-api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx index 1af6833caa..2d9b6e5271 100644 --- a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx +++ b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx @@ -737,7 +737,7 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | thumbnails | `object` | Object of type `thumbnails`. This can be used to configure thumbnail's dimension | No | | presignDuration | `int` | Indicates the expiry of the pre-signed URLs—the duration for which the pre-signed URL should be signed | No | | role | `string` | Indicates the role use to start browser recording | Yes | -| autoStart | `boolean`| Indicates whether this destination should be used while starting recordings automatically on room join | No | +| autoStart | `boolean`| Indicates whether recordings should automatically start on room join for this destination | No | | autoStopTimeout | `int` | Maximum duration to wait before automatically stopping recording after all peers leave | No | ### rtmpDestinations object From 2b8e5703f73042ffbd4de639b83f69116108b00d Mon Sep 17 00:00:00 2001 From: Mantra Manan Saraswat Date: Tue, 24 Oct 2023 19:26:51 +0000 Subject: [PATCH 3/3] Update create-template-via-api.mdx changed mins to minutes vale-linter was failing --- .../v2/api-reference/policy/create-template-via-api.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx index 2d9b6e5271..9acbd83612 100644 --- a/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx +++ b/docs/server-side/v2/api-reference/policy/create-template-via-api.mdx @@ -733,7 +733,7 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | name | `string` | The name you can assign to identify the browser recording | Yes | | width | `int` | Indicates the width of the screen to be recorded in pixels. For example, 1280 pixels | No | | height | `int` | Indicates the height of the screen to be recorded in pixels. For example, 720 pixels | No | -| maxDuration | `int` | Sets the maximum duration, in seconds, of the recording. For example, 1800 seconds(30 mins) | No | +| maxDuration | `int` | Sets the maximum duration, in seconds, of the recording. For example, 1800 seconds(30 minutes) | No | | thumbnails | `object` | Object of type `thumbnails`. This can be used to configure thumbnail's dimension | No | | presignDuration | `int` | Indicates the expiry of the pre-signed URLs—the duration for which the pre-signed URL should be signed | No | | role | `string` | Indicates the role use to start browser recording | Yes | @@ -747,7 +747,7 @@ curl --location --request POST 'https://api.100ms.live/v2/templates' \ | name | `string` | The name you can assign to identify the RTMP destination | Yes | | width | `int` | Indicates the width of the screen to be recorded in pixels. For example, 1280 pixels | No | | height | `int` | Indicates the height of the screen to be recorded in pixels. For example, 720 pixels | No | -| maxDuration | `int` | Set maximum duration for RTMP stream, in seconds. For example, 1800 seconds(30 mins) | No | +| maxDuration | `int` | Set maximum duration for RTMP stream, in seconds. For example, 1800 seconds(30 minutes) | No | | rtmpUrls | `object` | Object of type `rtmpUrls`. This can be used to configure the RTMP URLs(max 3) you wish to broadcast the stream to. | No | | recordingEnabled | `boolean` | If recording is required this can be set as true. This value has no effect on streaming. | No | | autoStopTimeout | `int` | Maximum duration to wait before automatically stopping RTMP after all peers leave | No |