Wikitude.Plugin Class Reference

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...

Inherits MonoBehaviour.

Public Member Functions
long	GetProcessedFrameId ()
	Use this method to retrieve the last processed input frame index. Using this will allow you to synchronize the camera with the tracking data. A value of -1 indicates that the most current frame should be rendered. More...
void	NotifyNewCameraFrame (CameraFrame cameraFrame)
	Should be called when the plugin has an input module, and a new camera frame should be sent to the SDK for processing. More...

Public Attributes
OnPluginErrorEvent	OnPluginError = new OnPluginErrorEvent()
	Called whenever the plugin encounters an error. More...
OnCameraFrameAvailableEvent	OnCameraFrameAvailable = new OnCameraFrameAvailableEvent()
	Called whenever a new camera frame is available from the SDK. This could be called from another thread. More...
OnCameraReleasedEvent	OnCameraReleased = new OnCameraReleasedEvent()
	Called when the SDK releases the camera and it's save for the plugin to open it, if required. More...
OnCameraReleaseFailedEvent	OnCameraReleaseFailed = new OnCameraReleaseFailedEvent()
	Called when the SDK failed to release the camera, after a plugin with an input module was registered. More...

Properties
string	Identifier [get, set]
	An identifier that should be unique. More...
bool	HasInputModule [get, set]
	Specifies if the plugin has an input plugin. More...
float	CameraToSurfaceAngle [set]
	Specifies the angle between the camera and the rendering surface. When using a Unity WebCamTexture, this is equivalent to videoRotationAngle. More...
bool	RequestsCameraFrameRendering [get, set]
	Specifies wether the SDK should render the camera frames or not. Should be used when an input module is used and camera frames should be rendering directly in Unity. More...
bool	InvertFrame [get, set]
	Used only when the property HasInputPlugin is true. If set to true, the CameraFrame data passed to NotifyNewCameraFrameAvailable will be inverted vertically in native code.false This is useful when sending data from directly from a Unity texture. Only works for RGBA color frames. More...

Detailed Description

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.

Member Function Documentation

long Wikitude.Plugin.GetProcessedFrameId ( )

inline

Use this method to retrieve the last processed input frame index. Using this will allow you to synchronize the camera with the tracking data. A value of -1 indicates that the most current frame should be rendered.

void Wikitude.Plugin.NotifyNewCameraFrame ( CameraFrame  cameraFrame )

inline

Should be called when the plugin has an input module, and a new camera frame should be sent to the SDK for processing.

Parameters

cameraFrame

The camera frame that should be sent to the SDK.

Member Data Documentation

OnCameraFrameAvailableEvent Wikitude.Plugin.OnCameraFrameAvailable = new OnCameraFrameAvailableEvent()

Called whenever a new camera frame is available from the SDK. This could be called from another thread.

OnCameraReleasedEvent Wikitude.Plugin.OnCameraReleased = new OnCameraReleasedEvent()

Called when the SDK releases the camera and it's save for the plugin to open it, if required.

OnCameraReleaseFailedEvent Wikitude.Plugin.OnCameraReleaseFailed = new OnCameraReleaseFailedEvent()

Called when the SDK failed to release the camera, after a plugin with an input module was registered.

OnPluginErrorEvent Wikitude.Plugin.OnPluginError = new OnPluginErrorEvent()

Called whenever the plugin encounters an error.

Property Documentation

float Wikitude.Plugin.CameraToSurfaceAngle

set

Specifies the angle between the camera and the rendering surface. When using a Unity WebCamTexture, this is equivalent to videoRotationAngle.

bool Wikitude.Plugin.HasInputModule

getset

Specifies if the plugin has an input plugin.

string Wikitude.Plugin.Identifier

getset

An identifier that should be unique.

bool Wikitude.Plugin.InvertFrame

getset

Used only when the property HasInputPlugin is true. If set to true, the CameraFrame data passed to NotifyNewCameraFrameAvailable will be inverted vertically in native code.false This is useful when sending data from directly from a Unity texture. Only works for RGBA color frames.

Returns

bool Wikitude.Plugin.RequestsCameraFrameRendering

getset

Specifies wether the SDK should render the camera frames or not. Should be used when an input module is used and camera frames should be rendering directly in Unity.