| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Stop wasting time looking for files and revisions. Connect your Gmail, DriveDropbox, and Slack accounts and in less than 2 minutes, Dokkio will automatically organize all your file attachments. Learn more and claim your free account.

View
 

Edit a layer

Page history last edited by xuan wang 8 years, 6 months ago

 

Please NOTE that this documentation will not be updated anymore. Please see our new Developer Documentation Site for the latest updates! The content of this page can be found here.

In the previous Create a layer section, we came across several mandatory fields that are needed in layer creation. In this section, we will have a look at the rest fields and how to customize a layer using these fields.

 

To edit a layer (we will take layer "firsttutorialxuan" with Layar Vision enabled as an example), click on "Edit" button for this layer to open the layer editing page (see screenshot 1 below).

 

screenshot 1 - layer editing page (General tab)

 

In total, there are 11 tabs:

 

  • General - The basic information about this layer, such as layer status.
  • API endpoint - Mainly the POI URL for developer's web service that provides hotspots response.
  • Listing & Indexing - Mainly Layer listing on the phone and indexing in Layar Stream.
  • Look & feel - Manage the appearance of the Camera view on the phone.
  • Coverage - Define layer country region and set up bounding box for local layers.
  • Filters - Set up filter settings for a layer.
  • Permissions - Assign different publisher and add viewers to a layer.
  • Reference images - Upload and manage reference images to Layar server. This tab is not visible, if "Layar Vision" is not enabled.
  • Vision Usage - For Vision enabled layers, you need to choose a Layar Vision usage tier. This tab is not visible, if "Layar Vision" is not enabled.
  • Pricing  - Set up the price tier for your premium layer.

 

Each tab will be explained in detail as below:

 

1. General tab

 

In screenshot 1, basic information about this layer is provided, such as layer status and layer developer / publisher emails. Again, layer type can be changed here. NOTE that Once Layar Vision is enabled, this will also change the Layer type to 3D and 2D objects in 3D spaces and the Minimum API version to version 6.0 automatically after the settings are saved.

 

2. API endpoint tab

 

screenshot 2 - API endpoint tab

 

As we can see that API endpoint URL (which was defined when this layer was created) can be modified here. 

 

Since Layar client 5.0 release, it is possible for users to upload screenshots taken from the camera view directly to layer developer's web server. This can be defined under Hosted screenshots section. The detailed description of each field can be found below:

 

Fields
Required/Default
Definition
URL to post screenshots to
Optional (mandatory when this function is used)

The URL of your website where end users can post screenshots to. If this is filled out, and a user selects to share a screenshot with this option, an HTTP post (encoded as multipart/form-data) will be sent to this URL containing parameters:

- screenshot: the image

- layer_name: the name of the layer

- message: a message from the user

- lat: latitude of the user

- lon: longitude of the user

- location_name: friendly location name

Button text 
Optional (mandatory when this function is used) The text shown when the user chooses to share the screenshot. 

 

For more information on how to implement this sharing feature, please read the "share a screenshot to a developer defined URL" section on Sharing API page.

 

If you want to check genuine requests from layar, OAuth signature can be used. Detailed definition for OAuth signing is provided in the following table:

 

Fields
Required/Default
Value
Definition
OAuth signing requried
Optional/false Whether or not the Layar Server should sign requests using OAuth signing
OAuth consumer key

Optional (mandatory when OAuth signing is required)

The OAuth Consumer key to be used when signing
OAuth consumer secret
Optional (mandatory when OAuth signing is required) The OAuth Consumer secret to be used when signing

 

3. Listing & indexing tab

 

  • Listing, fields related to layer listing in layar application on the phone are discussed here. 

 

 

screenshot 3 - layer listing

 

As we can see that "Title" and "Short description" fields (which were defined when this layer was created) can be modified here.

 

Fields
Required/Default
Value
Definition
Tooltips
layer icon
high-res icon is mandatory(while requesting for publication)

The icon to be used in the list of layers in the Layer Gallery.

It is possible to have this icon (in PNG format) in different resolutions, high-res (128X128), medium-res (96X96) and low-res (64X64).

• The medium-res and low-res icons can be generated automatically based on the high-res icon.
• Please refrain from using corner effects and/or rounded corners. A mask with 4px radius rounded corners will be applied automatically.
layer Screenshot
Optional
A screenshot which will be shown below the detail description text on layer listing page.
size 480x320 px
 Category
