HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - JoinStreamOptions

Home > @rainway/web > JoinStreamOptions

JoinStreamOptions interface

Signature:

export interface JoinStreamOptions 

Properties

PropertyModifiersTypeDescription
metrics?boolean

(Optional) 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.)

streamFit?StreamFit

(Optional) Control how the stream container fits isolated apps. Ignored if the stream is not using app isolation.

- IsolatedApps makes the stream fit only the bounding rectangle of all windows belonging to the isolated app. The stream picture might grow and shrink as this rectangle changes. This is the default setting.

- FullDesktop makes the entire desktop always be streamed, even in the App Isolation capture mode. This might cause the stream container to have a large border of empty space around the isolated app.