Namespace Microsoft.MixedReality.SpectatorView
Classes
AndroidRecordingService
Class implementing IRecording
ARCoreTrackingObserver
MonoBehaviour that reports tracking information for an ARCore device.
ARKitTrackingObserver
MonoBehaviour that reports tracking information for an ARKit device.
ArUcoMarkerDetector
Class implementing IMarker
ArUcoMarkerDetectorSpatialLocalizer
ArUcoMarkerVisual
Controls displaying an ArUco marker on a Unity RawImage
ArUcoMarkerVisualDetectorSpatialLocalizer
ArUcoMarkerVisualSpatialLocalizer
BroadcasterSettings
Settings used by a State
CalculatedCameraCalibration
A class containing camera intrinsic and extrinsic information produced through calibration.
CalculatedCameraExtrinsics
CalculatedCameraIntrinsics
CalibrationData
Used for loading/applying camera intrinsics and camera extrinsics obtained through Spectator View's default calibration process.
CalibrationDataProvider
Loads calibration data from the Pictures library on the device and transfers that data to the compositor upon connection.
CameraPoseProvider
Component that provides time-adjusted holographic poses to the compositor.
CommandRegistry<TService>
ComponentBroadcaster<TComponentBroadcasterService, TChangeFlags>
Abstract class for sending component updates from the user device.
ComponentBroadcasterDefinition
Component which defines when and how to attach a ComponentBroadcaster to a GameObject. ComponentBroadcasters can be created unconditionally or due to certain requirements being present on the provided GameObject.
ComponentBroadcasterDefinition<TComponentBroadcaster>
Attaches a ComponentBroadcaster of type TComponentBroadcaster to a GameObject if and only if a required set of Component types are present on the GameObject.
ComponentBroadcasterService<ServiceType, ObserverType>
Abstract class for services that manage IComponent
ComponentObserver
Abstract class for updating components on the spectator device.
ComponentObserver<TComponent>
Abstract class for updating components on the spectator device.
CompositionManager
Manages compositing real-world video and holograms together and creating an output video texture with recorded audio.
CompositorWorldAnchorLocalizationManager
Component responsible for requesting localization of shared coordinates on devices
connected to the compositor. Shared coordinates are persisted using
the World
DebugVisualHelper
Helper class for creating and placing multiple prefabs at different locations in the scene
DeviceInfoBroadcaster
DeviceInfoObserver
DeviceTrackingStateVisual
Dispatcher
A helper class to Dispatch actions to the GameThread
DispatcherUnity
A helper class to Dispatch actions to the GameThread
DynamicGameObjectHierarchyBroadcaster<TComponentService>
A ComponentBroadcaster that allows instantiating a custom child hierarchy for the remote DynamicGameObjectHierarchyObserver. The corresponding DynamicGameObjectHierarchyObserver is responsible for creating an initially-identical child hierarchy. Once both devices have created the same initial hierarchy, the hierarchies are bound together and state synchronization is initialized for all of the GameObjects within that hierarchy.
DynamicGameObjectHierarchyBroadcaster<TComponentService>.ChangeType
DynamicGameObjectHierarchyObserver<TComponentService>
A ComponentObserver that allows instantiating a custom child hierarchy for the remote DynamicGameObjectHierarchyBroadcaster. The corresponding DynamicGameObjectHierarchyBroadcaster is responsible for creating an initially-identical child hierarchy. Once both devices have created the same initial hierarchy, the hierarchies are bound together and state synchronization is initialized for all of the GameObjects within that hierarchy.
DynamicGameObjectHierarchyObserver<TComponentService>.TransformObserverInfo
EditorExtrinsicsCalibration
EditorIntrinsicsCalibration
FieldHelper
Helper class for validating that an object implements or extends a specific type.
GameObjectHierarchyBroadcaster
Indicates to the StateSynchronizationBroadcaster that the GameObject this is attached to and all of its descendants should be broadcast to connected StateSynchronizationObservers.
HeadsetCalibration
HeadsetCalibrationData
Data that the HoloLens device sends to the editor during calibration.
HeadsetCalibrationDataRequest
Data that the editor sends to a HoloLens device during calibration
HeadsetRequestHandler
HolographicCameraBroadcaster
Represents the network listener for the camera pose provider app.
HolographicCameraObserver
Component that connects to the HoloLens application on the holographic camera rig for synchronizing camera poses and receiving calibration data.
HoloLensCanvasHelper
Helper class for placing a Unity canvas relative to a HoloLens user
HoloLensTrackingObserver
MonoBehaviour that reports tracking information for a HoloLens device.
IncomingMessage
Helper class that wraps an incoming message
iOSRecordingService
Class implementing IRecording
Marker
Helper class containing data related to detected markers
MarkerDetectorCoordinateService
A marker detection based implementation of ISpatial
MarkerDetectorLocalizationSettings
MarkerDetectorSpatialLocalizer
SpatialLocalizer that is based on a marker detector.
MarkerVisualCanvasScaleFactorScraper
Helper class for obtaining additional scaling information to apply to ArUco Marker Images
MarkerVisualCoordinateService
A variant of marker based ISpatial
MarkerVisualDetectorLocalizationSettings
MarkerVisualDetectorSpatialLocalizer
MarkerVisualLocalizationInitializer
MarkerVisualLocalizationSettings
MarkerVisualSpatialLocalizer
SpatialLocalizer that shows a marker
MessageEvent
MicrophoneInput
Captures microphone input and plays that input back through an AudioSource.
MobileNetworkConfigurationVisual
MobileOverlayVisual
Helper class responsible for facilitating visibility changes in mobile UI
MobileOverlayVisualChild
Base class that provides showing/hiding functionality for IMobile
MobileRecordingSettings
MobileUIScaler
Helper class that scales mobile UI to show at same physical size across devices
NetworkConfigurationSettings
NetworkExtensions
Extension methods for writing structured CLR and Unity objects to BinaryWriter and reading those values from BinaryReader.
NetworkManager<TService>
PlatformSpecificGameObject
Helper class for enabling/disabling platform specific GameObjects
PlatformSwitcher
MonoBehaviour associated with PlatformSwitcherEditor
QRCodeMarkerDetector
QR code detector that implements IMarker
QRCodeMarkerDetectorSpatialLocalizer
QRCodeMarkerVisual
QRCodeMarkerVisualDetectorSpatialLocalizer
QRCodeMarkerVisualSpatialLocalizer
RecordingServiceVisual
RecordingTestCube
SimulatedSpatialCoordinate<TKey>
Helper class for creating artificial spatial coordinates in the editor.
Singleton<T>
MonoBehaviour base class used to ensure only one instance of the class exists in the application/scene.
SocketEndpoint
SocketEndpointConnectionDelta
Wrapper class for announcing the current state of network connections
Socketer
Sends and receives packets over the network, using the chosen protocol.
SocketerClient
Simple socket client which uses a generic length-type-data protocol. Chunk format(everything in little-endian order) : uint32_t data_length; uint8_t data[data_length]; NOTE! The code assumes you are running on a little-endian system.
SpatialAlignmentVisual
SpatialAnchorsConfiguration
Azure Spatial Anchors configuration.
SpatialAnchorsCoordinateLocalizationInitializer
SpatialAnchorsLocalizer
This is the localization mechanism for enabling anchor exchange/localization through Azure Spatial Anchors.
SpatialCoordinateSystemManager
SpatialCoordinateSystemParticipant
The SpectatorView helper class for managing a participant in the spatial coordinate system
SpatialCoordinateTransformer
Positions a transform representing a world origin such that a connected peer device's world origin (relative to a shared spatial coordinate) is used as the effective local world origin (as determined by the shared spatial coordinate).
SpatialLocalizationInitializationSettings
SpatialLocalizationInitializer
SpatialLocalizationSession
SpatialLocalizer<TSpatialLocalizationSettings>
Helper class to enable spatial localization between two entities on SpectatorView.
SpectatorView
Class that facilitates the Spectator View experience
SpectatorViewOpenCVInterface
Wrapper class for SpectatorView.OpenCV.dll built from the SpectatorView.Native.sln
SpectatorViewPoseCache
Caches poses with timestamps from a HoloLens and allows computing a synthesized pose from any timestamp.
SpectatorViewPoseCache.PoseData
SpectatorViewTimeSynchronizer
Synchronizes time adjustments between the compositor and the HoloLens.
StateSynchronizationBroadcaster
This class observes changes and updates content on a user device.
StateSynchronizationObserver
This class observes changes and updates content on a spectator device.
StateSynchronizationPerformanceMonitor
StateSynchronizationSceneManager
Service that registers ComponentBroadcasterDefinitions used to create ComponentBroadcasters for components and to manage both broadcasting and observing components.
TCPConnectionManager
Helper class for setting up a TCP based network connection
TCPConnectionManagerTest
Helper class for testing socketer TCPConnection
TextureManager
Manages the textures used for compositing holograms with video, and controls the actual composition of textures together.
TrackingObserver
TransformBroadcaster
A IComponent
TransformBroadcasterService
Service that manages Transform
TransformObserver
WorldAnchorCoordinateService
Represents an ISpatial
WorldAnchorSpatialLocalizationSettings
Settings for localizing using the World
WorldAnchorSpatialLocalizer
An ISpatial
Structs
AudioSourceProperties
HeadsetData
Struct that contains the world position and orientation of a HoloLens device.
MarkerCorners
Struct that contains world positions and orientations for marker corners.
MarkerPair
Struct that contains locations and orientations for QR Code and ArUco markers that have the same id.
ShortID
Short id used for state synchronization that can be created from a three letter string
StateSynchronizationPerformanceMonitor.ParsedMessage
Interfaces
IAssetCache
Used to persist asset information
ICalibrationData
Provides an abstraction over setting up a holographic camera from a stereo-calibrated camera rig.
ICommandRegistry
IComponentBroadcaster
Abstract class for sending component updates from the user device.
IComponentBroadcasterService
Manages component synchronization across different devices
IComponentObserver
Component that syncs local content based on changes to an IComponent
IEditableSpatialLocalizationSettings
IMarkerDetector
Interface that should be implemented by any class that detects markers
IMarkerVisual
Interface that should be implemented by any class that displays markers for detection
IMobileOverlayVisualChild
Interface implemented by classes that show/hide based on spectator view UI visibility changes
INetworkConfigurationVisual
INetworkManager
IPeerConnection
IRecordingService
An interface implemented by classes that perform screen recording
IRecordingServiceVisual
ISpatialLocalizationSession
ISpatialLocalizationSettings
ISpatialLocalizer
ITrackingObserver
Classes that implement this interface report whether the application's AR/VR Device is tracking its location in the physical world.
Enums
ComponentBroadcasterChangeType
Types of state changes that may occur for an IComponent
CompositionManager.AntiAliasingSamples
CompositionManager.Depth
FrameProviderDeviceType
MarkerPositionBehavior
Describes how a marker is expected to be moving while it's detected.
RecordingServiceVisual.RecordingState
Screen recording states
Role
SocketerClient.Protocol
Underlying protocol to use. Each has advantages and disadvantages.
SocketerClient.ProtocolDirection
TrackingState
Enumerates tracking states for AR/VR Devices.
TransformBroadcasterChangeType
Types of changes that occur for a Transform
VideoRecordingFrameLayout
WorldAnchorLocalizationMode
Specifies how to create a shared coordinate based on a WorldAnchor.
Delegates
CommandHandler
ConnectedEventHandler
DisconnectedEventHandler
HeadsetCalibrationDataUpdatedHandler
Called when HeadsetCalibration has a new qr code/aruco marker payload
MarkersUpdatedHandler
Delegate called when markers have been detected by an IMarker
OverlayVisibilityRequest
Delegate called to toggle visibility for IMobile