Mandatory(while requesting for publication)
A list of categories that a layer belong to.  The category list and description can be found here.
Please assign your layer to the right category. This will make sure that users can find your layers using Categories section in Layar app on the phone. 
Detail description Mandatory(while requesting for publication) Some text that will further describe what this layer is about and how to use it and where hotspots are located, etc. • Goal of your layer, e.g. find the nearest restaurant, play a game and win or City guide
• Location of the Spots, e.g. Amsterdam only, New York, Alps, Scandinavia, Santa Barbara university campus, all over the world, etc.
• If your data source is user generated, please mention this. E.g. "This data is taken from www.worldpeaks.org. You can add mountain peaks on this site.
• If your layer is temporary (e.g. for the duration of a festival) please inform the user.
• Please mention it if users interact with your layer (e.g. submit Spots, give a Spots a rating).
Tags Mandatory/at least 1 tag A list of words describing the layer. A maximum of 15 words is supported. Note that the words in the layer title and publisher name are automatically added to the tag list. • Try to come up with the right keywords that can cover the content of your layer. Therefore your target audience should be able to find your layer easily.
•  Add keywords in English for foreign users if your layer is also useful to them.

 

To get an idea on how these fields fit in layar application on the phone, please see the screenshot below:

 

screenshot 4 - layer listing

 

 

  • Indexing fields related to layer indexing in layar application on the phone are discussed here.

 

 

screenshot 5 - layer indexing

 

Fields
Required/Default
Value
Definition
Tooltips
Minimum API version
Mandatory / version 3.0

The earliest API version that supports all the required features in your layer. This ensures your layer will be found and working well on Layar clients that have the same or newer version. For instance, if your layer relies heavily on POI actions using asynchronous requests with your server, the minimum API version should be v4.0. Your layer will be shown on Layar clients which support API version 4.0 or above.

NOTE: if Layar Vision is enabled, the minimum API version should be 6.0.

 Please note that backward compatibility is best effort: The layar server will remove fields that are not defined/supported from the response, which may lead to unintended behaviour on older clients. For more information please read Mininum API Version explanation .
Layar Stream options
Mandatory / Allow layar to index all POIs for this layer

Define whether hotspots will be shown in Layar stream (Nearby view in layar app).

1. Allow Layar to cache all POIs of this layer.(Recommended)

The POIs of this layer will be visible for end-users in Layar Stream.

2. Allow Layar to cache only the title and position of the POIs of this layer.

Only the title and postions of the POIs of this layer will be visible for end-users in Layar Stream

3. Don't allow Layar to cache the POIs of this layer.

The POIs of this layer won't be visible for end-users in Layar Stream

Tips to improve your ranking:
• Give short, meaningful titles to POIs
• Give your POIs a unique ID
• Give your POIs the correct Time to Live
• A high-value POI with actions or 3D is more likely to rank high
Expiration date (layar stream)
Optional 
This is the date on which the POIs in your layer shouldn't be indexed anymore. Your POIs will not be visible in Layar Stream after that date.
Please fill this in correctly if your layer is temporary. 
Time to live (layer stream)
Mandatory / long (1 week) 
This is the average time during which a POI is considered relevant for other users since the last time it was indexed.  You can also opt-out on a POI level. This is for example useful in a game, where you don't want your clues to be indexed and would include only the starting point of the game in Layar Stream.
Please fill this in correctly according to the type of your layer content. Choose 1 week for static content, 1 day for dynamic content and 6 hours for highly dynamic content.

 

Layar Stream is a patent pending Stream Technology used in layar's Reality Browser. Layar Stream supports any location based object published into Layar such as check-ins, coupons, status updates, gaming, information, 3D models and more. Publishers will also benefit by seeing their content, for the first time, served up at time and location most relevant to their users. For more information on layar stream, please visit here

 

4. Look & Feel

 

 

screenshot 6 - Look & feel

 

  • General

 

Fields
Required/Default
Value
Definition
Tooltips
 Banner Icon
Required (High-res icon)
The icon (in PNG format) to use in the banner for branding the layer. The high-res icon is required.

The high-res icon will also generate a scaled down version of medium-res and low-res. Optionally, you can upload your own medium-res and low-res icons.

color fields
Optional
All color fields that will affect the layer appearance in Camera view (see screenshot below)
Test them on the phone to see whether they look nice. 

 

  • Custom POI Indicator Widgets (CIW)

 

      By default, hotspots in camera view are represented by black disks. Instead of this default disk shape, developers are able to specify custom CIWs.

      Each CIW set has four states:

    • Focus: when it is selected
    • Inner: when it is located in the inner (closest) ring of the radar
    • Middle: when it is located in the middle ring of the radar
    • Outer: when it is located in the outer ring of the radar

 

       The custom CIW object is returned as:

 

