HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - JoinStreamOptions.metrics

Home > @rainway/web > JoinStreamOptions > metrics

JoinStreamOptions.metrics property

Enable stream metrics reporting.

If this is enabled, you can query stream.getReport() during or after the stream to get a JSON object describing what happened in the stream (events, stats, etc.)

Signature:

metrics?: boolean;