Skip to content

Commit

Permalink
Recording Edits (#2104)
Browse files Browse the repository at this point in the history
format
  • Loading branch information
akankshat100ms authored Mar 18, 2024
1 parent 8d81717 commit acfbada
Show file tree
Hide file tree
Showing 11 changed files with 42 additions and 29 deletions.
Binary file added New Recording.mp4
Binary file not shown.
26 changes: 17 additions & 9 deletions docs/get-started/v2/get-started/features/recordings/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Recordings enable you to convert live video from 100ms rooms into long-lived vid
- **[Composite recordings](/get-started/v2/get-started/features/recordings/recording-modes/composite-recordings)** - Record as a single composed asset combining media tracks of all peers in the room

<FlexContainer>
<Callout title="Choosing a recording mode" icon="LinkTwoIcon">
<Callout title="Choosing a recording mode" icon="BoxIcon">
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>
Expand All @@ -31,18 +31,19 @@ In summary, VOD recording is better for on-demand playback while Per Layer MP4's

<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)
<Callout title="Recording Media Assets" icon="LinkTwoIcon">
Different assets types generated on 100ms. <br />
[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)
Understand how to store your recordings. <br/>
[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-recording-assets)
<Callout title="Get Recording Assets" icon="FilesIcon">
Fetch recording asset types generated. <br/>
[Get recording assets](/get-started/v2/get-started/features/recordings/recording-assets/get-recording-assets)
</Callout>

