{"_id":"5b36797811baf70003a153a5","category":{"_id":"5b36797811baf70003a15361","version":"5b36797811baf70003a153e5","project":"578c4badbd223d2000cc1441","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":8,"slug":"api-reference","title":"API Reference"},"project":"578c4badbd223d2000cc1441","user":"576c22a3808cf02b00d37419","parentDoc":null,"version":{"_id":"5b36797811baf70003a153e5","project":"578c4badbd223d2000cc1441","__v":0,"forked_from":"5b17376c3b44af00030764f0","createdAt":"2018-04-23T20:03:35.726Z","releaseDate":"2018-04-23T20:03:35.726Z","categories":["5b36797811baf70003a1535c","5b36797811baf70003a1535d","5b36797811baf70003a1535e","5b36797811baf70003a1535f","5b36797811baf70003a15360","5b36797811baf70003a15361","5b36797811baf70003a15362","5b36797811baf70003a15363","5b36797811baf70003a15364"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.8.1","version":"2.8.1"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-16T18:41:31.569Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":15,"body":"A collection of constants used in the Viro Platform.\n\n######Example use:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import {ViroConstants} from 'react-viro';\\n\\nif (returnValue == ViroConstants.RECORD_ERROR_NONE) {\\n    console.log(\\\"Success!\\\");\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n##Constants:\n \n###Video Recording/Screenshot Errors\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"RECORD_ERROR_NONE\",\n    \"0-1\": \"**-1**\",\n    \"1-0\": \"RECORD_ERROR_UNKNOWN\",\n    \"2-0\": \"RECORD_ERROR_NO_PERMISSION\",\n    \"3-0\": \"RECORD_ERROR_INITIALIZATION\",\n    \"4-0\": \"RECORD_ERROR_WRITE_TO_FILE\",\n    \"5-0\": \"RECORD_ERROR_ALREADY_RUNNING\",\n    \"6-0\": \"RECORD_ERROR_ALREADY_STOPPED\",\n    \"1-1\": \"**0**\",\n    \"2-1\": \"**1**\",\n    \"3-1\": \"**2** \\n\\nIndicates there was an error during initialization.\",\n    \"4-1\": \"**3** \\n\\nIndicates that there was an error writing to file.\",\n    \"5-1\": \"**4** \\n\\nIndicates that the system is already recording.\",\n    \"6-1\": \"**5** \\n\\nIndicates that the system is not currently recording.\",\n    \"h-1\": \"Value\",\n    \"0-2\": \"Indicates that there is no error.\",\n    \"h-2\": \"Notes\",\n    \"h-0\": \"Name\",\n    \"1-2\": \"Indicates that the platform encountered an unknown error.\",\n    \"2-2\": \"The user has denied permission required for recording/saving videos/screenshots.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n###AR Tracking States for ARScene\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"TRACKING_UNAVAILABLE\",\n    \"1-0\": \"TRACKING_LIMITED\",\n    \"2-0\": \"TRACKING_NORMAL\",\n    \"3-0\": \"TRACKING_REASON_NONE\",\n    \"4-0\": \"TRACKING_REASON_EXCESSIVE_MOTION\",\n    \"5-0\": \"TRACKING_REASON_INSUFFICIENT_FEATURES\",\n    \"0-1\": \"1\",\n    \"1-1\": \"2\",\n    \"2-1\": \"3\",\n    \"3-1\": \"1\",\n    \"4-1\": \"2\",\n    \"5-1\": \"3\",\n    \"0-2\": \"AR Camera position is not available.\",\n    \"1-2\": \"Tracking is available but quality of results can be may be wildly inaccurate and should generally not be used\",\n    \"2-2\": \"Camera position tracking is providing optimal results.\",\n    \"3-2\": \"The current tracking state is not limited.\",\n    \"4-2\": \"The device is moving too fast for accurate image-based position tracking.\",\n    \"5-2\": \"The scene visible to the camera does not contain enough distinguishable features for image-based position tracking.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"viroconstants","type":"basic","title":"ViroConstants"}
A collection of constants used in the Viro Platform. ######Example use: [block:code] { "codes": [ { "code": "import {ViroConstants} from 'react-viro';\n\nif (returnValue == ViroConstants.RECORD_ERROR_NONE) {\n console.log(\"Success!\");\n}", "language": "javascript" } ] } [/block] ##Constants: ###Video Recording/Screenshot Errors [block:parameters] { "data": { "0-0": "RECORD_ERROR_NONE", "0-1": "**-1**", "1-0": "RECORD_ERROR_UNKNOWN", "2-0": "RECORD_ERROR_NO_PERMISSION", "3-0": "RECORD_ERROR_INITIALIZATION", "4-0": "RECORD_ERROR_WRITE_TO_FILE", "5-0": "RECORD_ERROR_ALREADY_RUNNING", "6-0": "RECORD_ERROR_ALREADY_STOPPED", "1-1": "**0**", "2-1": "**1**", "3-1": "**2** \n\nIndicates there was an error during initialization.", "4-1": "**3** \n\nIndicates that there was an error writing to file.", "5-1": "**4** \n\nIndicates that the system is already recording.", "6-1": "**5** \n\nIndicates that the system is not currently recording.", "h-1": "Value", "0-2": "Indicates that there is no error.", "h-2": "Notes", "h-0": "Name", "1-2": "Indicates that the platform encountered an unknown error.", "2-2": "The user has denied permission required for recording/saving videos/screenshots." }, "cols": 3, "rows": 7 } [/block] ###AR Tracking States for ARScene [block:parameters] { "data": { "h-0": "Name", "h-1": "Value", "h-2": "Notes", "0-0": "TRACKING_UNAVAILABLE", "1-0": "TRACKING_LIMITED", "2-0": "TRACKING_NORMAL", "3-0": "TRACKING_REASON_NONE", "4-0": "TRACKING_REASON_EXCESSIVE_MOTION", "5-0": "TRACKING_REASON_INSUFFICIENT_FEATURES", "0-1": "1", "1-1": "2", "2-1": "3", "3-1": "1", "4-1": "2", "5-1": "3", "0-2": "AR Camera position is not available.", "1-2": "Tracking is available but quality of results can be may be wildly inaccurate and should generally not be used", "2-2": "Camera position tracking is providing optimal results.", "3-2": "The current tracking state is not limited.", "4-2": "The device is moving too fast for accurate image-based position tracking.", "5-2": "The scene visible to the camera does not contain enough distinguishable features for image-based position tracking." }, "cols": 3, "rows": 6 } [/block]