Wikitude Namespace Reference

Namespaces

Classes
class	CameraFrame
	A class that contains color frames, along with their metadata. More...
struct	CameraFramePlane
	A single plane of image data. More...
class	CameraFrameRenderer
	The CameraFrameRenderer is responsible for rendering the camera frame to the screen. If this is not desired, the script can simply be removed from the scene. More...
class	CloudRecognitionService
	CloudRecognitionService is used to send image(s) taken by the camera to the Cloud Recognition Service. The server will then do the hard work of trying to match the image with your targets in the specified cloud archive. More...
class	CloudRecognitionServiceResponse
	The response received from the CloudRecognitionService after initiating a recognition request. More...
struct	ColorCameraFrameMetadata
	A struct that encapsulates additional information about color camera frames. More...
class	DeviceCamera
	Controls the configuration and access to the physical camera on the device. If an input plugin is used instead, this script should be removed from the scene. More...
class	Error
	Error class that encapsulates additional information. Used thought the SDK when something goes wrong. More...
class	ImageTarget
	An image target contains information about a tracked target. More...
class	ImageTrackable
	Image Trackables are used by Image Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status. More...
class	ImageTracker
	Image Trackers are used to recognize image targets bundled in .wtc files by using a TargetCollectionResource or from the cloud by using a CloudRecognitionService. More...
struct	IntrinsicsCalibration
	Describes the physical properties of the camera. More...
class	LivePreview
	The LivePreview components allows the Wikitude SDK to connect to various sources of image data inside the Unity Editor and enables all tracking features to be tested in Play Mode. More...
class	ObjectTarget
	An object target contains information about a tracked target. More...
class	ObjectTrackable
	Object Trackables are used by Object Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status. More...
class	ObjectTracker
	Object Trackers are used to recognize and track objects defined in .wto files by using a TargetCollectionResource More...
class	PlatformBase
	Base class used for platform dependent compilation. For internal use only. More...
class	Plugin
	Plugins can be used to get the camera frames from the SDK for additional processing. If the plugin has an input module, it can be used to feed camera frames to the SDK from other sources. More...
class	RecognizedTarget
	Base class for target classes. Intended for internal use only and should not be derived from. More...
class	SceneRenderer
	This component is responsible for rendering the 3D scene in coordination with the camera frame renderer. If custom cameras are set up, this component should be added to them and the fields should mimic the values of the AR Camera's SceneRenderer component. More...
class	SDKBuildInformation
	Encapsulates build information for the SDK. More...
class	SDKLicenseKey
	Defines the License Key that should be used with the Wikitude SDK. More...
class	TargetCollectionResource
	Represents a resource that was initialized with a .wtc (Wikitude Target Collection) or .wto (Wikitude Object Collection) file. The file can be loaded either from the device, if it was stored in the StreamingAssets folder, or from a remote server. If the file was loaded from a server, no internet connection is required anymore after loading finished successfully. More...
class	TargetSource
	Base class for TargetCollectionResource and CloudRecognitionService. Intended for internal use only and should not be derived from. More...
class	Trackable
	Base class for trackable classes. Intended for internal use only and should not be derived from. More...
class	Tracker
	Base class for tracker classes. Intended for internal use only and should not be derived from. More...
class	WikitudeSDK
	The WikitudeSDK object handles the connection with the native plugins. More...

Enumerations

Detailed Description

ParserToken.cs Internal representation of the tokens used by the lexer and the parser.

The authors disclaim copyright to this source code. For more details, see the COPYING file included with this distribution.

Enumeration Type Documentation

enum Wikitude.ArBridgeAvailability

strong

Enumerator
IndeterminateQueryFailed	The query failed unexpectedly. Please try again later.
CheckingQueryOngoing	The internal query is currently ongoing and the result is not yet available.
Unsupported	Platform assisted instant tracking not supported.
SupportedUpdateRequired	Platform assisted instant tracking is supported but ARCore needs to be updated.
Supported	Platform assisted instant tracking is supported.

enum Wikitude.ArBridgeProvider

strong

Enum describing if ARBridge is enabled and how it is implemented.

