Document toolboxDocument toolbox

Private & Confidential

(1.2.0) Layer API

Owned by Harvey Buchan
Last updated: Aug 17, 2023
2 min read

The ICE Layer API allows for control and manipulation of Layers within the ICE system. Layers in ICE are identified by a unique ID, and all layer-related messages require the "id" parameter to specify the target layer.

Layer List

The layer list messages are used to track the layers currently present in the ICE workspace and retrieve their corresponding IDs. This is helpful for obtaining an overview of the existing layers.

Get Layer List:

The layerList/get message retrieves the list of layers in the workspace along with their IDs.

Subscribe to Layer List:

The layerList/subscribe message allows you to subscribe to updates regarding changes in the layer list. Whenever a new layer is added or an existing layer is removed, a notification will be sent back to the client.

Common Layer Messages

Common layer messages are independent of the layer type and may be set, retrieved, or subscribed to.

Please refer to the API documentation for further details on specific usage for each mesage

For example,

Layer Name (Get, Set and Subscribe allowed):

  • Set Layer Name: layer/general/name/set?id=n+value=v

  • Get Layer Name: layer/general/name/get?id=n

  • Subscribe to Layer Name: layer/general/name/subscribe?id=n

Layer Type (Get and Subscribe allowed):

  • Get Layer Type: layer/general/type/get?id=n

  • Subscribe to Layer Type: layer/general/type/subscribe?id=n

Contextual Layer Messages

Contextual layer messages are specific to the layer type and may vary based on the type of layer being manipulated.

For example,

WebView Layer URL:

  • Set WebView Layer URL: layer/contextual/url/set?id=n+url=v

  • Get WebView Layer URL: layer/contextual/url/get?id=n

  • Subscribe to WebView Layer URL: layer/contextual/url/subscribe?id=n

Video Layer Filepath:

  • Set Video Layer Filepath: layer/contextual/filepath/set?id=n+path=v

  • Get Video Layer Filepath: layer/contextual/filepath/get?id=n

  • Subscribe to Video Layer Filepath: layer/contextual/filepath/subscribe?id=n

 

By utilising these layer-specific messages and their corresponding parameters, you can control, retrieve information, and subscribe to updates for both common and contextual properties of the layers within the ICE system. Please refer to the API documentation for further details on available properties and their specific usage.

 

 

(c) Igloo Vision 2020