</FlexContainer>
Expand All @@ -56,8 +57,15 @@ Understand how to store your recordings. Refer [storage configuration →](/get-

<FlexContainer>

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

<Callout title="Recording Webhooks" icon="ShieldIcon">
- [Track Recording Events →](/server-side/v2/how-to-guides/configure-webhooks/webhook#track-recording-events)
- [Stream Recording Events →](/server-side/v2/how-to-guides/configure-webhooks/webhook#stream-recording-events)
- [Composite Recording Events →](/server-side/v2/how-to-guides/configure-webhooks/webhook#rtmp-streaming-browser-recording-events)
</Callout>

</FlexContainer>
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ If no filter is specified, all recordings for your workspace will be returned. T
- via Dashboard

## Get a recording link or pre-signed url
For any recording asset, you can generate a short-lived recording link for the asset. Use get a pre-signed url using recording link API. You can customise the validity of the url using the API.
For any recording asset, you can generate a short-lived recording link for the asset. Use get a pre-signed url using [recording link API](/server-side/v2/api-reference/recording-assets/get-presigned-url). You can customise the validity of the url using the API.
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Recording assets are files generated after a successful recording session. They

A recording can be anything, a text, a individual peers audio, remote peer's video. Everything that can be recorded is stored as an asset type that can be retrieved and managed using Recording Assets APIs and recording asset webhooks.

1. **Track** - This asset type is a single `webm` file that contains the individual audio or video track for a peer. Refer [track recordings->](/get-started/v2/get-started/features/recordings/recording-modes/track-recordings)
1. **Track** - This asset type is a single `webm` file that contains the individual audio or video track for a peer. Refer [track recordings](/get-started/v2/get-started/features/recordings/recording-modes/track-recordings)

2. **Stream** - This asset type is a composition file (mp4) of all the media tracks that correspond to a given peer. The type can be `regular` for composite of the webcam video and audio tracks or `screen` for composite of screenshare video and audio. Refer [stream recordings](/get-started/v2/get-started/features/recordings/recording-modes/stream-recording)
2. **Stream** - This asset type is a composition file (mp4) of all the media tracks that correspond to a given peer. The type can be `regular` for composite of the webcam video and audio tracks or `screen` for composite of screenshare video and audio. Refer [stream recordings](/get-started/v2/get-started/features/recordings/recording-modes/stream-recording)

3. **Room Composite** = This asset type is a single video file (mp4) that composes audio/video for all peers in the room. The composition is higher quality (browser based composition similar to the perspective of a peer in the room) than room-composite-legacy (learn more). Refer [room composite recordings](/get-started/v2/get-started/features/recordings/recording-modes/comparing-recording-modes)
3. **Room Composite** - This asset type is a single video file (mp4) that composes audio/video for all peers in the room. The composition is higher quality (browser based composition similar to the perspective of a peer in the room) than room-composite-legacy (learn more). Refer [room composite recordings](/get-started/v2/get-started/features/recordings/recording-modes/comparing-recording-modes)

4. **Room composite legacy** = This asset type is a single video file (mp4) that composes audio/video tracks for all peers in the room.
4. **Room composite legacy** - This asset type is a single video file (mp4) that composes audio/video tracks for all peers in the room.

5. **Room Vod** - This is also a composition of all peers in the room and is available in HLS (or m3u8) format for on-demand playback. Based on your chosen recording storage option (100ms hosted or your storage bucket), you have the option to export this file in a zipped or un-zipped format. You can learn more about this here.

Expand All @@ -28,4 +28,4 @@ A recording can be anything, a text, a individual peers audio, remote peer's vid

8. **Summary** -This type contains the summary generated from the transcript. The metadata will contain the `output_mode` (json).

9. **Recording Link** - a pre-signed URL that can be downloaded by using Get Recording link API.
9. **Recording Link** - a pre-signed URL that can be downloaded by using [Get Recording link API](/server-side/v2/api-reference/recording-assets/get-presigned-url).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There are 2 types of Composite Recordings - Browser Composite and Custom Composi


<FlexContainer>
<Callout title="Browser Composite Recordings Basics" icon="ShieldIcon">
<Callout title="Browser Composite Recordings Basics" icon="CheckIcon">
- These are **browser based** recordings which records the screen to generate a composite recording file.
- They can be started automatically when the first peer joins and stopped after all peers leave with a timeOut configuration.
- Alternatively, they can also be started and stopped via client SDK or Recording APIs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Migrating from SFU recording
nav: 3.5
---

# Migrate from SFU to Beam

There are 2 methods to get composite recordings in 100ms. If you have been using "SFU recording", we recommend you move over to using "Browser Composite Recordings".
There are 2 methods to get composite recordings in 100ms. If you have been using "SFU recording", we recommend you move over to using [Browser Composite Recordings](/get-started/v2/get-started/features/recordings/recording-modes/composite-recordings).

### **Quick comparison**

Expand All @@ -25,3 +23,6 @@ Another way to start SFU recording is to programmatically create a room using th
>
## Migrating to Browser Composite Recordings
Head to your template on [100ms dashboard](https://dashboard.100ms.live/login). For customers on SFU or Custom Composite recording, you can switch to Browser composite recordings under Recordings tab. You can choose to auto-start recordings, enable audio-only recording, roles to record and their video resolution. Read more on how to [set up recordings →](/get-started/v2/get-started/features/recordings/set-up-recording)

![Recording Links](/guides/sfubrowser.png)
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Stream Recording Assets are classified into three types:
- **Audio** - contains only the audio track from microphone input for audio only calls where video tracks were not published at all by the peer.

<FlexContainer>
<Callout title="Stream Recording Basics">
<Callout title="Stream Recording Basics" icon="CheckIcon">

1. Stream recordings **start automatically** when the first peer joins a room, and stops automatically when the last peer leaves the room.
2. Recorded stream assets are of asset type `stream` and are available via Recording Asset APIs and stream recording webhook events.
3. Recording assets will be available within a few minutes of a successful recording event
3. Recording assets will be available within a few minutes of a successful recording event.
</Callout>
</FlexContainer>

Expand Down Expand Up @@ -43,7 +43,7 @@ A successfully recorded stream generates a recording asset of type `stream`. Ref

1. Using **[List Recording Assets API](/server-side/v2/api-reference/recording-assets/list-all-assets)** get the all stream recording assets for a session_id and asset_type=`stream`
2. Store the `id` as corresponding asset identifier of each stream.
3. Call the Get Presigned URL Asset API using the stream's `asset_id` to download the actual recording.
3. Call the [Get Presigned URL Asset API](/server-side/v2/api-reference/recording-assets/get-presigned-url) using the stream's `asset_id` to download the actual recording.


</StepsContainer>
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ A track represents a single media stream published into the WebRTC session captu
- **Audio track** - contains audio data captured from an audio source such as a microphone

<FlexContainer>
<Callout title="Track Recording Basics">
<Callout title="Track Recording Basics" icon="CheckIcon">
1. Track recordings **start automatically** when the first peer joins a room, and stops automatically when the last peer leaves the room.
2. Recorded track assets are of type `track` and are available via Recording Asset APIs and track webhook events.
3. Multiple track recording assets can be available for a single peer. For example, for a 1:1 call for Peer A and Peer B, with both publishing audio, video and desktop screen, there shall be 3 track assets for each peer.
4. Recording assets will be available within a few minutes of a successful recording event
4. Recording assets will be available within a few minutes of a successful recording event.
</Callout>
</FlexContainer>

Expand Down Expand Up @@ -46,7 +46,7 @@ A successfully recorded track generates a recording asset of type `track`. Refer

1. Using **[List Recording Assets API](/server-side/v2/api-reference/recording-assets/list-all-assets)** get the all tracks recording assets for a session_id and asset_type=`track`
2. Store the `id` as corresponding asset identifier of each track.
3. Call the Get Presigned URL Asset API using the track's `asset_id` to download the actual recording.
3. Call the [Get Presigned URL Asset API](/server-side/v2/api-reference/recording-assets/get-presigned-url) using the track's `asset_id` to download the actual recording.

</StepsContainer>

Expand All @@ -55,10 +55,10 @@ A successfully recorded track generates a recording asset of type `track`. Refer
<FlexContainer>


<Callout title="Get track recording updates via webhooks">
- Track recording success
- Track recording started
- Track recording failure
<Callout title="Get track recording updates via webhooks" icon="ShieldIcon">
- [Track recording started→](/server-side/v2/how-to-guides/configure-webhooks/webhook#trackrecordingstartedsuccess)
- [Track recording success→](https://www.100ms.live/docs/server-side/v2/how-to-guides/configure-webhooks/webhook#trackrecordingsuccess)
- [Track recording failure](https://www.100ms.live/docs/server-side/v2/how-to-guides/configure-webhooks/webhook#trackrecordingfailure)
</Callout>

</FlexContainer>
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ nav: 3.3

Follow this guide to enable recordings on 100ms dashboard.

<video loop="true" autoplay="true" id="vid" muted>
<source src="/docs/guides/new-recordings.mp4" type="video/mp4" />
</video>

<StepsContainer id="recording-setup">

### Enable recordings
Expand Down
Binary file added public/guides/new-recordings.mp4
Binary file not shown.
Binary file added public/guides/sfubrowser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit acfbada

Please sign in to comment.