Fields           
Value Required/Default
Value
Explanation
POI Type Integer (1..3) Optional/Empty

An integer identifying the POI type. When the client needs to display a POI with this type, it will use the custom icons defined with this CIW.

Focus PNG Optional/Empty The icon for the focus state. 110x110 pixels. If you leave empty, the client will display the standard colored disk.
Inner PNG Optional/Empty The icon for the inner, unfocused state. 110x110 pixels. If you leave empty, the client will display the standard colored disk. 
Middle PNG Optional/Empty The icon for the middle, unfocused state. 76x76 pixels. If you leave empty, the client will display the standard colored disk.
Outer PNG Optional/Empty The icon for the outer, unfocused state. 56x56 pixels. If you leave empty, the client will display the standard colored disk.

 

     Instructions for making a good custom CIW:

     Your icon should be build in the following way in order to stand out regardless of the background the camera is pointing at:

    • Make a clear icon, preferably plain color, that fits in a 1.) 90x90 pixels box for the focus and inner icons, 2.) 60x60 pixels or 3.) 40x40 pixels, respectively, for the middle and outer icons.
    • These transparent icons fit in their respective templates: 1.) 110x110, 2.) 76x76, 3.) 56x56
    • Add a two pixels white border around the icon. 
    • Add an eight pixels black drop shadow, at 40% opacity

 

     Some guidelines:

    • For the focus icon, use a color that matches your BIW, this is more pleasing to the eye
    • For the inner, middle and outer icons, use three colors with the same base color, fading to lighter colors for the icons further away. This gives a more realistic image.

 

 The following screenshot shows how these fields are applied in Layar application on the phone.

 

screenshot 7 - Camera view

 

5. Coverage

 

screenshot 8 - Coverage

 

Fields
Required/Default
Value
Definition
Tooltips
Countries
Mandatory  (while requesting for publication) The country for which the layer is relevant, ISO format.
• Select the countries in which the Spots of your layer are located. You can select multiple countries, up to a maximum of 20.
• Country code 'international' can only be used for layers that have user-generated input and can thus contain Spots anywhere (e.g. Flickr, Twitter or Foursquare) or for layers that have Spots in more than 20 countries.
Bounding Boxes
Optional/Empty
The layer should be made "local" if all (or most of) its Spots are clustered in one city/region. You can make your layer local by defining one or more bounding boxes. This will make your layer more visible to users because it shows up in the local tab of the client if a user is in this particular area

•Zoom in until the map border becomes green, you can then left click on the map to add a bounding box. 

• Each bounding box has a geo-coordinates representation. Move mouse to a blue geo-coordinates set, the corresponding bounding box will be zoomed to an editable level on the map.
• Do not make your bounding boxes too large. Users should be able to find your Spots from anywhere within the area covered by the bounding boxes.

• The number of bounding boxes is limited to 20.

 

Some more NOTEs on Bounding boxes: 

 

Layers with bounding boxes are called "Local" layers. When searching for layers in Layar client, these are the rules applied:

 

  • Featured: A local layer can still be featured. Therefore it is important that you still indicate in the detail description where your layer is supposed to be used. 
  • Favorites: A local layer can still be made favorite. Same as above.
  • Popular: A local layer is indexed for popularity but if it's very local it's popularity rank is likely to be lower than a more global layer. 
  • Local: A user will only see a local layer if his current location is within the bounding box(es) of the layer. The smaller the bounding box, the higher in the list will the layer appear (more local relevancy). If the user is roaming (is currently in a different country than the default country of his phone), this list will also show the country-specific layers for the country he's roaming in. These layers will appear after the local layers.
  • Search: A local layer will be found like any other layer using the search feature.

 

6. Filters

 

There are five different filters that can be associated with each layer. The values of each filter will be sent in the request for hotspots. They are all optional.  The screenshot below shows two of the filters (Range Slider and Textbox).

 

 

screenshot 9 - Filters

 

The detailed definition of each filter is listed below:

 

  • Text box: limited to 3 text boxes per layer

 

 

Fields           
Required/Default
Value
Example Explanation
Label
Mandatory
"Search terms"               The label to be displayed in the filter settings view               
Default value
Optional / Empty
"" Default value to display and use in the search box               

 

  • Slider: limited to 3 sliders per layer

 

 

