Skip to content

Commit 1bfe7e5

Browse files
Deepak Kancharlameta-codesync[bot]
authored andcommitted
{Documentation} Client SDK - Add multi-device callouts to single-device pages
Summary: Explanation: Adds three lightweight `:::tip` callouts on the single-device pages so readers discover the multi-device guide and the `device_id` callback pattern. Three files: - `client-sdk/recording.mdx` — "Multiple devices?" tip after the existing auth caution, pointing at the multi-device guide. - `client-sdk/streaming.mdx` — same tip as above, scoped to streaming. - `client-sdk/python-sdk/streaming-example.mdx` — "Multi-device callbacks" tip at the top of "Code Walkthrough", documenting the optional `device_id` callback parameter and pointing at the multi-device streaming example. Reproducibility: Render `client-sdk/` locally and verify each tip renders below the existing auth caution on `recording.mdx` / `streaming.mdx`, and at the top of "Code Walkthrough" on `streaming-example.mdx`. Reviewed By: PiotrBrzyski Differential Revision: D104153887 fbshipit-source-id: e30c205829b4f065ed390f60bd5a264ecfce931d
1 parent 2c73715 commit 1bfe7e5

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

website/docs-ark/client-sdk/python-sdk/streaming-example.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ The script performs the following operations:
4848

4949
## Code Walkthrough
5050

51+
:::tip Multi-device callbacks
52+
For multi-device streaming, add an optional `device_id: str | None = None` parameter to any callback to receive the source device's serial — the SDK auto-detects it via `inspect.signature()`. See [Multi-Device Streaming Example](/ark/client-sdk/python-sdk/multi-device-streaming-example).
53+
:::
54+
5155
### Step 1: Import Required Modules
5256

5357
```python

website/docs-ark/client-sdk/recording.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ The ClientSDK provides comprehensive CLI tools to manage recordings on your Aria
2020
Before using **any** recording commands, you **must** authenticate your device by running `aria_gen2 auth pair` (see [Device Authentication](/ark/client-sdk/authentication)). This only needs to be done **once** per device-PC combination, but **all recording and streaming operations will fail without it**. You can verify your authentication status at any time with `aria_gen2 auth check`.
2121
:::
2222

23+
:::tip Multiple devices
24+
To orchestrate recordings across two or more connected devices in one command, see [Multi-Device Recording & Streaming](/ark/client-sdk/multi-device).
25+
:::
26+
2327
## Available Recording Profiles
2428

2529
Before starting a recording, you need to select a recording profile that defines the sensor configuration, data rates, resolutions, and encoding formats. Project Aria Gen2 offers several pre-defined profiles:

website/docs-ark/client-sdk/streaming.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ The ClientSDK provides powerful streaming capabilities that allow you to receive
2020
Before using **any** streaming commands, you **must** authenticate your device by running `aria_gen2 auth pair` (see [Device Authentication](/ark/client-sdk/authentication)). This only needs to be done **once** per device-PC combination, but **all streaming and recording operations will fail without it**. You can verify your authentication status at any time with `aria_gen2 auth check`.
2121
:::
2222

23+
:::tip Multiple devices?
24+
To orchestrate streams across two or more connected devices in one command, see [Multi-Device Recording & Streaming](/ark/client-sdk/multi-device).
25+
:::
26+
2327
## Overview
2428

2529
Streaming enables you to access real-time data from your device:

0 commit comments

Comments
 (0)