Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create audio-levels.mdx #2280

Merged
merged 2 commits into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Show Audio Levels
nav: 4.46
---

## Audio Level

The audio level for every speaking peer can be retrieved by listening to 'onUpdatedSpeakers' callback in 'HMSUpdateListener', like so.

```swift
public func on(updated speakers: [HMSSpeaker]) {
if let firstSpeakingPeer = speakers.first {
let audioLevel = firstSpeakingPeer.level
// Use this audio level
// level : `Int` The level of the audio. It may vary from 0-100. A higher value indicates a higher speaking volume.
...
}
}
```

Note: on(updated speakers) is called when set of speaking peers change in the conference call. These are called active speakers. If you'd live to know the current dominant speaker, you can just get the first speaker in the list as the speaker list is sorted based on their audio levels, that is, loudest speaker is first in the list.
Loading