Skip to content

Commit d604e97

Browse files
Fix room doc and update readme (#220)
1 parent e790139 commit d604e97

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@
1111
# C++ client SDK for LiveKit
1212

1313
<!--BEGIN_DESCRIPTION-->
14-
Use this SDK to add realtime video, audio and data features to your C++ app. By connecting to <a href="https://livekit.io/">LiveKit</a> Cloud or a self-hosted server, you can quickly build applications such as multimodal AI, live streaming, or video calls with just a few lines of code.
14+
Use this SDK to add realtime video, audio and data features to your C++ app. By connecting to <a href="https://livekit.io/">LiveKit</a> Cloud or a self-hosted server, you can quickly build applications with just a few lines of code:
15+
16+
- **Teleoperation and robotics:** stream camera and sensor data from robots, drones, vehicles, or embedded devices while sending operator commands and control signals back in realtime.
17+
- **Multimodal AI inference:** connect native C++ applications and models to live audio, video, and data with raw frame access.
18+
- **High-performance media pipelines:** integrate LiveKit with existing C++ video, broadcast, AR/VR, FFmpeg, or GStreamer workflows without another language runtime.
19+
- **Live streaming and video calls:** add reliable realtime communication to desktop, edge, and embedded applications.
1520
<!--END_DESCRIPTION-->
1621

1722
[![CI](https://github.com/livekit/client-sdk-cpp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/livekit/client-sdk-cpp/actions/workflows/ci.yml)
@@ -22,7 +27,7 @@ Use this SDK to add realtime video, audio and data features to your C++ app. By
2227

2328
- [LiveKit docs](https://docs.livekit.io)
2429
- [SDK reference](https://docs.livekit.io/reference/client-sdk-cpp/)
25-
- [Repository docs](./docs/README.md) — building, authentication, testing, logging, tracing
30+
- [Repository docs](./docs/README.md)
2631

2732
## Using the SDK
2833

‎include/livekit/room.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ class LIVEKIT_API Room {
168168
/// Disconnect from the room.
169169
///
170170
/// This method attempts a best-effort graceful disconnect of the room. If the room was connected prior, after @ref
171-
/// disconnect() is called the room object is considered in a terminal state and should no longer be used. If @ref
171+
/// disconnect() is called the room object must be connected again to be valid. If @ref
172172
/// disconnect() was called before @ref connect(), no operations are performed and the room object is still valid.
173173
///
174174
/// @note `~Room()` invokes `disconnect()` automatically if the room is

0 commit comments

Comments
 (0)