Discussion

The Context DB is loaded asynchronously at startup and therefore might not be available immediatly. This can known when a given function (add or remove) returns an error or by checking the appropriate property. In order to execute those operation when the DB is loaded, the operations can be added to the queue represented by this property.

Once the DB is loaded, this property is not longer valid (set to nil).

Discussion

The id of all available contexts.

An available context is defined as a context that is triggered by some sensors (i.e. a beacon) but that its content is not (yet) displayed on screen and require user approval to display it on screen.

Discussion

The list of context IDs that have been bookmarked so far.

Discussion

Defines the language that must be used for the online recognition. If it is not set, the device language must be used.

Discussion

The id of all contexts

Discussion

Defines whether or not the local Context DB is loaded or not. Any call related to the DB will fail if this property is not set to YES.

Discussion

Context detection delegates.

Discussion

The user device UUID

Discussion

Display the debug overlay to locate the context properly even if the context has no annotation.

Discussion

Defines whether the application should display a button for adding a bookmark when some content is displayed (content with web view {@link VDARModalWebView}).

For content within the AR view, it is up to the application developper to implement it.

Discussion

When set to YES, code recognition is also performed while trying to recognize a VDARContext.

Code recognition allows you to recognize different type of codes (1-D codes such as a barcodes or 2D codes such as QR Codes). Those codes can contains any information they can support. When a code is detected, the codesDetected: method of all the VDARSDKController delegates is called with the detected codes represented as VDARCode objects. You can then use the returned objects to read the codes data and act upon it.

You can use the QR Code generator available in Vidinoti AR Manager under My Contents –> Code Generator to generate your own QR Codes.

Several different special QR Codes are understood by the system. Those special QR codes actually contain a special URL. To be understood correctly, this special URL has to be of the following format:

vdarsdk://<command>/<parameter 1>/.../<parameter n>

The following commands are supported:

1. Context Download QR Code (command = mdl)

This special QR Code can trigger the download (a.k.a pre-fetch) of a VDARContext so that the VDARContext can be recognized afterhand. Those special QR codes should contains an URL of the following format:

vdarsdk://mdl/<your Context Remote ID>

For example, if you have a Context with the remote ID fsgdg4t3few, then you can create a QR code with this URL vdarsdk://mdl/fsgdg4t3few to autmatically trigger the download of the corresponding context.

1. Tag synchrnoization request (command = tsc)

This special QR Code can trigger the synchronization request (a.k.a pre-fetch) of several VDARContext corresponding to a given or multiple tags. Those special QR codes should contains an URL of the following format:

vdarsdk://tsc/<tag 1>/<tag 2>/.../<tag n>

For example, if you want to synchronize the local AR DB with all the contexts having the tags hello and bye, then you can create a QR code with this URL vdarsdk://tsc/hello/bye to autmatically trigger the download of the corresponding contexts.

Note that the code recognition is automatically disabled when a VDARContext has been recognized and when it is tracked

You can customize which codes can be recognized with the recognizableCodes property.

Discussion

When a content needing the AR view to be opened is triggered, usually due to a beacon event, the app needs to open the AR view. By default, the SDK takes care of that. It opens the AR view if not already opened, or display the content directly if the AR view is open.

You can prevent this functionnality by setting the flag to NO and implementing your own logic by listening to the VDARNotificationARViewRequested notification. An AR should be open as soon as the notification VDARNotificationARViewRequested is triggered.

By default, it is set to YES.

Discussion

When a notification arrives in a state where the application is open, the SDK will handle it and display an alert with the notification. You can disable this behaviour by setting this flag to NO. By default, it is set to YES.

Discussion

Enable push notifications support in the SDK.

If set to YES, the application delegate has to forward the correct calls to VDARSDKController. This can be done this way in your AppDelegate:

- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)devToken {
    [[VDARSDKController sharedInstance] application:app didRegisterForRemoteNotificationsWithDeviceToken:devToken];
}

- (void)application:(UIApplication *)app didFailToRegisterForRemoteNotificationsWithError:(NSError *)err {
    [[VDARSDKController sharedInstance] application:app didFailToRegisterForRemoteNotificationsWithError:err];
}

- (void)application:(UIApplication *)app didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))handler {
    [[VDARSDKController sharedInstance] application:app didReceiveRemoteNotification:userInfo];
    handler(UIBackgroundFetchResultNoData);
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // ...Your initialization code...
    // Enables the push notifications
    [VDARSDKController sharedInstance].enableNotifications=YES;
    // Forward the push notification if the application was not running when the notification has been received
    [[VDARSDKController sharedInstance] application:application didReceiveRemoteNotification:launchOptions];
    return YES;
}

By default, the value is NO.

Discussion

When a beacon notification arrives in a state where the application is open, the SDK will handle the notification and display it in a popup window. When the notification list is presented by default the SDK will show the nearby Beacons/GPS To show the list of the pending notification instead set this flag to YES. By default, it is set to NO.

Discussion

The image sender which will send frame to the system. This is needed starting from version 2.0.11b

Discussion

Set the class to be instancied when the internal browser should be opened.

This is set by default to nil, which corresponds to the default internal browser provided by the SDK.