Fields
Required/Default
Value
Value Example Explanation
Label Mandatory String "Max price"              The label to be displayed on top of the slider
Label Unit Mandatory String "\u20ac" The unit to be associated with the label, unicode supported (here e.g. €)
Max value Mandatory / 0 Integer 2000000 The maximum value of the slider
Min value Mandatory / 0 Integer 10000 The minimum value of the slider
Default value Mandatory / 0 Integer 500000 The default value of the slider

 

  • Range Slider: limited to 1 range slider per layer

 

Fields
Required/Default
Value
Value Example Explanation
Label Mandatory / Search range
String "Search range"              The label to be displayed on top of the slider
Max value Mandatory / 5000
Integer 5000
The maximum value of the slider
Min value Mandatory /100
Integer 100 The minimum value of the slider
Default value Optional / 1500
Integer 1500
The default value of the slider

 

  • RadioButton List: Limited to 1 RadioButton list per layer

 

 

Fields
Required/Default
Value
Value Example Explanation
label Mandatory / Empty String "Choose industry" The label to be displayed above the radio list

options:

Value

Mandatory / Empty

 

Array of Strings ["1000", "1001", "1002"] These are the internal values used to define the various options. This value is passed as parameter in the query for the POI's.

options:

Display Text

Mandatory / Empty Array of Strings ["all industries", "administrative", "commercial"] The are the values shown to the user, each corresponding to one option value.

options:

Default

Mandatory / Empty String "1000" The value that is selected by default

 

  • Checkbox List: Limited to 1 Checkbox list per layer

 

Fields
Required/Default
Value
Value Example Explanation
label Mandatory / Empty
String "Choose industry" The label to be displayed above the radio list

options:

Value

Mandatory / Empty

 

Array of Strings ["1000", "1001", "1002"] These are the internal values used to define the various options. This value is passed as parameter in the query for the POI's.

options:

Display Text

Mandatory / Empty
Array of Strings ["all industries", "administrative", "commercial"] The are the values shown to the user, each corresponding to one option value.

options:

Default

Mandatory / Empty
Array of Strings ["1000", "1001"]
The values that ares selected by default

  

All these filter settings will appear in the layer settings page in Layar application on the phone. If "Show filters before loading layer" is checked, this layer settings page will always appear before camera view is shown. The following image shows how these filters look like on Layar client.

 

screenshot 10 - Filters on Layar client

 

 

7. Permissions

 

Under "Permissions" tab, publisher name which was defined while layer creation can be edited. At the same time, the ownership of a layer can be transferred from current publisher to another publisher. Developer can also add a viewer for a layer so that this viewer can see this layer on Layar client even it is still in development.

 

screenshot 11 - Permissions

 

  • Assign new publisher  

 

By default, the layer developer is also the publisher of this layer. The ownership of this layer can be transferred to another publisher by following the steps below:

1. Click on "Assign new publisher" button.

2. Fill in the email address of this new publisher.

3. An email is sent to this email address to notify this publisher on his role and assignment. Meanwhile, it explains what this publisher needs to do in order to see this layer in the publishing site environment.

 

  • Add viewer

 

By adding viewers to a layer, other people can see this layer on Layar client even it is not in public status. This is especially useful when you want to show it to other people, such as project clients. To Add a viewer:

1. Click on "Add viewer" button.

2. Fill in the email address of this viewer.

3. An email is sent to this viewer to notify him/her on this assignment.

4. If this viewer already has a Layar account (with the same email address), he/she can directly start viewing your layer on Layar client after logging in.

5. If not, he will then need to create a Layar account on layar website (www.layar.com) first in order to see this layer on layar client.

 

8. Reference images

 

For Vision enabled layers, reference images can be uploaded and maintained here.

 

For the uploaded reference image, the following information needs to be provided:

 

Fields
Description
Requirement (Best practices)
Image
The image itself that is uploaded from your computer
Image resolution must be at least 640 x 480 pixels, though larger images are accepted and encouraged. Supported file types include .JPG, .PNG, and .GIF. File size may not exceed 10 MB.
Image key
The key that is used to identify a reference image. It is the value of "referenceImage" defined in "anchor" object of a POI in getPOI response.

The image key is a quick way to identify your images. It has to be unique for a layer. We recommend using a personalized, easily remembered key.

NOTE: After you create an Image Key, the image will be processed by our server and you will not be able to edit it. To change the image or its key, you must delete the original and upload a replacement.

Real World Height
How high is your image in the real world in meters?
Fill in the real height of the target object that you want to augment. This determines how the unit length of the coordinate system is scaled with respect to the target object. So it will determine the size of the augment with respect to the target object and the lengths when "transform" or "animation" are applied to the augment.



