Appearance
Data types
As every API message is received by Igloo Core Engine as a string, arguments are coerced to their target data type on being received.
string
Any string
number
Any number
boolean
Anything other than 0 is interpreted as true by Igloo Core Engine.
(e.g. 1, true, false, NO are all interpreted as true; 0 is interpreted as false).
ContentBankTileType
VIDEOIMAGESESSIONLAUNCHER
ContentFileType
videoimagepdf
ContentSessionListFilter
alldescriptionthumbnailsaveTimereadOnlytags
EffectType
InvertInputTranslationPerspectiveExtractionISFPlaneToEquirectangular
InputTranslationType
CubemapStereo Cubemap LeftStereo Cubemap RightGear VR LeftGear VR RightOculus VRYouTube VRFishEyeCross cubemapCross reversed cubemapSkyBox cubemapSkyBox reversed cubemap
LayerId
identifier for a layer at runtime
LayerType
All possible layer types.
IMAGEVIDEOSPOUTYOUTUBEWEBVIEWBLACKMAGICDATAPATHAJAKONA5STREAMNDIDESKTOPIGLOOWEBPDFLOOPBACKAPPVIEWTIMELINECOMPOSITIONCONTENTBANKHOME
SessionDatabaseId
identifier for a session in the database
SessionId
identifier for a session at runtime
SubLayerType
IMAGEVIDEOSPOUTYOUTUBEWEBVIEWBLACKMAGICDATAPATHAJAKONA5STREAMNDIDESKTOPIGLOOWEBPDFLOOPBACKAPPVIEWTIMELINE
TagDatabaseId
identifier for a tag in the database
PlaybackState
Members
| Name | Value | Description |
|---|---|---|
| Buffering | Buffering | |
| None | None | |
| Paused | Paused | |
| Playing | Playing | |
| Stopped | Stopped |
PositionMode
Constraints on content positioning
Members
| Name | Value | Description |
|---|---|---|
| Free | 2 | No restriction on content movement |
| LockToContainer | 0 | Don't allow content to move outside its container (which is the canvas, unless wrapped by another container) |
| LockToRegion | 1 | Don't allow content to move outside its defined canvas region |