ARMOD SDK Documents
Search…
iOS ARMOD API

InitARMOD

Initialize ARMOD SDK with configuration information. This method will call InitARMODModule automatically.
Name
Type
Description
appconfigure
NSString
This is a json string. Use to init our sdk and authentication
1
- (void)initARMOD:(NSString*) appconfigure
Copied!

ShowARMODWindow

Show the ARMOD View window after InitARMODModle
1
- (void)showARMODWindow
Copied!

UnloadARMODWindow

Unload current ARMOD Window
1
- (void)unloadARMODWindow
Copied!

CleanCache

Clean ARExperiences cache in the device
1
- (void)cleanCache
Copied!

RegisterAPIforNativeCalls

Used to connect the callback communication between SDK.Register a custom-implemented monitoring protocol. Used to monitor and execute messages sent by the SDK, for example:
  1. 1.
    When starting to load AR creative interactive experience content, `addLoadingOverlay` will be executed;
  2. 2.
    After loading, it will execute `removeLoadingOverlay`;
  3. 3.
    Execute `updateLoadingProgress` while loading;
  4. 4.
    Execute `notSupportARMOD` when the device does not support AR;
  5. 5.
    SDK error, will execute showAlertConfirmation when the project is inquired
Call it at any time after ARMOD is loaded to set the object that implements the NativeCallsProtocol method.
Name
Type
Description
api
NativeCallsProtocol
Custom monitoring protocol object
1
- (void) registerAPIforNativeCalls:(id<NativeCallsProtocol>) api
Copied!

ConnectArgcArgv

Inherit the Argc and Argv of the current APP
Name
Description
gArgc
argument count.It signifies how many arguments are being passed into the executable.
gArgv
argument values.It is a pointer to an array of characters.
1
- (void) connectArgcArgv:(int)gArgc setgArgv:(char **) gArgv
Copied!

ConnectARMOD

Inherit the Window of the current APP
1
- (void) connectARMOD:(UIWindow*) nativeWindow
Copied!

ConnectLaunchOpts

Inherit the LaunchOpts of the current APP
1
- (void) connectLaunchOpts:(NSDictionary*) applaunchOpts
Copied!

FetchProject

Query the ARExperience projecct by project uid.
Name
Type
Description
projectUid
NSString
The project uid is the unique id of each ARExperience.
Can be used for retrieval, etc.
1
- (void)fetchProject:(NSString*) projecetUid
Copied!

FetchProjectByImage(unavailable)

Query the ARExperience projecct by image recognized
1
- (void)fetchProjectByImage
Copied!

GetARMODController

Get current ARMOD Window root controller
Return: ARMOD UIViewController
1
- (UIViewController*)getARMODController
Copied!

LoadAndShowARMODView

Load and display ARMOD view immediately
1
- (void)loadAndShowARMODView
Copied!

SetUIInterfaceOrientation

Set the ar view to follow the orientation of the app itself
Name
Type
Description
orientation
UIInterfaceOrientation
Current app's orientation
1
- (void)setUIInterfaceOrientation:(UIInterfaceOrientation)orientation
Copied!
Last modified 6mo ago