Skip to content
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

Add autoStopTimeout docs #1822

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Add autoStopTimeout docs #1822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ea3a71
Add autoStopTimeout docs
vivekd-100ms Oct 24, 2023
df14fe4
Updated description for autoStart
vivekd-100ms Oct 24, 2023
2b8e570
Update create-template-via-api.mdx
mntrspace Oct 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
10 changes: 7 additions & 3 deletions docs/server-side/v2/api-reference/policy/create-template-via-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,10 +733,12 @@ 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 |
| 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

Expand All @@ -745,23 +747,25 @@ 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 |

### 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 |
| videoFrameRate | `int` | Set this argument to configure the frames per second (or FPS) for your stream. For example, 25 | No |
| 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

Expand Down
3 changes: 3 additions & 0 deletions docs/server-side/v2/changelog/release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading