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.

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

Release PR #2058

Merged
merged 99 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
2abb0ef
Sync QA (#1848)
saikatmitra91 Nov 7, 2023
d578886
Qa main backmerge 2 (#1855)
hdz-666 Nov 8, 2023
ec9b1ec
Merge branch 'main' into qa
hdz-666 Nov 8, 2023
eb69449
fix: typos (#1850) (#1856)
hdz-666 Nov 8, 2023
e8e5bb0
Backmerge main to QA (#1891)
KaustubhKumar05 Dec 6, 2023
85df7f2
Update qa (#1917)
KaustubhKumar05 Dec 18, 2023
726c48c
fix: sidebar rendering in examples pages (#1916)
KaustubhKumar05 Dec 18, 2023
3378802
Revert sidebar changes (#1918)
KaustubhKumar05 Dec 18, 2023
159079a
Fix link fetching (#1919)
KaustubhKumar05 Dec 18, 2023
c21157a
Merge branch 'main' into qa
KaustubhKumar05 Dec 18, 2023
3744078
Update QA (#1924)
KaustubhKumar05 Dec 20, 2023
18c8101
migration guide update for android and ios (#1923)
mntrspace Dec 20, 2023
16c8ac3
Update qa w main (#1927)
KaustubhKumar05 Dec 20, 2023
fd009db
Main to QA backmerge (#1928)
AnkitRastogi3 Dec 20, 2023
8f7e11e
Merge branch 'main' into qa
hdz-666 Dec 21, 2023
96388c9
HMS-7303 (#1931)
vivekd-100ms Dec 22, 2023
d489b64
add room_name and recording_id in webhooks (#1905)
pratishbodhale Dec 23, 2023
795e860
Merge branch 'main' into qa
KaustubhKumar05 Dec 26, 2023
ae51521
live transcription doc (#1922)
mntrspace Dec 26, 2023
c2e25ef
updated PIP docs (#1934)
ygit Dec 27, 2023
5a512ae
1.4.2 iOS Release (#1935)
gzerad Jan 4, 2024
e5c1ff9
Added jsx to accept.txt (#1944)
mntrspace Jan 9, 2024
326318d
Updates to post call transcription guide, rtmp ingestion guide, live …
mntrspace Jan 9, 2024
fb552ce
Security and compliance (#1946)
mntrspace Jan 10, 2024
0ab95e6
fix: vale version (#1949)
KaustubhKumar05 Jan 10, 2024
dbf2eb4
Merge branch 'main' into qa
KaustubhKumar05 Jan 10, 2024
d3b245d
Main to QA backmerge (#1953)
KaustubhKumar05 Jan 12, 2024
2505361
5 Jan web release notes (#1945)
KaustubhKumar05 Jan 12, 2024
e36ad88
virtual background (#1937)
akankshat100ms Jan 16, 2024
6d972b4
Merge branch 'main' into qa
KaustubhKumar05 Jan 16, 2024
3884e45
Virtual background (#1960)
akankshat100ms Jan 17, 2024
4b5bec1
fix: update (#1962)
KaustubhKumar05 Jan 18, 2024
755d398
Merge branch 'main' into qa
KaustubhKumar05 Jan 18, 2024
3fecca2
docs(web): update api reference (#1965)
s-dvd Jan 19, 2024
47f7719
Merge branch 'main' into qa
KaustubhKumar05 Jan 19, 2024
0bdde97
Web release notes 1901 (#1967)
KaustubhKumar05 Jan 19, 2024
2022114
remove redundant vb file (#1969)
KaustubhKumar05 Jan 22, 2024
fa86a5f
docs: 25 Jan 2024 web release notes
raviteja83 Jan 29, 2024
da7ca34
docs: update
raviteja83 Jan 29, 2024
aae54b9
SS-3421 : Added suggested blogs component (#1959)
AnkitRastogi3 Jan 29, 2024
87dfbbf
SS-3634 : Moved prebuilt from overview and added in sidebar list (#1974)
AnkitRastogi3 Jan 30, 2024
26a72d1
SS: 3634 updates (#1975)
AnkitRastogi3 Jan 30, 2024
867a406
Docs release PR (#1980)
KaustubhKumar05 Feb 2, 2024
ac4927d
fix modes in template request
pratishbodhale Feb 7, 2024
8fbe54b
Ss 3637 (#1977)
AnkitRastogi3 Feb 9, 2024
9f26ea1
Merge branch 'main' into qa
KaustubhKumar05 Feb 12, 2024
137c880
Ss 3637 - handling hash (#1996)
AnkitRastogi3 Feb 12, 2024
b250d25
HMS-8358 (#2000)
vivekd-100ms Feb 14, 2024
f205f82
removed dummy blogs (#1986)
AnkitRastogi3 Feb 14, 2024
c494d0f
list query params (#1988)
KaustubhKumar05 Feb 14, 2024
c07f910
Merge branch 'main' into qa
KaustubhKumar05 Feb 14, 2024
4575fe0
User context (#2003)
akankshat100ms Feb 15, 2024
88e700d
Roomauth (#2004)
akankshat100ms Feb 15, 2024
eddb6a6
Roomauth (#2005)
akankshat100ms Feb 16, 2024
a77e4d3
Update adaptive-bitrate.md (#1884)
mntrspace Feb 16, 2024
730a3a4
Update qa (#2007)
KaustubhKumar05 Feb 16, 2024
bf380a7
Qa backmerge (#2008)
KaustubhKumar05 Feb 16, 2024
dd8bca0
Merge branch 'main' into qa
KaustubhKumar05 Feb 16, 2024
0dae993
fix: update HMSQuizLeaderboard (#1939)
KaustubhKumar05 Feb 16, 2024
36cf44c
docs: add web release notes
raviteja83 Feb 19, 2024
a02511f
Merge branch 'main' into qa
KaustubhKumar05 Feb 20, 2024
c309f3f
Migration guide update 20feb2024 (#2021)
mntrspace Feb 22, 2024
b092bfd
Hipaa compliance 20feb2024 (#2022)
mntrspace Feb 22, 2024
232dd12
Merge branch 'main' into qa
KaustubhKumar05 Feb 22, 2024
e87d6e0
Effects VB integration doc (#1990)
KaustubhKumar05 Feb 22, 2024
12bca85
Automation workflows (#2024)
KaustubhKumar05 Feb 22, 2024
a85ec55
Hipaa updates 22feb2024 (#2026)
mntrspace Feb 22, 2024
3f028f7
Merge branch 'main' into qa
mntrspace Feb 23, 2024
ab94791
docs(web): update api reference (#2027)
s-dvd Feb 23, 2024
c3fc4b7
Backmerge PR (#2030)
KaustubhKumar05 Feb 23, 2024
9098bf9
Merge branch 'main' into qa
KaustubhKumar05 Feb 23, 2024
845ff56
Release notes 2024-02-23 (#2032)
KaustubhKumar05 Feb 26, 2024
e0a8907
Peerinsights (#2014)
akankshat100ms Feb 26, 2024
5a85d56
Update peerinsights.mdx
akankshat100ms Feb 26, 2024
69eaaf9
Merge branch 'main' into qa
KaustubhKumar05 Feb 26, 2024
0123f72
fix: release automation actions (#2034)
KaustubhKumar05 Feb 26, 2024
b8b4fcd
Merge branch 'main' into qa
KaustubhKumar05 Feb 26, 2024
70518f8
fix: tags in release notes (#2036)
KaustubhKumar05 Feb 26, 2024
0c81e9e
fix: tags for subheading
KaustubhKumar05 Feb 26, 2024
a4a0c2a
Sip and hipaa updates 27feb2024 (#2045)
mntrspace Feb 28, 2024
b3b5f86
Merge branch 'main' into qa
KaustubhKumar05 Feb 28, 2024
5d0f290
SS-3439 : support all react-icons in Callout (#2044)
AnkitRastogi3 Mar 1, 2024
64ff69a
New recordings (#2031)
akankshat100ms Mar 4, 2024
556ec34
Merge branch 'main' into qa
KaustubhKumar05 Mar 4, 2024
dd3887f
fix: icons for callout component (#2050)
KaustubhKumar05 Mar 4, 2024
faad040
fix: closing tag for flexcontainer
KaustubhKumar05 Mar 4, 2024
ac9467e
Merge branch 'qa' of https://github.com/100mslive/100ms-docs into qa
KaustubhKumar05 Mar 4, 2024
2030ad7
Fix recording mode description in the overview. (#2051)
rtpriya Mar 4, 2024
8c75464
Merge open prs (#2052)
KaustubhKumar05 Mar 4, 2024
21c19cd
Added poll methods (#2048)
Decoder07 Mar 4, 2024
e9feb95
Merge branch 'main' into qa
ygit Mar 4, 2024
5e7d23b
Updated release notes (#2049)
Decoder07 Mar 4, 2024
efe91e4
fix: links
KaustubhKumar05 Mar 4, 2024
618919d
backmerge: main to qa (#2055)
github-actions[bot] Mar 4, 2024
b06db63
Merge branch 'main' into qa
KaustubhKumar05 Mar 4, 2024
6e00099
fix: links (#2057)
KaustubhKumar05 Mar 5, 2024
d0c7334
fix: links (#2059)
KaustubhKumar05 Mar 5, 2024
62d9aa5
Merge branch 'main' into qa
KaustubhKumar05 Mar 5, 2024
6ccd2c9
fix: link
KaustubhKumar05 Mar 5, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav: 3.13
100ms can record chat messages sent in a room when a [video recording](./overview) is used. Chat messages that are broadcasted to the room or sent to a role are recorded (direct messages are not recorded).


Chat recording generates a `.csv` file, which will be uploaded to the [storage bucket](./storage) configured for your video recordings.
Chat recording generates a `.csv` file, which will be uploaded to the [storage bucket](./recording-assets/storage-configuration) configured for your video recordings.

## File structure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This recording is a HLS file (chunked MP4 with a manifest file (M3U8)), which ca

### Configuring VOD recordings

1. Configure your recording storage. Use [this guide](/get-started/v2/get-started/features/recordings/storage) as your reference. Based on the storage upload type chosen (100ms storage or other cloud providers), the options supported to upload the VOD recording will differ.
1. Configure your recording storage. Use [this guide](/get-started/v2/get-started/features/recordings/recording-assets/storage-configuration) as your reference. Based on the storage upload type chosen (100ms storage or other cloud providers), the options supported to upload the VOD recording will differ.
2. Enable and configure your [live stream settings on the dashboard](/get-started/v2/get-started/features/live-streaming#customize-the-stream).
3. Enable and configure the **Stream Recording** settings under the **Live Streaming** tab on the 100ms dashboard.
4. When configuring the recording settings, ensure the following options are selected correctly:
Expand Down
36 changes: 18 additions & 18 deletions docs/get-started/v2/get-started/features/recordings/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,58 +6,58 @@ nav: 3.1
Recordings enable you to convert live video from 100ms rooms into long-lived video assets. 100ms can generate different types of recordings:

## Recording modes for video conferencing
- **[Track recordings](/get-started/v2/get-started/features/recordings/recording-modes/track-recordings)** - Record each audio and video track of each peer as separate assets.
- **[Stream recordings](/get-started/v2/get-started/features/recordings/recording-modes/stream-recording)** - Record each peer's media streams (audio and video tracks combined) as a single asset.
- **[Composite recordings](/get-started/v2/get-started/features/recordings/recording-modes/composite-recordings)** - Record as a composed asset combining media tracks of all peers in the room

- **[Track recordings](/get-started/v2/get-started/features/recordings/recording-modes/track-recordings)** - Record each audio and video track of each peer as separate assets.
- **[Stream recordings](/get-started/v2/get-started/features/recordings/recording-modes/stream-recording)** - Record each peer's media streams (audio and video tracks combined) as a single asset.
- **[Composite recordings](/get-started/v2/get-started/features/recordings/recording-modes/composite-recordings)** - Record as a composed asset combining media tracks of all peers in the room

<FlexContainer>
<Callout title="Choosing a recording mode" icon="LinkTwoIcon">
Compare track, stream and composite recordings for your use cases. [Compare recording modes →](/get-started/v2/get-started/features/recordings/recording-modes/comparing-recording-modes)
</Callout>
<Callout title="Choosing a recording mode" icon="LinkTwoIcon">
Compare track, stream and composite recordings for your use cases. [Compare recording modes
→](/get-started/v2/get-started/features/recordings/recording-modes/comparing-recording-modes)
</Callout>
</FlexContainer>

## Recording a livestream

Live stream recording enables capturing a continuous feed of audio or video in real-time during a live broadcast event. It focuses on low latency for interactivity over post-production flexibility. 100ms offers two recording formats:

- **Video-On-Demand (VOD)**: Generated HLS file enables re-playable video with adaptive bitrates. Can be unzipped or zipped when storing.
- **Per Layer MP4 Files**: Records separate MP4 videos for chosen resolution layers. Gives access to distinct raw footage files.
- **Video-On-Demand (VOD)**: Generated HLS file enables re-playable video with adaptive bitrates. Can be unzipped or zipped when storing.
- **Per Layer MP4 Files**: Records separate MP4 videos for chosen resolution layers. Gives access to distinct raw footage files.

In summary, VOD recording is better for on-demand playback while Per Layer MP4's allow remixing footage. Choice depends on needs. But 100ms enables recording live streams in multiple ways maximizing flexibility. <br/>For more details, head to [Livestream recording →](/get-started/v2/get-started/features/recordings/live-stream-recording)


## Recording Assets

<FlexContainer>

<Callout title="Recording asset types" icon="LinkTwoIcon">
Different assets types generated on 100ms. View [recording assets →](/get-started/v2/get-started/features/recordings/recording-assets/recording-asset-types)
Different assets types generated on 100ms. View [recording assets
→](/get-started/v2/get-started/features/recordings/recording-assets/recording-asset-types)
</Callout>

<Callout title="Storage configuration" icon="ShieldIcon">
Understand how to store your recordings. Refer [storage configuration →](/get-started/v2/get-started/features/recordings/recording-assets/storage-configuration)
</Callout>

<Callout title="Get recording assets" icon="LinkTwoIcon">
Fetch recording asset types generated. [Get recording assets →](/get-started/v2/get-started/features/recordings/recording-assets/get-recoding-assets)
Fetch recording asset types generated. [Get recording assets
→](/get-started/v2/get-started/features/recordings/recording-assets/get-recording-assets)
</Callout>



</FlexContainer>

## Recordings Guides

- [Chat Recording →](/get-started/v2/get-started/features/recordings/chat-recording)
- [Set up recordings →](/get-started/v2/get-started/features/recordings/set-up-recording)

- [Chat Recording →](/get-started/v2/get-started/features/recordings/chat-recording)
- [Set up recordings →](/get-started/v2/get-started/features/recordings/set-up-recording)

## Recordings Resources

<FlexContainer>

<Callout title="Recording API" icon="LinkTwoIcon">
- [Recording APIs →](/server-side/v2/api-reference/recordings/overview)
- [Recording Assets APIs →](/server-side/v2/api-reference/recording-assets/overview)
</Callout>
</FlexContainer>


Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Alternatively, Use List recordings Assets API for a session or room to get asset

## List recording Assets

The [List Recording Assets API](/v2/api-reference/recording-assets/list-all-assets) which returns `asset_id`s for recordings generated across your 100ms workspace, which can be filtered by:
The [List Recording Assets API](/server-side/v2/api-reference/recording-assets/list-all-assets) which returns `asset_id`s for recordings generated across your 100ms workspace, which can be filtered by:

- Session ID - list all recordings for a `session_id`.
- Room ID - list all recordings for a `room_id`
Expand All @@ -18,7 +18,7 @@ The [List Recording Assets API](/v2/api-reference/recording-assets/list-all-asse
- `completed` - get only completed recordings
- `failed` - get only failed recordings
<br/>
If no filter is specified, all recordings for your workspace will be returned. The `id` returned in the response refers to the asset generated, which contains information such as associated session, room, asset type, status, duration, etc. Refer to the [recording asset object specification]((/server-side/v2/api-reference/recording-assets/overview#object)) for details.
If no filter is specified, all recordings for your workspace will be returned. The `id` returned in the response refers to the asset generated, which contains information such as associated session, room, asset type, status, duration, etc. Refer to the [recording asset object specification](/server-side/v2/api-reference/recording-assets/overview#object) for details.


## Get a recording asset
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Browser composite recording can be started either by 100ms Recording APIs or SDK

After the recording is stopped and processed, a **[recording asset](https://www.100ms.live/docs/server-side/v2/api-reference/recording-assets/overview)** is generated. Composite generates an asset of type `room-composite`. You can fetch this asset through multiple methods:

- **[Fetch on 100ms Dashboard](https://www.100ms.live/docs/get-started/v2/get-started/features/recordings/storage#using-the-100ms-dashboard)**
- Auto-send to your **[cloud storage location](https://www.100ms.live/docs/get-started/v2/get-started/features/recordings/storage)**
- **[Fetch on 100ms Dashboard](https://www.100ms.live/docs/get-started/v2/get-started/features/recordings/recording-assets/storage-configuration#configure-recording-storage)**
- Auto-send to your **[cloud storage location](https://www.100ms.live/docs/get-started/v2/get-started/features/recordings/recording-assets/storage-configuration)**
- REST API to **[get recording asset](https://www.100ms.live/docs/server-side/v2/api-reference/recording-assets/get-asset)**
- Server-side webhooks: **[use the `beam.recording.success` webhook](https://www.100ms.live/docs/server-side/v2/how-to-guides/configure-webhooks/webhook#beamrecordingsuccess)**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Following services and features can be **enabled** and used:

1. Polls and Quizzes
2. Composite Recording with user’s cloud storage bucket configured
1. Recording with the [customer’s cloud storage bucket configured](/get-started/v2/get-started/features/recordings/storage) on 100ms is the only method allowed by 100ms. As soon as the recording for a particular session is complete, it is uploaded to the customers’ storage and immediately deleted from ours.
1. Recording with the [customer’s cloud storage bucket configured](/get-started/v2/get-started/features/recordings/recording-assets/storage-configuration) on 100ms is the only method allowed by 100ms. As soon as the recording for a particular session is complete, it is uploaded to the customers’ storage and immediately deleted from ours.
2. Access to customers’ buckets cannot be obtained by 100ms because write-only access is enforced when configuring the customer’s storage bucket.
3. Whiteboard
4. Session Initiation Protocol (SIP) (Limited Preview Access)
Expand Down
10 changes: 5 additions & 5 deletions docs/server-side/v2/release-notes/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ This Changelog highlights notable changes to the 100ms server-side API, such as
- Added [new recording APIs](/server-side/v2/policy/configure-recordings) to provide configurations for different kind of recordings - `trackRecording`, `streamRecording`, `compositeRecording`
- Added new asset types - `track` and `stream` in [recording assets API](/server-side/v2/api-reference/recording-assets/overview).
- Added following new webhook events -
1. [`track.recording.started.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook.md#track.recording.started.success)
2. [`track.recording.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook.md#track.recording.success)
3. [`track.recording.failure`](/server-side/v2/how-to-guides/configure-webhooks/webhook.md#track.recording.failure)
4. [`stream.recording.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook.md#stream.recording.success)
5. [`stream.recording.failure`](/server-side/v2/how-to-guides/configure-webhooks/webhook.md#stream.recording.failure)
1. [`track.recording.started.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook#track.recording.started.success)
2. [`track.recording.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook#track.recording.success)
3. [`track.recording.failure`](/server-side/v2/how-to-guides/configure-webhooks/webhook#track.recording.failure)
4. [`stream.recording.success`](/server-side/v2/how-to-guides/configure-webhooks/webhook#stream.recording.success)
5. [`stream.recording.failure`](/server-side/v2/how-to-guides/configure-webhooks/webhook#stream.recording.failure)

#### Deprecations

Expand Down
Loading