Enumerator
Disabled	ArBridge is disabled so the camera will not move in the scene.
Internal	ArBridge uses an internal implementation to connect to platform tracking providers and positions the camera in the scene accordingly.
Plugin	ArBridge uses an external implementation. An AR Foundation integration is provided as an example.

enum Wikitude.Camera2SupportLevel

strong

Enum indicating the support level for Camera2 API, as described by CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL

Enumerator
Limited	Equivalent to CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED.
Full	Equivalent to CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_FULL.
Legacy	Equivalent to CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY.
Level_3	Equivalent to CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_3.

enum Wikitude.CaptureAutoFocusRestriction

strong

Enum indicating the restriction of the device's autofocus to a particular range of focus scan.

Currently only supported on iOS devices.

Enumerator
None	Indicates that the autofocus system should not restrict the focus range.
Near	Indicates that the autofocus system should restrict the focus range for subject matter that is near to the camera.
Far	Indicates that the autofocus system should restrict the focus range for subject matter that is far to the camera.

enum Wikitude.CaptureDeviceFramerate

strong

Enum indicating the desired framerate for the camera. The device camera might not support the selected framerate, so the closest supported framerate will be used.

Enumerator
Auto	Indicates that the SDK should pick the most appropriate framerate for the device.
Framerate_30	Indicates a desired framerate of 30 frames per second.
Framerate_60	Indicates a desired framerate of 60 frames per second.

enum Wikitude.CaptureDevicePosition

strong

Enum indicating the physical position of the capture device on the system.

Enumerator
Back	Indicates that the capture device is physically located on the back.
Front	Indicates that the capture device is physically located on the front.

enum Wikitude.CaptureDeviceResolution

strong

Enum indicating the desired resolution for the camera. The device camera might not support the selected resolution, so the closest supported resolution will be used.

Enumerator
Auto	Indicates that the SDK should pick the most appropriate resolution for the device.
SD	Indicates a desired resolution of 640 x 480.
HD	Indicates a desired resolution of 1280 x 720.
FullHD	Indicates a desired resolution of 1920 x 1080.

enum Wikitude.CaptureExposureMode

strong

Enum indicating how the exposure is working.

Enumerator
Locked	The device will keep the same exposure.
AutoExpose	The device will automatically adjust the exposure once.
ContinuousAutoExpose	The device will continuously monitor exposure levels and will adjust the exposure when required.

enum Wikitude.CaptureFlashMode

strong

Enum indicating the mode of the flash / torch on the device

Enumerator
Off	Indicates that the flash should always be off.
On	Indicates that the flash should always be on.

enum Wikitude.CaptureFocusMode

strong

Enum indicating the mode of the focus on the device.

Enumerator
Locked	Indicates that the focus should be locked at the lens' current position.
AutoFocus	Indicates that the device should autofocus once and then change the focus mode to Locked.
ContinuousAutoFocus	Indicates that the device should automatically focus when needed.

enum Wikitude.CloudRecognitionServerRegion

strong

CloudRecognitionServerRegion defines the possible cloud recognition server regions that are available. The region should be set depending on where the final application will be used most likely. If the region doesn't match the actual user location, longer round trip times should be expected

Enumerator
Europe	Europe should be used when the user is currently in Europe, Africa or Middle East.
Americas	Americas should be used when the user is currently in North or South America.
Custom	Custom should be used when a custom URL is defined in the CustomServerURL property of the CloudRecognitionService.

enum Wikitude.FrameColorSpace

strong

Color space of the frames used for Plugins and Input Plugins.

Enumerator
YUV_420_NV21	Represents a color space where image data is given in a YUV 420 format, arranged to be compliant to the NV21 standard. The data size is frame width * frame height * 3/2, meaning full luminance resolution and half the size for chroma red * chroma blue On iOS this is represented by the kCVPixelFormatType_420YpCbCr8BiPlanarFullRange constant On Android this is represented by the ImageFormat.NV21 constant.
YUV_420_YV12	Represents a color space where image data is given in a YUV 420 format, arranged to be compliant to the YV12 standard. The data size is frame width * frame height * 3/2, meaning full luminance resolution and half the size for chroma red * chroma blue On Android this is represented by the ImageFormat.YUV_420_888 and ImageFormat.YV12 constants.
YUV_420_888	Represents a color space where image data is given in a YUV 420 format, arranged in three planes. The data data may contain a row stride for the luminance plane and pixel and row strides for the chroma planes. The size of usable data is frame width * frame height * 3/2, meaning full luminance resolution and half the size for chroma red * chroma blue. On Android this is represented by the ImageFormat.YUV_420_888 constant.
YUV_420_NV12	Represents a color space where image data is given in a YUV 420 format, arranged to be compliant to the NV12 standard. The data size is frame width * frame height * 3/2, meaning full luminance resolution and half the size for chroma red * chroma blue Chroma planes are interleaved. On Windows, this is represented by the BitmapPixelFormat::Nv12 constant.
RGB	Represents a color space where image data is given in a RGB format. The data size is frame width * frame height * 3 (R, G and B channel). On iOS this is represented by the kCVPixelFormatType_24RGB constant On Android this is represented by the ImageFormat.FLEX_RGB_888 constant
RGBA	Represents a color space where image data is given in a RGBA format. The data size is frame width * frame height * 4 (R, G, B and A channel). This is only used for Input Plugins and is provided for convenience since this is the way Unity returns the pixels from a texture.
UNKNOWN	Represents a color space unknown by the SDK.

enum Wikitude.ImageRecognitionRangeExtension

strong

Defines if the ImageTracker should use an optimized algorithm to detect target images at greater distances. Extending the recognition range requires HD camera frames processing and therefore needs more CPU power than the default recognition range.

Enumerator
On	Image recognition range extension will be used regardless of the current device performance.
Off	Image recognition range extension will not be used even though the current device might support it.
Auto	Image recognition range extension will be used depending on the current device performance. 32 bit devices would turn this setting off while 64 bit devices would turn it on.

enum Wikitude.ImageTargetType

strong

Enum indicating if the image target is a plane or a cylinder.

Enumerator
Image	Indicates that the image target is a planar image.
Cylinder	Indicates that the image target is a cylinder.

enum Wikitude.LivePreviewMode

strong

Specifies which Live Preview Mode should be used. Only used in the Editor.

Enumerator
StaticImage	A static image should be used. The image should have Read / Write enabled.
WebCam	The device webcam should be used.
RemoteCamera	The camera on a connected mobile device should be used. The Unity Remote app should be installed and running.
VideoClip	A video should be used.
InputPlugin	If an input plugin is defined, this option should be chosen in order to send its data to the SDK in the editor.

enum Wikitude.LoggingLevel

strong

Enum describing the logging level.

Enumerator
Debug	Logging level is debug and will show all type of logs.
Info	Logging level is info and will show error, warning and info logs.
Warning	Logging level is warning and will show error and warning logs.
Error	Logging level is error and will only show error logs.

enum Wikitude.ObjectTrackerRecognitionType

strong

Enum indicating the object trackers recognition type

Enumerator
Alignment	Indicates that the object tracker uses alignment initialization as recognition type.
Recognition	Indicates that the object tracker uses the standard recognition as recognition type.

enum Wikitude.ScalingMode

strong

Defines how targets should be scaled.

Enumerator
Absolute	In this mode, the physical target height of the image is used to properly position and scale the target in the scene. The augmentations should be authored at their real-world scale.
Relative	In this mode, the physical target height is not considered. The height of the target is considered to be 1, regardless of the actual physical size. Augmentations should be authored taking this into account.

enum Wikitude.TargetSourceType

strong

Specifies the kind of TargetSource. Used for custom inspectors.

Enumerator
TargetCollectionResource	Specifies a TargetCollectionResource TargetSource.
CloudRecognitionService	Specifies a CloudRecognitionService TargetSource.

enum Wikitude.TrackerEfficiencyMode

strong

Defines the efficiency mode for a tracker.

Enumerator
HighAccuracy	The best result is calculated in the shortest amount of time for every frame which results in higher CPU usage.
EnergyEfficiency	Less energy is needed because the calculations are not as accurate as with HighAccuracy and not every frame is considered.

enum Wikitude.UpdateMode

strong

Enum describing the SDK update mode.

Enumerator
Automatic	SDK will be automatically updated every frame.
Explicit	SDK will only be updated by explicitly calling the WikitudeSDK.ExplicitUpdate() method.