HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - InboundStream.getReport()

Home > @rainway/web > InboundStream > getReport

InboundStream.getReport() method

Get a JSON-friendly report describing the events that occurred during this stream's lifetime, including transit throughput, negotiated codecs, and state transitions.

**Warning**: If metrics was not enabled in the options when creating or joining this stream, then the result is undefined.

Signature:

getReport(): StreamReport | undefined;

Returns:

StreamReport | undefined