Update ringing config usage docs

[rahul-lohra]

Goal

Update ringing config usage docs

Implementation

None

🎨 UI Changes

None

Testing

None

Summary by CodeRabbit

• New Features

  • Added configuration options to control ringing sounds when the device is muted, with separate toggles for incoming and outgoing call behavior.

• Documentation

  • Updated documentation references for ringing configuration clarity.

[github-actions]

PR checklist ✅

All required conditions are satisfied:

• Title length is OK (or ignored by label).
• At least one pr: label exists.
• Sections ### Goal, ### Implementation, and ### Testing are filled.

🎉 Great job! This PR is ready for review.

[coderabbitai]

Walkthrough

The changes add ringing sound muting configuration to the Stream Video SDK. A new MutedRingingConfig interface with two Boolean properties controls sound playback when the device is muted, alongside a factory function for default configuration. Documentation references were also updated for clarity.

Changes

Cohort / File(s)	Summary
Documentation Updates stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoBuilder.kt	Updated @property sounds Javadoc to reference specific RingingConfig class path instead of generic Sounds reference.
Ringing Mute Configuration stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/sounds/RingingConfig.kt	Introduced new public interface MutedRingingConfig with playIncomingSoundIfMuted and playOutgoingSoundIfMuted Boolean flags. Added defaultMutedRingingConfig() factory function with default parameters. Updated documentation across factory functions for consistency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A new config hops into sight,
To mute or not when ringers chime,
Boolean flags dance left and right,
Documentation now reads just fine! 📞✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	PR description is severely incomplete, missing most required sections including detailed Goal, Implementation details, and proper contributor/reviewer checklists.	Complete the description with detailed Goal explaining why docs needed updating, Implementation describing what was changed, and fill out the contributor and reviewer checklists appropriately.
Title check	❓ Inconclusive	The title 'docs: Update ringing config usage docs' is vague and generic, using non-descriptive language that doesn't convey meaningful information about the actual changes made.	Consider a more specific title that reflects the actual changes, such as 'docs: Add MutedRingingConfig documentation' or 'feat: Add MutedRingingConfig interface and factory function' since the changes include a new public interface and factory function, not just documentation updates.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/rahullohra/ringing-config-1

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/sounds/RingingConfig.kt (1)

172-172: Minor: Extra blank line after KDoc.

There's an extra blank line between the KDoc and the function declaration that differs from the other factory functions in this file. Consider removing for consistency.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In
`@stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/sounds/RingingConfig.kt`
at line 172, Remove the extra blank line between the KDoc and the function
declaration for the RingingConfig factory so it matches the other factory
functions; locate the KDoc immediately above the RingingConfig factory function
(e.g., the companion/factory function named like "RingingConfig" or
"ringingConfig") and delete the single blank line so the KDoc is directly
adjacent to the function declaration.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In
`@stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/sounds/RingingConfig.kt`:
- Line 172: Remove the extra blank line between the KDoc and the function
declaration for the RingingConfig factory so it matches the other factory
functions; locate the KDoc immediately above the RingingConfig factory function
(e.g., the companion/factory function named like "RingingConfig" or
"ringingConfig") and delete the single blank line so the KDoc is directly
adjacent to the function declaration.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: b62e36eb-424a-48aa-917c-d3fb125d94c7

📥 Commits

Reviewing files that changed from the base of the PR and between 94feaea and 111fc7e.

📒 Files selected for processing (2)

• stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoBuilder.kt
• stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/sounds/RingingConfig.kt

[github-actions]

SDK Size Comparison 📏

SDK	Before	After	Difference	Status
stream-video-android-core	12.00 MB	12.00 MB	0.00 MB	🟢
stream-video-android-ui-xml	5.68 MB	5.68 MB	0.00 MB	🟢
stream-video-android-ui-compose	6.27 MB	6.27 MB	0.00 MB	🟢

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[stream-public-bot]

🚀 Available in v1.20.1