screenshot 12 - Reference images

 

Once a reference image is uploaded, the legend below is used to show ratings assigned by Layar server based on the quality and clarity of images and their ability to be used for Layar Vision.

 

  • GREEN - Green means the image is good to go. It should function properly with Layar Vision.
  • YELLOW - Yellow means the image will function properly under certain conditions, but we recommend that a better image is used. Try boosting contrast or increasing brightness to improve the image’s clarity and definition.
  • RED - Red means the image will most certainly not function properly under most conditions. Make sure images are focused with high contrast, definition and brightness. If you need more help making a good image, see our more detailed guidelines here.

 

9. Vision Usage

 

 

In order to publish your Vision-enabled Layer, please select a Layar Vision usage tier under this tab. 

 

screenshot 13 - Vision Usage

 

Please NOTE that this is only needed for Vision enabled layers. for more information about tiers, please read here.  If you have created a geolocation layer which does not use Layar Vision feature at all, please make sure that you do not enable Layar Vision feature on the publishing site. Layar will not charge anything for creating geolocation layers. On the other hand, developers can create paid layers which means users need to pay to use your layers. You can manage the pricing of a paid layer under the "Pricing" tab below.

 

10. Additional Settings

 

Under this tab, some more layer level settings can be configured to support complex mechanisms in a layer.

 

screenshot 14 - Additional settings

 

Explanations for each field can be found in the table below:

 

 

Key

Required/Default
Value

Example

Explanation

Show 'Take me there' Optional / true checked or unchecked If it is checked (true), a "take me there" button will be shown as an action in the Spots Detailed BIW. This button will launch Google Maps, which shows the Spots location on the map. If it is not checked (false), this button is not shown.  This option is based on a layer level.
Enable additional settings Optional / false checked or unchecked If checked (true), the additional layer settings listed below will be enabled.

valid cookie required

 

Optional / false

false (by default)

Indicates whether valid cookie(s) is required prior to launching the layer. If it is checked (true), the Client will firstly check whether there is a cookie, if not, it will redirect the user to the page defined in "URL for layer settings page".

URL for layer settings page

 

Required when 'Enable additional settings' is checked

https://m.hyves.nl/layar/signin

The URL to call for the webview to authenticate the user. Usually https.

 

NOTE that this URL needs to be on the same domain as the poiURL (it's just a cookie we're using, so all normal browser cookie rules apply), different sub domains are allowed.

Description for button

 

Required when 'Enable additional settings' is checked User Authentication
A description is shown on top of the button which explains what this button is about.

Button label

 

Required when 'Enable additional settings' is checked login The text that is displayed on the button itself.

Replace filters

 

Optional / false
unchecked Indicates whether the web page launched by 'URL for layer settings page' will replace the entire filter settings defined under "Filters" tab. If it is checked (true), the web page content will appear under the filter settings button in the camera view. By default, it is unchecked (false).
Parameters added in request Optional / Empty
https://custom.layar.nl/login.php?
lon=4.933156943889342&
lat=52.373196116536235
A group of preset parameters that can be added to the request when the button is clicked.

The possible multiple values are "latitude", "longitude", "country code", "accuracy", "language", "API version".

 

The button which has these additional settings enabled can be found on the layer filter settings page in Camera view on layar client.

screenshot 15 - additional settings button

 

11. Pricing

 

This tab is for defining and customizing premium layers. For more information on our premium layer program, please download this document. Download Layar-Paid-Countries.pdf to see which countries support paid layers.

 

screenshot 16 - pricing

 

Fields
Required/Default
Value
Definition
Tooltips
Pricing
Optional / free
Determine whether a layer is a premium / free layer. Select how you would like to publish your layer. Please note that you CAN NOT change this after publication.  Countries that can purchase a premium layer are: United States, United Kingdom, Australia, Canada, France, Italy, Netherlands and Malaysia. Other countries will follow up very soon.
Price tier
Required if Pricing is set to paid
Set up price tier for purchasing a layer.
When you are thinking of which price to give your layer, ask yourself what you would pay for it. Keep in mind that, as digital goods are a relatively market, users are still hesitant to buy expensive layers. Our statistics show that cheap layers sell best. We therefore recommend using price tiers 8, 9 and 10.

If your layer is a 'must have' for the intended audience you can consider asking a higher price.

 

This is the end of layer editing section. Please do not forget to save changes made to layer editing. You will probably come back to this section from time to time to configure the best options for your layer.

 

Comments (0)

You don't have permission to comment on this page.