The settings bar, button by button

Every button a viewer sees on top of your Eagle 3D Streaming stream, what each one does, where the bar sits, and how to move it. Five of them have a switch in the Control Panel; the rest are always shown.

During a session your app is covered by one small bar of controls. It is hidden behind a gear icon until the viewer opens it, and every button on it is optional — you decide which ones your viewers get. Turn the bar off entirely and the viewer sees nothing but your application.

Control Panel › your app › configuration › pencil icon › Advanced Options › UI tab. The switches there are Settings Control Bar, Draggable Settings Button, Fullscreen Button (not yet in effect on the production player), Screenshot and Quality Control Menu. The other buttons on this page have no switch yet. Save, and the change applies to sessions started from then on — a session already running keeps the controls it started with.

The bar, and the gear that opens it

What the viewer actually sees, and in what order

The viewer sees one gear icon. Pressing it slides the bar open; pressing it again closes it. There is no separate close button and nothing to dismiss — the gear is both.

When the bar is open, the buttons appear in this order, and each is covered in its own section below:

#ButtonWhat the viewer does with it
1ShareInvite someone else into this session
2ScreenshotSave a still of the stream
3Screen recordRecord the stream to a video file
4InfoConnection and stream statistics
5QualityChoose a picture quality preset
6VREnter the stream in a headset
7ResolutionChange the streaming resolution
8AudioVolume
9FullscreenFill the screen with the stream

A button you have never touched is on. The player treats a missing setting as “show it”, so apps configured before a button existed keep working and keep showing it. You only ever have to act to take something away.

Where the bar sits, and moving it

Four corners, plus letting the viewer drag it

The gear sits in a corner of the stream, 20 pixels in from each edge. By default that is the bottom right. If something important in your application lives in that corner — a logo, a menu, a readout — move the gear rather than redesigning around it.

SettingWhere the gear appears
Bottom RightThe default.
Bottom LeftOpposite corner, same edge.
Top RightUseful when your app puts its own controls along the bottom.
Top LeftUseful when the bottom edge is busy and the right side carries a panel.

The bar opens away from the edge it is anchored to. In a bottom corner it opens upward, in a top corner downward, and it works out which way round to go from where the gear actually is at that moment — not from the corner you chose. So it stays correct after the viewer drags it somewhere else or resizes the window.

Letting the viewer move it themselves

Draggable Settings Button lets the viewer pick the gear up and put it wherever they like. It is worth turning on when your application's own interface moves around — a corner that is clear on one screen may be covered on another, and the viewer can see which.

It is a hold, then move gesture rather than a plain drag: a short press first, so an ordinary tap still opens the bar instead of nudging the gear a few pixels every time. On a phone the button grows slightly when it is ready to be moved, which is the signal the viewer is meant to feel rather than read.

Share

Invite someone else into the session you are already in

Hands the viewer a link to the session they are in right now, so somebody else can open it and see the same running application. It is not a link to your app in general — it joins this one.

The person who opened the session stays the host. Guests arriving on a shared link appear in the participants list, and the host can hand control over or remove them.

Turn this off for a single-viewer product, or anywhere a session should not be forwarded — the link works for whoever receives it.

Screenshot

A still of the stream, saved to the viewer's downloads

Saves the current frame as a PNG. The picture is taken at the resolution the stream is actually running at, not the size of the browser window, so it is not stretched by whatever shape the viewer's window happens to be.

The viewer is told what happened either way: the file name when it is saved, and a reason when it is not — most often because the stream has not produced a frame yet, or because the device blocks downloads started by a web page. Apple devices and in-app browsers (a link opened inside a social or chat app) are the usual case for the second one, and the message says to open the page in Safari or Chrome directly instead.

Screen record

Record the stream to a video file

Records what the viewer is watching and saves it as a video file when they stop. Useful for capturing a walkthrough or reporting something that only happens occasionally — a recording answers “what exactly did you see” in a way a description cannot.

The recording is made in the viewer's browser and stays on their machine unless they send it somewhere. Nothing is uploaded by pressing this.

Info

Connection and stream statistics, for diagnosing a bad session

Opens a panel of live readings about the session: the codec in use, the resolution and frame rate actually being delivered, the bitrate, and the connection's own numbers.

This is the panel to ask a viewer for when they report that the stream “looks bad”. A description cannot separate a slow connection from a low frame rate from a resolution that was never high to begin with; these numbers can.

Leave it on for an internal or technical audience. Turn it off where the numbers would only be noise to the people using your application.

Quality

Let the viewer trade sharpness against smoothness

Offers the viewer a set of presets — low, medium, high and ultra — which move the picture quality the encoder aims for.

The trade is bandwidth. A higher preset sends more data for a sharper picture; on a connection that cannot carry it, the result is dropped frames rather than a better image. Low is the setting for a poor connection, where a softer but steady picture is easier to use than a sharp one that stutters.

VR

Enter the stream in a headset — and why the button may not appear

Puts the stream into a headset, for applications built to be viewed that way.

So the honest test of this setting is a headset. If you are checking it on a laptop, the button being absent tells you nothing either way.

Resolution

Change the size of the picture being streamed

Lets the viewer change the resolution the application renders and streams at. A smaller picture needs less bandwidth and less of the machine, which can turn an unusable session into a workable one; a larger one is sharper where the connection can carry it.

This is a different control from Quality, and they are worth keeping apart. Resolution changes how many pixels there are; Quality changes how much detail survives the compression of those pixels. A viewer on a poor connection is usually better served by lowering quality first.

Audio

Volume for the sound coming from your application

A volume control for the audio your application is sending. It changes what this viewer hears and nothing else — it is not a mute for the application, and in a shared session it does not affect anybody else.

Worth leaving on for anything with sound, simply because a viewer whose only option is their operating system's volume will turn down everything else on their machine too.

Fullscreen

Fill the screen — and the one device where it behaves differently

Expands the stream to fill the screen and hides the browser's own interface.

A button is switched on and still not showing

The four reasons, in the order worth checking
  1. The settings bar itself is off. Every button lives inside it. With the bar off there is no gear to press and nothing appears, whatever the individual switches say. Check this first — it explains most cases.
  2. The session started before the change. Saving affects sessions started afterwards. Close the session and open a new one.
  3. The device cannot do it. VR needs WebXR and a headset; Fullscreen is hidden on devices where only the video can go fullscreen. Both are the device answering, not the setting failing.
  4. You are looking at the wrong configuration. A link carries the configuration name in it. Editing one configuration and testing a link built from another shows no change, and nothing on either screen says so.

Last updated