xmreality 6 - user manual for windows pp update · pause video and draw hit the pause button any...

XMReality AB | Teknikringen 10, 8 fl | SE-583 30 Linköping | Sweden 1

XMReality 6User Manual for Windows July 9, 2019

XMReality 6 - User Manual For Windows, July 9 2019 2

Introduction This is a user manual for XMReality Remote Guidance® Generation 6 for Windows.

An account on a Domain for XMReality 6 is required to use the application. The application can be downloaded from https://xmreality.com/downloads.

The XMReality apps for iOS and Android differs notably from the Windows version and are illustrated in a separate document.


Login screen The login window is the first screen that you face when opening the application. This is where you log in and find network settings.

Login Information — To log in to the application, enter your Email address and password.

If you've forgotten your password, click the "Forgot password" button below to restore your password.

Note that your device must be connected to the Internet and be able to reach the server in order to sign in.

Keep me logged in — If you check this checkbox, you will be logged in automatically and not have to reenter your password if the app is restarted.

Advanced settings — If you are unable to log in despite being connected to the internet, it may be that your network connection requires proxy settings to be modified. In that case, tap Advanced and go to the proxy settings. See Advanced Settings on page 24 for more information.


Contacts The Contacts view is the first view you will be faced with after logging in. The Contacts view contains three main parts. Main navigation to the left, followed by the Contact List and the selected Contact.

The Contacts view shows contacts that are members of the same teams as you (which is managed by Domain Administrators), and contacts that you've added yourself using the "Add contact" button.

Navigation Contact list Selected contact




Navigation

Profile and Log-out — In the top-left corner your own initials and online status is displayed. Clicking this area will allow you to log out, change your password, or to see information about your installed XMReality Client.

Video Setup — Clicking the Video Setup icon will take you to the video setup tab, which is where you adjust camera quality settings, configure the XMReality Pointpad and XMReality Smart Glasses, and it is also where you will reach the audio device settings.

Update available — A badge on the XM logo indicated that an update of the software is available. Click to install.

New activity — The purple badge on the contacts tab indicates a new unread item in the recents view, such as a new message or missed call.

Call Link — The Call Link tab allows you to create a Call Link which enables anyone to call you on XMReality without using the app.




Contact list showing recents

Team filter — The Team filter dropdown menu allows you to either select a single Team to display contacts from or to display contacts from all Teams that you are a member of. By default, all contacts available to you will be displayed.

Recents — The contacts are displayed alphabetically. Tapping a contact takes you to the contact page, from where you can enter the chat or initiate a Remote Guidance call.

Contact Status

Each profile has a round status indicator next to their name:

Available - The contact logged in and has had the app open recently.

Busy - The contact is busy in a call, can not be called, but can receive chat messages.

Offline - The contact is does not have the app open, but can receive calls and chat messages if they have logged in on a device.

All Contacts — Click to see all contacts (see next page)

Contact Status

Each profile has a round status indicator next to their name:

Active now - The contact logged in and has had the app open recently.

Busy - The contact is busy in a call, can not be called, but can receive chat messages.

Inactive - The contact is not active in the application, but if logged in on mobile can receive calls and messages.




All Contacts — The contacts are displayed alphabetically. Tapping a contact takes you to the contact page, from where you can enter the chat or initiate a Remote Guidance call.

Contact list showing all contacts



The contact list can be sorted to display the contacts you recently interacted with or all contacts, sorted alphabetically.

Selected contact

Chat — The bottom portion of the screen contains the chat. In the chat, you can also see other events such as missed calls. Messages are typed in the Message field at the bottom, and are sent by hitting the enter key.

Contact Information — For every contact, you can see the following information at the top of the screen:

• Name

• E-mail address

• Online Status

Call — To call the contact, click the Call Button and a call will be started in a new window.


Creating Call Links A call link enables anyone to call you on XMReality without using the app.

