Skip to content

Commit cf9c360

Browse files
committed
fix: enhance documentation for audio related topics
1 parent b3c15f3 commit cf9c360

File tree

5 files changed

+12
-3
lines changed

5 files changed

+12
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@ The library provides a comprehensive set of Java classes that map to the WebRTC
2020

2121
## Getting Started
2222

23-
For more detailed examples and guides, check out the [quickstart guide](https://jrtc.dev/#/quickstart) and the specific examples in the project repository.
23+
For more detailed information, check out the documentation:
24+
25+
- **[Quickstart](https://jrtc.dev/#/quickstart)** - Get up and running quickly with webrtc-java
26+
- **[Guides](https://jrtc.dev/#/guide/overview)** - Comprehensive documentation on using the library
27+
- **[Examples](https://jrtc.dev/#/examples)** - Sample code demonstrating various features
28+
- **[Build Notes](https://jrtc.dev/#/build)** - Instructions for building the library from source
2429

2530
## License
2631

docs/assets/styles.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:root {
2-
--theme-color: #6366f1;
2+
--theme-color: #4f46e5;
33
}
44

55
/* Custom button styles for coverpage */

docs/guide/media_devices.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Cameras and microphones play a key role in WebRTC. In a more complex application
1212

1313
The `MediaDevices` class provides methods to query all available media devices connected to the system.
1414

15+
> Query devices on worker threads, not on UI or render threads.
16+
1517
### Audio Capture Devices (Microphones)
1618

1719
To get a list of all available microphones:
@@ -175,5 +177,6 @@ When implementing media device handling in your applications, consider these bes
175177
- Provide users with the ability to select from available devices
176178
- Implement hotplug listeners to dynamically update available devices
177179
- Remember to unregister device listeners when they're no longer needed
180+
- Query devices on worker threads, not on UI or render threads.
178181

179182
You can use the code examples in this guide as a starting point for applications that need to work with media devices in WebRTC scenarios like video conferencing, live streaming, or media recording.

docs/guide/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This section provides detailed guides for various features of the webrtc-java li
66

77
- [Media Devices](guide/media_devices.md) - Working with audio and video devices
88
- [Audio Device Selection](guide/audio_devices.md) - Selecting and configuring audio devices
9+
- [Audio Processing](guide/audio_processing.md) - Voice processing components
910
- [Bitrate and Framerate Constraints](guide/constraints.md) - Controlling media quality
1011
- [Desktop Capture](guide/desktop_capture.md) - Capturing and sharing screens and windows
1112

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
window.$docsify = {
1818
name: 'webrtc-java',
1919
repo: 'https://github.com/devopvoid/webrtc-java',
20-
themeColor: "#6366f1",
20+
themeColor: "#4f46e5",
2121
coverpage: true,
2222
onlyCover: true,
2323
loadSidebar: true,

0 commit comments

Comments
 (0)