chore: add docs for recording quality and portrait mode (#761)

GetStream · Oct 1, 2024 · 9382d47 · 9382d47
1 parent bc7d9e3
commit 9382d47
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/...aurus/video/docusaurus/docs/api/assets/recording-resolution-and-orientation.png b/...aurus/video/docusaurus/docs/api/assets/recording-resolution-and-orientation.png
diff --git a/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx b/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx
@@ -5,6 +5,7 @@ slug: /recording/calls
 title: Recording calls
 ---
 
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -715,6 +716,66 @@ Here you can find the complete list of options available to each layout.
 | grid.rows                                | number  | `4`         |                                       | how many rows to use in grid mode                                                                                                                                                                        |
 | participant.aspect_ratio                 | string  |             | `"9/16", "4/3", "1/1", ...`           | The aspect ratio of the participant                                                                                                                                                                      |
 
+## Recording resolution and portrait mode
+
+Calls can be recorded in different resolutions and modes (landscape and portrait). On the dashboard, you can configure the default settings for all calls of a specific call type.
+
+<img src={require('../assets/recording-resolution-and-orientation.png').default} style={{ width: '50%' }} />
+
+While this can be configured from the dashboard, you can also set it for individual calls:
+
+<Tabs groupId="examples">
+<TabItem value="js" label="JavaScript">
+
+```js
+client.video.updateCallType({
+  name: callTypeName,
+  settings: {
+    recording: {
+      mode: 'available',
+      quality: 'portrait-1080x1920',
+    },
+  },
+});
+```
+
+</TabItem>
+<TabItem value="py" label="Python">
+
+```py
+from getstream.models import CallSettingsRequest, RecordSettingsRequest
+
+client.video.update_call_type(
+    "default",
+    settings=CallSettingsRequest(
+        recording=RecordSettingsRequest(
+            mode="available",
+            quality="portrait-1080x1920",
+        ),
+    ),
+)
+```
+
+</TabItem>
+<TabItem value="curl" label="cURL">
+
+```bash
+curl -X PUT "https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE_NAME}?api_key=${API_KEY}" \
+  -H "Authorization: ${TOKEN}" \
+  -H "stream-auth-type: jwt" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "settings": {
+      "recording": {
+        "mode": "available",
+        "quality": "portrait-1080x1920"
+      }
+    }
+  }'
+```
+</TabItem>
+</Tabs>
+
 ## Custom recording styling using external CSS
 
 You can customize how recorded calls look by providing an external CSS file. The CSS file needs to be publicly available and ideally hosted on a CDN to ensure the best performance.