To use Call Links, create a link and send it to the person that needs to connect to you. Regardless of whether the recipient receives the link via email, SMS, or some other means, they simply open it in their browser, and click "Start Remote Guidance" to call you directly. They don't need to install the app and you don't have to set up a user account for them.

1

1. Enter a link ID or recipient name (optional).

2. Click on the button below to create the link.

3. The link has now been created, click the button to copy the link and send it by for example sms or email.

4. If you want to create a new link, click the button in the bottom of the screen.

23

4


Using Remote Guidance When you’ve clicked the call button the call will be initiated in a new window.

End Call — Click to end call.

Show Options — Click to open options menu.

Call information — The name of the other user and duration.

Share — Click here to open the Share menu and start or stop sharing live video from one of your cameras, an image file, your desktop or a window.

Pause video — Click here to pause the video. (The button is shown as disabled in this image because there is no video being shared)

Fullscreen — Click here to toggle full screen.

Mute mic — Clicking here will mute your microphone and the other user will not receive any sound from you. Tap again to un-mute.


Options Menu The Show Options button presents a list of the call participants and the Remote Guidance tools.

Hands Overlay — This allows you to use your hand to point and make gestures in the other user’s video. See Hands overlay on page 14 for more information.

Text Overlay — Allows you to insert text overlays over the background feed. See Text Overlay on page 17 for more information.

Capture — This option provides you with a capture widget to take snapshots and make video recordings of the video. See Capture on page 18 for more information.

Hide Options — Click here to close the menu.

Add Participant — Click here to add a participant to the call. (if multiple participant calls are enabled)

Draw — Allows you to draw on a paused video frame or shared image. The button is currently disabled as there is no video or image currently being shared.


Pause Video and Draw Hit the pause button any time to pause the video. This freezes the video at the current frame, and automatically activates the Draw mode.

This allows you to draw on the image is now still, as well as using all the other in-call without requiring the person sharing the video to hold their device still.

Background — This is a paused video, indicated by the highlighted pause button in the menu bar.

Instructions — Instructions drawn by the user.

Controls — Change color, undo last line, clear all.


Adding participants Clicking the Add Participant button in the options menu will bring up the participant picker, that allows you to invite up to five people to the same call. Simply click on the contact you wish to add, and the system will call them up to join the conference.

Note: This is not available for all Domains. Please contact your customer project manager or key account manager at XMReality for more information.

How to use

To add a participant to an ongoing call open the options menu, click the add participant button, select a contact from the contact picker.


Hands Overlay The Hands Overlay feature allows you to provide rich, natural, and intuitive instructions using your hands and other objects. It allows you to show how complex actions are performed, and it allows you to point and give directions that are much more effective that with only voice and video.

How to Use

In order to use the Hands Overlay feature, you need to configure a camera to use as a Pointpad, see Configuring Hands overlay on page 16 for more information. Place your hand in between the back surface of the Pointpad and the top-mounted Pointpad camera to show it to the other person.

Background — This is the background shared by another person or yourself. It can be a live video, an image, or screen.

Hands Overlay — This is the hand of the local user who is guiding.


Hands Overlay For the best experience, please keep the following things in mind.

Guidance tips

• When guiding someone using this feature, be mindful of where your fingers are pointing and how many fingers the other person can see, as it can be confusing to see a finger pointing at something when not part of an instruction.

• When guiding someone, be prepared to indicate to them where they need to point their camera, as it is easy to forget that you can only see what’s on your screen and not everything else that they can see.

• The person receiving instructions should try to keep their device still while instructions are performed (unless told otherwise), to avoid confusion.


Pointer The Pointer feature allows you to point in the background feed, whether shared by yourself or your counterpart. It is not as powerful for giving instructions as the Hands Overlay feature, but it benefits from being easy to use: It is not dependent on having a Pointpad connected, any background or lighting condition, and it does not obscure as much of the video for the other person.

How to Use

Simply click and hold anywhere in the video to activate the pointer. The pointer will follow your cursor for as long as you hold down the mouse button.

This feature is particularly useful in the following situations:

• When it is difficult or inconvenient to use the Hands Overlay feature.

• When all you need to point out is something simple, that you and the other user have shared understanding of.

• When you want to point at something in your own background feed.

Background — This is the background shared by another person or yourself. It can be a live video, an image, or screen.

Pointer — This is the pointer that is being controlled by the local user that is guiding the remote user.


Text Overlay The Text overlay feature allows you to type in a series of text messages that are displayed on the other person’s screen. Text overlays are useful for providing step-by-step instructions and for communicating specific codes or commands that the other person should look for or enter.

How to Use

The Text Overlay widget appears in the bottom center of the call window, above the call controls. Type in a message in the text box and click the arrow to show it to the user being guided.

Video — This is the video being shared by the remote user being guided.

Active Text — This text is visible to the remote user. Click the x next to the text to remove it.

Textbox — Type text in this box and click the arrow to activate it.


Capture The Capture feature allows you to make video recordings and take pictures of what’s being displayed in the video feed, including video, images, shared screens, overlays and pointers, and save for later reference.

How to Use

When the Capture mode is enabled, a Capture widget appears in the bottom right-hand corner of the call window.

• Click the camera icon to take a snapshot.

• Click the red recording button to start a video recording. A red stop button will appear in its place while recording, which is used to stop a video recording. The other person in the call will be notified that a recording is taking place

• The grey pause button pauses the video recording. Clicking it while paused resumes the video recording.

Recording History

Video recordings and snapshots taken during the current call will appear in this list. Clicking an entry here opens the snapshot or video with your system’s default application for the corresponding file type. Clicking the folder icon next to the image will show the file in File Explorer.

Recording History

Capture controls

Save folder — Click this button to pick folder for

saving media.


Guide on image In addition to using live video as the background in a Remote Guidance call, you can also use a still image.

If you wish to use a still image from the current video stream, simply click the pause button.

When to Use

• When a video call cannot be made right where and when guidance is needed, you can take a few pictures and give instructions on them at a different time and place.

• When you want to bring in content from other places, such as screenshots, drawings, and documents, you can insert them as images.

Picture — This is the picture being shared by the user.

Share menu — Open the share menu and click Select File to share an image.

In this screenshot the user is already sharing an image and this is indicated by the photo icon and blue highlight on the button.


Screen share Screen share allows you to share the entire screen or a specific window.

When you are sharing a window, it will show up in the Call Window and you can use all the other features inside the call window like normal. When a screen is being shared, the Call Window will be inactive on the sender side, to prevent feedback loops , but pointers from other participants will be shown directly on your desktop instead.

Share menu — Open the share menu and click Share Screen to share a dialog will pop up that allows you to choose which screen or window you would like to share.

In this screenshot the user is already sharing a window and this is indicated by the icon and blue highlight on the button.

Window compatibility

Due to technical differences in how different windows are generated, some may not be available to share as windows, or they may not show up properly. These windows however can be shared without issue by sharing the screen there’re displayed on instead.

Screen — This is the screen being shared by the user, in this case it’s a window from the PDF application.


Video Setup The video setup screen is where you can configure Pointpads (see next page) and Smart glasses (see page 18), and it allows you to set which quality settings your cameras should use. The quality levels available will depend on which camera you use. Each setting will specify a resolution and a frame rate, which will affect the bandwidth required to transfer the video.

Audio settings — Click here to open a dialog that allows you to change which speakers and which microphone should be used during calls. The default setting will use whichever device the operating system says should be default.

Settings Preview


Configuring Hands Overlay (1/2) The XMReality Pointpad provides the best experience when using Hands overlay on a Windows device. This page describes how to configure the Pointpad for first use.

Configure a Pointpad

1. Make sure the Pointpad’s USB cable is connected to your computer.

2. Make sure to turn on the Pointpad’s built-in LED light.

3. For uEye-based Pointpad models, make sure that the uEye camera drivers have been installed, which can be found at https://xmreality.com/downloads.

4. Select the Pointpad’s camera in the Camera dropdown menu.

5. Change the camera’s Type to Pointpad

6. Click Calibrate Pointpad Camera and follow the on-screen instructions.

The Pointpad is now ready to use. The Pointpad is enabled in a call by selecting the Pointpad option in the Remote Guidance menu within the call.

Before use, you can revisit this screen to verify that the settings are still appropriate for your lighting conditions, and recalibrate if neccessary. For more fine-grained control, you can go to Advanced Settings (7), see page 23.

Camera Dropdown (4)

Quality Dropdown

Type Dropdown (5)

Calibration Button (6)

Advanced Settings (7)

Different version of Pointpad

If your Pointpad camera shows up in the list without a driver, you have the new version of Pointpad that doesn’t need a separate driver installation.


Configuring Hands Overlay (2/2) In the Advanced Settings, you can manually adjust how the Pointpad camera will behave. This will overide any settings placed during calibration, but you can always recalibrate the settings if you are not happy with the manual changes.

Hand Segmentation Threshold — Determines the degree to which the background is segmented away in the final image. Calibrating the Pointpad camera will set this to a fixed value. You can also use the Auto checkbox to have this value change dynamically during use.

Camera Exposure and Gain — These control the brightness of the image. Note that in addition to these settings, the Pointpad built-in light should also be connected in use to provide the proper lighting conditions. Calibrating the Pointpad camera will set these sliders to fixed values, but you can adjust them manually efterwards if desired.


Configuring Smart Glasses The XMReality Smart Glasses can be used with a Windows device to provide hands-free operation when receiving instructions. Configuring the Smart Glasses is illustrated on this page. Refers to using the PC-connected XMReality RG-15, RG-16, RG-15H glasses. For Android-based smart glasses, please refer to the XMReality 6 - User Manual for Mobile.

Configuring XMReality Smart Glasses

1. Make sure the Glasses’ USB cable (first) and the display connector (second) are connected to your computer.

2. Make sure that the uEye camera drivers have been installed, which can be found att https://xmreality.com/downloads.

3. Select the Glasses’ uEye camera in the Camera dropdown menu.

4. Change the camera’s Type to Glasses

The Smart Glasses are now ready to use. When the Glasses are connected to the computer, the Glasses’ camera image will be shown in the Glasses’ displays, and instructions can be provided directly in your field of view.

Camera Dropdown (3)

Quality Dropdown

Type Dropdown (4)


Advanced Settings The Advanced Settings are accessed from the login screen and contain settings regarding which XMReality Domain server to use, and options to enable HTTP(S) proxy. Do not modify any of these settings unless you have been told to by XMReality support or your administrator.

Server settings — Here you specify which XMReality Domain Server that you wish to connect to. Note that these settings should not be modified unless your organization uses an internally hosted server, or if you have been instructed by XMReality to connect to a different server than the standard server. You specify a server by providing the Server hostname, the port you wish to connect to and whether or not to connect using secure protocol (HTTPS). Unless instructed otherwise, these settings should be left at the default values.

Proxy settings — If your network connection requires your network traffic to be routed through a proxy server you can specify a proxy server here. By default, the application will use the proxy settings provided by the operating system, but you can manually change the settings here or turn proxy off. If you are unable to login to the server despite being connected to the internet and providing accurate login credentials, then you may need to modify the proxy settings.. If that is the case, contact the person responsible for deploying XMReality within your organization for information about what you need to enter here.

Test connection — If you have made adjustments here, there is an option to test your settings further down. The application will indicate whether it was able to connect to the specified domain server with the given settings.

Default Values

Server: server-v6.xmreality.com

Port: 443

Secure Protocol: Checked

xmreality 6 - user manual for windows pp update · pause video and draw hit the pause button any...

Documents