Packagecom.myflashlab.air.extensions.ar
Classpublic class Config
InheritanceConfig Inheritance Object

This class holds all the initial configuration which the AR window must be built based on. Some of these properties are the same between Android and iOS but some are not. to set platform specific properties, use _arSettings.ios... or _arSettings.android... where _arSettings is an instance of the Config class: var _arSettings:Config = new Config();


Public Properties
 PropertyDefined By
  android : ConfigAndroid
[read-only] Gives you access to the Android specific settings.
Config
  btnExitStr : String
[read-only] This property is not recommended on production builds.
Config
  camFocusMode : int
Indicates which camera focus mode should be used by the Wikitude SDK for the camera startup.
Config
  camPosition : int
Indicates which camera position should be used by the Wikitude SDK for the camera startup.
Config
  camResolution : int
Indicates which resolution the camera should use.
Config
  hasGeo : Boolean
Indicates if you are going to use geo in your AR experience.
Config
  hasInstant : Boolean
Indicates if you are going to use SLAM in your AR experience.
Config
  hasIR : Boolean
Indicates if you are going to use image recognition in your AR experience.
Config
  hasObject : Boolean
Indicates if you are going to use 3D objects in your AR experience.
Config
  ios : ConfigIos
[read-only] Gives you access to the iOS specific settings.
Config
  liceseKey : String
Indicates your Wikitude SDK licence key.
Config
Public Methods
 MethodDefined By
  
Config()
initialize this class and set the AR settings before launching the AR experience.
Config
Property Detail
androidproperty
android:ConfigAndroid  [read-only]

Gives you access to the Android specific settings.


Implementation
    public function get android():ConfigAndroid
btnExitStrproperty 
btnExitStr:String  [read-only]

This property is not recommended on production builds. You must create your own exit buttons on js/html. You may look at the demo here: https://github.com/myflashlab/AR-ANE-Samples/tree/master/AIR/assets/01_ImageTracking_1_ImageOnTarget to learn how you can create an exit button in html/js.


Implementation
    public function get btnExitStr():String
camFocusModeproperty 
camFocusMode:int

Indicates which camera focus mode should be used by the Wikitude SDK for the camera startup.


Implementation
    public function get camFocusMode():int
    public function set camFocusMode(value:int):void
camPositionproperty 
camPosition:int

Indicates which camera position should be used by the Wikitude SDK for the camera startup.


Implementation
    public function get camPosition():int
    public function set camPosition(value:int):void
camResolutionproperty 
camResolution:int

Indicates which resolution the camera should use. The wikitude sdk will choose a resolution closest to the given size. It is not guaranteed that the chosen size is used since some devices may not support it.


Implementation
    public function get camResolution():int
    public function set camResolution(value:int):void
hasGeoproperty 
hasGeo:Boolean

Indicates if you are going to use geo in your AR experience.


Implementation
    public function get hasGeo():Boolean
    public function set hasGeo(value:Boolean):void
hasInstantproperty 
hasInstant:Boolean

Indicates if you are going to use SLAM in your AR experience.


Implementation
    public function get hasInstant():Boolean
    public function set hasInstant(value:Boolean):void
hasIRproperty 
hasIR:Boolean

Indicates if you are going to use image recognition in your AR experience.


Implementation
    public function get hasIR():Boolean
    public function set hasIR(value:Boolean):void
hasObjectproperty 
hasObject:Boolean

Indicates if you are going to use 3D objects in your AR experience.


Implementation
    public function get hasObject():Boolean
    public function set hasObject(value:Boolean):void
iosproperty 
ios:ConfigIos  [read-only]

Gives you access to the iOS specific settings.


Implementation
    public function get ios():ConfigIos
liceseKeyproperty 
liceseKey:String

Indicates your Wikitude SDK licence key.


Implementation
    public function get liceseKey():String
    public function set liceseKey(value:String):void
Constructor Detail
Config()Constructor
public function Config()

initialize this class and set the AR settings before launching the AR experience. Once you set the configurations, you should pass it to AR.config(_arSettings);.




myflashlabs.com - Best collection of ANEs

Thu May 21 2020, 09:16 AM +04:30