Expose speakerStats via API

[moukmessie]

What problem are you trying to solve?

Currently, it is not possible to access detailed speaker statistics (speakerStats) such as total speech time or dominant speaker count through the iframeAPI. This limits the ability to analyze participant behaviors, generate reports, or integrate with external analytics systems. For deployments requiring these insights, there is no straightforward way to retrieve this data.

What solution would you like to see?

No response

Is there an alternative?

No response

[shawnchin]

This limits the ability to analyze participant behaviors, generate reports, or integrate with external analytics systems. For deployments requiring these insights, there is no straightforward way to retrieve this data.

For analytics and reporting, you may not want to do this on the client side iframe.

To handle this on the backend, you would write a custom prosody module that will have access to speakerstat data.

Alternative, you could use event_sync which sends room/occupant events to an external API. When configured with include_speaker_stats = true, it will include total_dominant_speaker_time from speaker stats in the event payload when occupants leave. It should be reasonably straight forward to modify the module to include the full speaker stats data on room events.