Skip to content

docs: consolidate camera streaming user guide - #1267

Open
farbod-nv wants to merge 2 commits into
mainfrom
docs/consolidate-camera-streaming
Open

farbod-nv wants to merge 2 commits into
mainfrom
docs/consolidate-camera-streaming

Conversation

@farbod-nv

@farbod-nv farbod-nv commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Televiz documentation consolidation

Summary by CodeRabbit

  • Documentation
    • Expanded the Camera Streaming guide with setup, configuration, run, deployment, and service-management instructions.
    • Added guidance for camera controls, status displays, CloudXR connections, and split-mode operation.
    • Updated the sample README with an overview of camera visualization and links to the guide and sample configurations.

Signed-off-by: Farbod Motlagh <fmotlagh@nvidia.com>
@farbod-nv farbod-nv self-assigned this Oct 14, 2026
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: ce5e9b5b-ccff-4976-9c1d-a4fe642f20df

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: fe2ad033-3636-4044-8dfb-97b66ad5655b
📥 Commits

Reviewing files that changed from the base of the PR and between c69fe07 and 93ffc52.

📒 Files selected for processing: 2
  • docs/source/references/camera_streaming.rst
  • examples/camera_viz/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The camera-streaming guide is now the primary reference for setup, commands, configuration, controller behavior, deployment, and CloudXR. It adds configuration examples and runtime details. The sample README now provides a short overview and links to the guide and sample configurations.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documented change: consolidating the camera streaming user guide.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

- Retunes the active shape: ``quad`` size / vertical position, ``cylinder`` arc width /
vertical position, ``equirect`` horizontal / vertical span.

The left stick's horizontal / vertical axes adjust size (preserving aspect ratio) / height on

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This paragraph repeats the left-stick row immediately above. Could we fold the horizontal/vertical axis mapping and aspect-ratio detail into that row and remove this paragraph?

:doc:`/getting_started/teleop_session` for the ``TeleopSession`` side.

``viz_session.get_oxr_handles()`` returns ``(instance, session, space, proc_addr)`` as raw
``uint64`` values, or ``None`` outside ``kXr``.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: just kXr is a bit hard to read.

Could we qualify kXr as isaaccapture.viz.DisplayMode.kXr here so readers can understand that this is about the display mode?

Signed-off-by: Farbod Motlagh <fmotlagh@nvidia.com>

This branch was successfully deployed

1 active (outdated) deployment
dev — 93ffc52b Deployed Oct 14, 2026 by farbod-nv via publish-wheel #5627
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants