Magic Leap Spectator is a mobile application that makes it easy for anyone to capture and share high-quality mixed reality content streamed from a Magic Leap 2 device. This powerful application supports a wide variety of use cases including:
- Creating video documentation of your Magic Leap 2 applications.
- Creating second-screen experiences for demos.
- Filming “how-to” videos for your ML2 applications.
- Broadcasting your ML2 application content live to audiences at events.
ML Spectator allows you to record your digital content as videos or photos.
This guide covers the basic installation and use of ML Spectator. For more advanced features and developer support see:
What’s New
New Features:
- An option for Auto-Reconnect has been added to the settings.
Installing Magic Leap Spectator
Installing on iOS
Magic Leap Spectator is available in the iOS App Store here.
Installing on Android
Magic Leap Spectator is available in the Google Play Store here.
Launch Magic Leap Spectator
Open the Magic Leap Spectator App
Once the app has been downloaded, navigate to your device’s home screen and select the app to launch it. On launch the app asks for necessary permissions in order to begin. Select Allow on these permissions to enter and use the app.
Note: Permissions are needed for ML Spectator to work properly and provide a complete experience. For more information on why these permissions are necessary, see: Mobile Device Requirements.
Using Magic Leap Spectator
Setting Up - Your Environment
Setting Up Your Surroundings
As ML Spectator is designed to stream spatial content, it's likely that a sizable space is required to position and view your content. Make sure you are in an environment that has enough space to view the scale of your AR project on both devices, and that also allows you to walk around freely.
An uncluttered space will not only allow you to move around your content uninhibited, but will also minimize the risk of the real-world environment drawing over your digital content. For more best practices on setting up your space, see: General Setup & Recording Best Practices.
Setting Up - Print ML Spectator Marker
Print A Marker
In order to align the world-view of your Magic Leap 2 headset and your mobile device, you will need to place a physical marker in your space and have both devices scan it. You can print and/or download the marker within the ML Spectator app (go to Help or Settings and select Print Marker), or by opening this link - ML_Spectator_Marker.pdf.
Print the marker at 100% scale with no margins. The black square of the marker should be 15cm wide if printed correctly.
Connect to a Magic Leap 2 Device
Connect Devices to Wi-Fi
To begin, you must ensure that both of your devices (your mobile phone and Magic Leap 2) are connected to the same Wi-Fi network. To create a stable, performance-optimized connection, it is highly recommended to use a 5Ghz network in an area that has strong Wi-Fi connectivity for both devices. Interference and distance from your Wi-Fi router can lead to a drop in performance and functionality.
Connect ML Spectator to a Magic Leap 2
There are two primary methods to connect to a Magic Leap 2 device: auto-detect device and manual IP address search.
Note: In order to connect to a Magic Leap 2 device with ML spectator, the Magic Leap 2 device must be running an ML Spectator-compatible app. Otherwise, your ML2 will not be found in the ML Spectator device list and you will not be able to make a connection. For more information see: How To Install The Magic Leap Spectator Unity Package.
Auto-Detect Device
ML Spectator’s main screen on launch is the device connection screen (see image below). Whenever launching this screen, the app will always try to detect Magic Leap 2 devices that are online. Online means ML Spectator can detect an ML2 device that is:
- On the same Wi-Fi network as your mobile device.
- Is running an ML Spectator-compatible app (that’s not running in the background).
- ML Spectator access has been enabled in the App Settings (where this applies).
The app will try to auto-detect a device (or devices) as indicated by the Searching for devices status. If a device(s) is found, then it will appear in the Online devices list.
Online Magic Leap 2 devices will be identified in the list by either a unique identifier (If one has been set) or the name of the app currently running on the headset. (see: Permissions)
To connect to an online device in the list, simply select its IP address.
If ML Spectator cannot automatically detect a device, then a Device not found indicator will be displayed. You can try to auto-detect again by pressing Refresh or manually searching for an ML2 using its IP address.
Manual IP Address Search
The manual IP address search function can be accessed by selecting Manual IP Search, at the bottom of the screen. This will bring up an overlay to input an IP address.
On this screen users can:
- Enter a device IP address - Selecting the input field will allow users to manually input an IP address.
- See recent IP connections - A list of successful connections will appear in the order of how recently the connection was made. Selecting an IP address here will attempt to connect to that address.
- Clear all recent connections - Pressing the trash icon will clear the list of recent connections.
Note: If your devices change the Wi-Fi network they are connected to, then their IP addresses will change also. This means you will have to enter the new IP address for your Magic Leap 2 in order to find this same device again on a new network.
Where To Find Your Magic Leap 2 IP Address
You can find your Magic Leap 2 IP address on your ML2 headset by going to Settings > About and then scrolling down to the IP Address section.
Magic Leap Spectator Settings for Compatible Applications
Some Magic Leap 2 applications may need you to enable an Allow Magic Leap Spectator Connectivity setting found within the Magic Leap 2 application’s settings page. However, this setting will differ from application to application. Therefore, it’s best to check within the application itself or review developer documentation to clarify whether or not your specific app will require this permission to be allowed.
Unique Device Identifier
Some applications may also allow the user to input an optional, unique identifier that will make discovering the app easier in ML Spectator. This unique identifier will appear on the Connecting to a Magic Leap 2 device screen in ML Spectator along with the IP address for easier identification. This is particularly useful if you have multiple ML2 devices running ML Spectator-compatible applications all on the same network. If a unique identifier is not applied, ML Spectator will display the app name.
Successfully Connecting
After successfully connecting, the app will move onto the Scan Marker screen, or, if the connection fails, users will be brought to the Couldn’t establish a connection screen.
Here you can check key troubleshooting information, visit the Help section of the app, or try the connection again. You will also find relevant information in order to help diagnose connection issues.
Auto-Reconnect
If the connection is lost and the auto-reconnect setting is enabled, ML Spectator will automatically attempt to reconnect. During an attempted reconnection a notification will display across the top of the screen saying Connection Interrupted - Attempting to Reconnect. If successful the notification will change to Connection Reestablished. To stop a reconnection attempt simply press the Disconnect button. If the connection is lost when the app is in the background see: Connection to device was lost while the application was paused.
Permissions Notification
When attempting to connect to a device you will be prompted to enable in-app permissions for ML Spectator, if a device is not recognized. Permissions for discovery need to be enabled before ML Spectator can recognize and connect to an ML2 device.
Synchronizing Device Locations
Scan Marker - Magic Leap Spectator App
After successfully connecting ML Spectator to a Magic Leap 2 device, the next step is to align the real-world positions of your two devices. This will ensure that the AR content seen on both devices appears in exactly the same position relative to the real world.
The Scan Marker process will begin on the mobile device running ML Spectator. Start by placing the printed marker in your immediate environment, either on the floor or on a raised surface (such as a table). The marker can be placed anywhere in your environment (it does not need to be in the center of your AR content) as it is merely used to sync the location of the two devices (not the location of the content itself). To scan the marker, hold your mobile device so that the marker is within the scanning reticle. The marker must stay in place for both scans. If the marker is moved between when the mobile device and the headset scan it, then the alignment may be off significantly. Once both devices have scanned the marker it may be moved / removed from the scene entirely
Note: Ensure that the marker is in a well lit environment to allow both your mobile device and ML2 to scan it successfully. The marker does not need to be scanned from directly above. In fact scanning at a shallow angle can help improve accuracy. It is also suggested that the marker not be placed on a blank, featureless surface.
Scan Marker - Magic Leap 2 Device
Once the ML Spectator app on the mobile device has successfully scanned the marker, the Magic Leap 2 device app will need to scan the marker (as will be indicated on the Scan Marker screen in ML Spectator). On the Magic Leap 2 device you will be prompted to scan the marker. Focus the scanning reticle on the marker till it is registered by the app.
Once this step has been completed, the two devices will be synchronized and the connection process is completed. The ML2 device user will receive a notification saying ML Spectator is Active. ML Spectator will now begin streaming AR content from the ML2.
The Camera View
Once a successful connection is established, the Camera View will be displayed in the ML Spectator app. From this view, you’ll be able to see the streamed AR content from the Magic Leap 2 device, as well as access all controls for navigating, recording and adjusting image settings.
Controls
- Disconnect - Ends the current device connection.
- Scan Marker - Re-initiates the Scan Marker flow.
- Recording Format - Opens the video format selection screen.
- Auto Focus - Toggles auto focus on or off.
- Tracking Lock - Toggles AR content tracking on or off.
- Image Settings - Brings up the image adjustment UI (see: Image Settings).
- Settings - Opens the App Settings overlay (see: App Settings).
- Capture - Captures a photo or starts recording a video.
- Capture Mode - Toggles between capturing a photo or taking a video.
App Settings
Selecting the Settings button will bring up the App Settings menu where you can access::
- General Settings - Contains a variety of app settings relating to the overall functionality of ML Spectator.
- Audio Settings - Contains audio-specific app settings, and allows you to select different device input sources to record audio.
- About ML Spectator - Displays information about the current app version and links to legal, terms & conditions, and third-party licenses documentation.
- How to Connect - Provides a step-by-step guide on how to connect ML Spectator to get up and running.
- Online User Guide - Provides a link to the ML Spectator Basic User Guide.
Help
The Help section of the app provides useful at-a-glance guidance on how to set up an ML Spectator connection, permissions information and the About / Legal information.
The Help section can be accessed in various places throughout the app, either by selecting the ? icon or going to Settings via the Camera View screen.
Troubleshooting and Connection Issues
If you’re having trouble connecting ML Spectator to your Magic Leap 2 device, try these troubleshooting solutions. If you’re still having trouble, reach out to us at care@magicleap.com for further assistance.
1. Ensure that your devices are on the same network
Both devices need to be connected to the same Wi-Fi network. A 5Ghz network is recommended to provide optimal performance. Check what network your devices are using by navigating to your mobile device’s Wi-Fi settings and the Magic Leap 2’s main settings page.
2. Private and Company Network issues
Private, enterprise, and company networks may have firewalls set up to prevent peer to peer connections. It is not recommended to connect to these networks when setting up an ML Spectator session. In order to ensure that ML Spectator can form a connection between your mobile device and the ML2 headset, create a local network with a router or use a hotspot (minimum 25 Mbps recommended). The ML2 headset is able to act as a Wi-Fi hotspot to allow ML Spectator to make the required connections. For more information see: Using the ML Headset as a Hotspot.
3. Ensure you have entered the correct IP address
The IP address for your Magic Leap 2 can be found by going to Settings > About > IP Address. This is the address you will need to enter into the IP address field in the ML Spectator app if you are trying to connect manually. Your IP address will change if you change the network your Magic Leap 2 is connected to and thus you would need to enter a new IP address.
4. Ensure you are using an ML Spectator compatible Magic Leap 2 application
ML Spectator will only be able to connect to applications on the Magic Leap 2 that are compatible. To be compatible, a special ML Spectator app package must be installed to the application’s Unity project. For more information on creating ML Spectator-compatible apps, see: How To Install The Magic Leap Spectator Unity Package.
5. Keep your Magic Leap 2 application running
In order for ML Spectator to find and connect to your Magic Leap 2 headset, the ML Spectator-compatible app on your headset needs to be open and running in the foreground at all times. Once a connection has been established the application can be navigated away from without dropping the connection. However, the AR content will freeze in place until the application is brought into focus again.
6. Confirm if ML Spectator connectivity is enabled in your ML2 application
Some applications (Like Assist and Workshop) may include settings that need to be enabled in order to allow ML Spectator to search for and connect to that device or application. Please check your Magic Leap 2 application’s settings to see if there is anything additional you need to enable.
7. Connection to device was lost while the application was paused
When ML Spectator is sent to the background on the headset, the content streamed to the mobile device will be paused and a notification will be shown. If the connection to the headset is lost while the application is paused then the exact reason for the connection loss cannot be sent to the mobile device. Connection loss can occur due to a number of issues including:
- ML Spectator was closed
- ML Spectator crashed
- Wi-Fi was disabled or lost connection
- A network error occurred
Speak with the headset user to determine the exact cause of the connection loss. Once the issue has been resolved close ML Spectator on both the headset and mobile device, relaunch the application, and reconnect to the headset.
T’s & C’s
-
- Open source software notices: https://www.magicleap.com/ml2-open-source-software-notices
- Software license agreement: https://www.magicleap.com/software-license-agreement-ml2
- Privacy policy: https://www.magicleap.com/privacy-policy