Discussion

The Context DB directory where all the data is stored.

Discussion

The list of all notifications that are pending.

Discussion

Prevent spurious notifications to be displayed.

When set to YES, the notification list will never appear. Instead, the notification will be buffered and will be displayed as soon as the flag goes back to NO.

Discussion

Select which types of codes should be recognized by the system.

This variable should be an OR'ed mask of the constant defined in VDARCodeType. The mask can be built with the following values:

• VDAR_CODE_TYPE_EAN2 = GS1 2-digit add-on
• VDAR_CODE_TYPE_EAN5 = GS1 5-digit add-on
• VDAR_CODE_TYPE_EAN8 = EAN-8
• VDAR_CODE_TYPE_UPCE = UPC-E
• VDAR_CODE_TYPE_ISBN10 = ISBN-10 (from EAN-13).
• VDAR_CODE_TYPE_UPCA = UPC-A
• VDAR_CODE_TYPE_EAN13 = EAN-13
• VDAR_CODE_TYPE_ISBN13 = ISBN-13 (from EAN-13).
• VDAR_CODE_TYPE_COMPOSITE = EAN/UPC composite
• VDAR_CODE_TYPE_I25 = Interleaved 2 of 5.
• VDAR_CODE_TYPE_CODE39 = Code 39.
• VDAR_CODE_TYPE_QRCODE = QR Code.

By default, the enabled codes when enableCodesRecognition is set to YES are QR Codes.

Discussion

The Remote API key generated by the AR Manager website.

Discussion

Sensor detection delegates.

Discussion

Return a string describing the VDARSDK version.

Discussion

Return YES if the current device can run the Vidinoti AR SDK.

You should call this method before attempting to start the VDARSDKController, otherwise it might result in crashes.

Discussion

Return the device type on which the SDK is running.

Discussion

Return the shared instance of the VDARSDKController.

Discussion

Start the shared instance of the VDARSDKController. Calling it twice will return nil.

Discussion

Add a bookmark for the specified context

Discussion

Tell the PixLive SDK that the remote notification request has failed. The app delegate has to call this method when such an event is received.

Discussion

Tell the PixLive SDK that a remote notification has been received. The app delegate has to call this method when such an event is received.

Discussion

Tell the PixLive SDK that the remote notification request has succeeded. The app delegate has to call this method when such an event is received.

Discussion

The distance bewteen to GPS points in meter

Discussion

Disables the context. The context remains local but won’t be detected (its sensors are unregistered)

Discussion

Disables all the contexts. The context remains on the device but their sensors are unregistered.

Discussion

Enables the context after being disabled (see disableContext).

Discussion

Enables all contexts belonging to specific tags. Ensure that the mapping Context <–> Tag exists otherwise no context will be enabled. The mapping Context-Tag must be retrieved using the VDARRemoteController

Discussion

Sets the language of the SDK interface. By default, the SDK uses the phone language. If this method is called, it uses the given language instead. Call this method with null, for cancelling the forced language.

Discussion

Get the context of a given id

Discussion

The list of GPS points in BoundingBox

Discussion

Return the list of context IDs of nearby beacons.

Discussion

The list of nearby GPS points

Discussion

Return localization authorization status and bluetooth status

Discussion

Return YES if the context identified by contextId is already bookmarked, NO otherwise

Discussion

Return YES if the app contain beacons, NO otherwise

Discussion

Return YES if the app contain GPS points, NO otherwise

Discussion

Load the context of a given id

Discussion

Open the given URL in the internal browser embedded in the SDK (instead of opening up the device browser and switiching applications).

Discussion

Present the last notification to the user

Discussion

Present the in-SDK notification list to the user with nearby GPS points

Discussion

Present the in-SDK notification list to the user with nearby GPS points

Discussion

Present the in-SDK notification list to the user

Discussion

The preview of the passed context is shown. The context image has to be loaded from the network, therefore the completion block can be used in order to know when the fetch is completed and the preview is started.

Pass nil for the context argument to stop the preview.

Discussion

Present the in-SDK notification list to the user with nearby GPS points

Discussion

Release the memory used by not-detected-but-loaded contexts. Level is for future use.

Discussion

Remove the bookmark for the specified context

Discussion

Unloads and removes the context.

Discussion

Save the contexts and DB to disk.

This method generate a VDARNotificationContextListChanged notification if changes have been made to the DB and saved to disk.

Discussion

Set the current device orientation. This is necessery to be able to recognize images when the device is not in portrait mode.

Discussion

Enables/disables the nearby requirement dialog asking for bluetooth/localisation requirement If enabled, a dialog will ask the user to enabled the required settings for bluetooth and localisation when the SDK start to scan for beacons. By default, this is enabled.

Discussion

enable pending notifications

Discussion

Allows changing the license key when the SDK is already running. The new license key will be validated against the server.

Discussion

Disables or enables a vision context. If the vision context is ignored, it won’t be recognized, even if it is present locally on the device. By default, all vision contexts are enabled (i.e. not ignored)

Discussion

This method will force the system to stop and hide anything displayed in the AR view such as context, content or annotations.

Discussion

Unload all the contexts in memory