{"_id":"58f7a4c8cbd001190056cc24","user":"57bb7defafc18c0e00529cf1","parentDoc":null,"project":"578c4badbd223d2000cc1441","version":{"_id":"58f7a4c8cbd001190056cbf8","__v":1,"project":"578c4badbd223d2000cc1441","createdAt":"2017-04-19T17:56:24.172Z","releaseDate":"2017-04-19T17:56:24.172Z","categories":["58f7a4c8cbd001190056cbf9","58f7a4c8cbd001190056cbfa","58f7a4c8cbd001190056cbfb","58f7a4c8cbd001190056cbfc","58f7a4c8cbd001190056cbfd","58f7a4c8cbd001190056cbfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1.0"},"__v":0,"category":{"_id":"58f7a4c8cbd001190056cbfe","__v":0,"version":"58f7a4c8cbd001190056cbf8","project":"578c4badbd223d2000cc1441","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":5,"slug":"api-reference","title":"API Reference"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T00:07:16.586Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":28,"body":"A component that provides a 2D surface for playing video. This can be used to display virtual video screens.\n\n######Example use:\n```\n \n<ViroVideo\n    source={require('./video/myvid.mp4')}\n    loop={true}\n    position={[0,2,-5]}\n    scale={[2, 2, 0]}\n />\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Props\"\n}\n[/block]\n##Required Props\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-0\": \"**source**\",\n    \"0-1\": \"**PropTypes.oneOfType( [PropTypes.shape( {uri:  PropTypes.string} ), PropTypes.number] )**\\n\\nThe video source, a remote URL or a local file resource. MPEG videos accepted.\\n\\nTo invoke with remote url: \\n```\\n{uri:\\\"http://example.org/myvideo.mp4\\\"}\\n```\\n\\nTo invoke with local source:\\n```\\nrequire('./myvideo.mp4');\\n```\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nOptional Props\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**height**\",\n    \"2-0\": \"**materials**\",\n    \"3-0\": \"**muted**\",\n    \"8-0\": \"**onFinish**\",\n    \"10-0\": \"**onHover**\",\n    \"15-0\": \"**opacity**\",\n    \"16-0\": \"**paused**\",\n    \"17-0\": \"**position**\",\n    \"18-0\": \"**rotation**\",\n    \"19-0\": \"**scale**\",\n    \"21-0\": \"**transformBehaviors**\",\n    \"22-0\": \"**volume**\",\n    \"23-0\": \"**visible**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-1\": \"**PropTypes.number**\\n\\nThe height of the video in 3D space. Default value is 1.\",\n    \"2-1\": \"**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\\n\\nTakes array of 1 material that serves as the material of the surface that is displaying the video.\",\n    \"3-1\": \"**PropTypes.bool**\\n\\nSet to true to loop the video. This is set to false by default.\",\n    \"8-1\": \"**React.PropTypes.func**\\n\\nCallback that is called when the video is finished playing. This function isn't called at the end of a video if looping is enabled.\",\n    \"10-1\": \"**React.PropTypes.func**\\n\\nCalled when the user hovers on or off the control.\\n\\nFor example:\\n```  \\n_onHover(isHovering, source)  {\\n    if(isHovering) {\\n        // user is hovering over the box\\n    } else {\\n        // user is no longer hovering over the box\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"15-1\": \"**PropTypes.number**\\n\\nA number from 0 to 1 that specifies the opacity of the button. A value of 1 translates into a fully opaque button while 0 represents full transparency.\",\n    \"16-1\": \"**PropTypes.bool**\\n\\nSet to true to pause the video. This is set to false by default.\",\n    \"17-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the video in 3D world space, specified as [x, y, z].\",\n    \"18-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe rotation of the box around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.\",\n    \"19-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe scale of the box in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the box. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the box proportionally bigger along the specified axis.\",\n    \"21-1\": \"**PropTypes.arrayOf(PropTypes.string)**\\n\\nAn array of transform constraints that affect the transform of the object. For example, putting the value \\\"billboard\\\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\\n\\nAllowed values(values are case sensitive):\\n\\n|Value|Description|\\n|:------|:----------:|\\n|billboard| Billboard object on x,y,z axis |\\n|billboardX| Billboard object on the x axis|\\n|billboardY| Billboard object on the y axis|\",\n    \"22-1\": \"**PropTypes.number**\\n\\nA number represented volume from 0 to 1. Max volume is equal to 1. Min volume is equal to 0. This is set to 1 by default.\",\n    \"23-1\": \"**PropTypes.bool**\\n\\nFalse if the video should be hidden. By default the video is visible and this value is true.\",\n    \"24-0\": \"**width**\",\n    \"24-1\": \"**PropTypes.number**\\n\\nThe width of the video in 3D space. Default value is 1.\",\n    \"1-0\": \"**loop**\",\n    \"1-1\": \"**PropTypes.bool**\\n\\nSet to true to loop the video. This is set to false by default.\",\n    \"4-0\": \"**onClick**\",\n    \"4-1\": \"**React.PropTypes.func**\\n\\nCalled when an object has been clicked.\\n\\nExample code:\\n```  \\n_onClick(source)  {\\n    // user has clicked the object\\n}\\n```\",\n    \"5-0\": \"**onClickState**\",\n    \"5-1\": \"**React.PropTypes.func**\\n\\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \\\"Clicked\\\" the object.|\\n\\nExample code:\\n```  \\n_onClickState(stateValue, source)  {\\n    if(stateValue == 1) {\\n        // Click Down\\n    } else if(stateValue == 2) {\\n        // Click Up\\n    } else if(stateValue == 3) { \\n        // Clicked\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"6-1\": \"**React.PropTypes.func**\\n\\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \\n\\nExample code:\\n```  \\n_onDrag(dragToPos, source)  {\\n    // dragtoPos[0]: x position\\n    // dragtoPos[1]: y position\\n    // dragtoPos[2]: z position\\n}\\n``` \\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \\n\\nUnsupported VR Platforms: Cardboard iOS\",\n    \"6-0\": \"**onDrag**\",\n    \"11-0\": \"**onScroll**\",\n    \"12-0\": \"**onSwipe**\",\n    \"13-0\": \"**onTouch**\",\n    \"11-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a scroll action, while hovering on the control.\\n\\nFor example:\\n```  \\n_onScroll(scrollPos, source)  {\\n    // scrollPos[0]: x scroll position from 0.0 to 1.0. \\n    // scrollPos[1]: y scroll position from 0.0 to 1.0.\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"12-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \\n\\nFor example:\\n```  \\n_onSwipe(state, source)  {\\n    if(state == 1) {\\n        // Swiped up\\n    } else if(state == 2) {\\n        // Swiped down\\n    } else if(state == 3) { \\n       // Swiped left\\n    } else if(state == 4) { \\n       // Swiped right\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"13-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Touch Down: Triggered when the user  makes physical contact with the touch pad on the controller. |\\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\\n\\nFor example:\\n```  \\n_onTouch(state, touchPos, source)  {\\n   var touchX = touchPos[0];\\n   var touchY = touchPos[1];\\n    if(state == 1) {\\n        // Touch Down\\n    } else if(state == 2) {\\n        // Touch Down Move\\n    } else if(state == 3) { \\n        // Touch Up\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS).\",\n    \"14-0\": \"**onUpdateTime**\",\n    \"14-1\": \"**React.PropTypes.func**\\n\\nCallback that is called when the current playback position has changed.\\n\\nFor example:\\n```  \\n_onUpdateTime(currentPlaybackTimeInSeconds, totalPlayBackDurationInSeconds) {\\n    // Update Seek Bar or custom UI\\n}\\n```\",\n    \"7-0\": \"\\\"onError*\",\n    \"7-1\": \"**React.PropTypes.func**\\n\\nCallback invoked when the Video fails to load. The error message is contained in event.nativeEvent.error\",\n    \"20-1\": \"**PropTypes.oneOf(['leftRight', 'rightLeft', 'topBottom', 'bottomTop', 'none'])**\\n\\nSpecifies the alignment mode of the provided stereo image in source. Given image mode alignments are rendered in the order of Lefteye-Righteye. Defaults to none.\",\n    \"20-0\": \"**stereoMode**\",\n    \"9-1\": \"**PropTypes.oneOfType**\\n```  \\nPropTypes.oneOfType([\\n      React.PropTypes.shape({\\n        callback: React.PropTypes.func.isRequired,\\n        timeToFuse: PropTypes.number\\n      }),\\n      React.PropTypes.func,\\n])\\n```  \\nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \\n\\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \\n\\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\\n\\nNote that timeToFuse defaults to 2000ms.\\n\\nFor example:\\n```  \\n_onFuse(source){\\n   // User has hovered over object for timeToFuse milliseconds\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"9-0\": \"**onFuse**\"\n  },\n  \"cols\": 2,\n  \"rows\": 25\n}\n[/block]","excerpt":"","slug":"virovideo-2-compare","type":"basic","title":"ViroVideo"}
A component that provides a 2D surface for playing video. This can be used to display virtual video screens. ######Example use: ``` <ViroVideo source={require('./video/myvid.mp4')} loop={true} position={[0,2,-5]} scale={[2, 2, 0]} /> ``` [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Required Props [block:parameters] { "data": { "h-0": "PropKey", "h-1": "PropType", "0-0": "**source**", "0-1": "**PropTypes.oneOfType( [PropTypes.shape( {uri: PropTypes.string} ), PropTypes.number] )**\n\nThe video source, a remote URL or a local file resource. MPEG videos accepted.\n\nTo invoke with remote url: \n```\n{uri:\"http://example.org/myvideo.mp4\"}\n```\n\nTo invoke with local source:\n```\nrequire('./myvideo.mp4');\n```" }, "cols": 2, "rows": 1 } [/block] Optional Props [block:parameters] { "data": { "0-0": "**height**", "2-0": "**materials**", "3-0": "**muted**", "8-0": "**onFinish**", "10-0": "**onHover**", "15-0": "**opacity**", "16-0": "**paused**", "17-0": "**position**", "18-0": "**rotation**", "19-0": "**scale**", "21-0": "**transformBehaviors**", "22-0": "**volume**", "23-0": "**visible**", "h-0": "PropKey", "h-1": "PropType", "0-1": "**PropTypes.number**\n\nThe height of the video in 3D space. Default value is 1.", "2-1": "**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\n\nTakes array of 1 material that serves as the material of the surface that is displaying the video.", "3-1": "**PropTypes.bool**\n\nSet to true to loop the video. This is set to false by default.", "8-1": "**React.PropTypes.func**\n\nCallback that is called when the video is finished playing. This function isn't called at the end of a video if looping is enabled.", "10-1": "**React.PropTypes.func**\n\nCalled when the user hovers on or off the control.\n\nFor example:\n``` \n_onHover(isHovering, source) {\n if(isHovering) {\n // user is hovering over the box\n } else {\n // user is no longer hovering over the box\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "15-1": "**PropTypes.number**\n\nA number from 0 to 1 that specifies the opacity of the button. A value of 1 translates into a fully opaque button while 0 represents full transparency.", "16-1": "**PropTypes.bool**\n\nSet to true to pause the video. This is set to false by default.", "17-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the video in 3D world space, specified as [x, y, z].", "18-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe rotation of the box around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.", "19-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe scale of the box in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the box. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the box proportionally bigger along the specified axis.", "21-1": "**PropTypes.arrayOf(PropTypes.string)**\n\nAn array of transform constraints that affect the transform of the object. For example, putting the value \"billboard\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\n\nAllowed values(values are case sensitive):\n\n|Value|Description|\n|:------|:----------:|\n|billboard| Billboard object on x,y,z axis |\n|billboardX| Billboard object on the x axis|\n|billboardY| Billboard object on the y axis|", "22-1": "**PropTypes.number**\n\nA number represented volume from 0 to 1. Max volume is equal to 1. Min volume is equal to 0. This is set to 1 by default.", "23-1": "**PropTypes.bool**\n\nFalse if the video should be hidden. By default the video is visible and this value is true.", "24-0": "**width**", "24-1": "**PropTypes.number**\n\nThe width of the video in 3D space. Default value is 1.", "1-0": "**loop**", "1-1": "**PropTypes.bool**\n\nSet to true to loop the video. This is set to false by default.", "4-0": "**onClick**", "4-1": "**React.PropTypes.func**\n\nCalled when an object has been clicked.\n\nExample code:\n``` \n_onClick(source) {\n // user has clicked the object\n}\n```", "5-0": "**onClickState**", "5-1": "**React.PropTypes.func**\n\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \"Clicked\" the object.|\n\nExample code:\n``` \n_onClickState(stateValue, source) {\n if(stateValue == 1) {\n // Click Down\n } else if(stateValue == 2) {\n // Click Up\n } else if(stateValue == 3) { \n // Clicked\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "6-1": "**React.PropTypes.func**\n\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \n\nExample code:\n``` \n_onDrag(dragToPos, source) {\n // dragtoPos[0]: x position\n // dragtoPos[1]: y position\n // dragtoPos[2]: z position\n}\n``` \nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \n\nUnsupported VR Platforms: Cardboard iOS", "6-0": "**onDrag**", "11-0": "**onScroll**", "12-0": "**onSwipe**", "13-0": "**onTouch**", "11-1": "**React.PropTypes.func**\n\nCalled when the user performs a scroll action, while hovering on the control.\n\nFor example:\n``` \n_onScroll(scrollPos, source) {\n // scrollPos[0]: x scroll position from 0.0 to 1.0. \n // scrollPos[1]: y scroll position from 0.0 to 1.0.\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "12-1": "**React.PropTypes.func**\n\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \n\nFor example:\n``` \n_onSwipe(state, source) {\n if(state == 1) {\n // Swiped up\n } else if(state == 2) {\n // Swiped down\n } else if(state == 3) { \n // Swiped left\n } else if(state == 4) { \n // Swiped right\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "13-1": "**React.PropTypes.func**\n\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\n\n|State Value|Description|\n|:------|:----------:|\n|1| Touch Down: Triggered when the user makes physical contact with the touch pad on the controller. |\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\n\nFor example:\n``` \n_onTouch(state, touchPos, source) {\n var touchX = touchPos[0];\n var touchY = touchPos[1];\n if(state == 1) {\n // Touch Down\n } else if(state == 2) {\n // Touch Down Move\n } else if(state == 3) { \n // Touch Up\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS).", "14-0": "**onUpdateTime**", "14-1": "**React.PropTypes.func**\n\nCallback that is called when the current playback position has changed.\n\nFor example:\n``` \n_onUpdateTime(currentPlaybackTimeInSeconds, totalPlayBackDurationInSeconds) {\n // Update Seek Bar or custom UI\n}\n```", "7-0": "\"onError*", "7-1": "**React.PropTypes.func**\n\nCallback invoked when the Video fails to load. The error message is contained in event.nativeEvent.error", "20-1": "**PropTypes.oneOf(['leftRight', 'rightLeft', 'topBottom', 'bottomTop', 'none'])**\n\nSpecifies the alignment mode of the provided stereo image in source. Given image mode alignments are rendered in the order of Lefteye-Righteye. Defaults to none.", "20-0": "**stereoMode**", "9-1": "**PropTypes.oneOfType**\n``` \nPropTypes.oneOfType([\n React.PropTypes.shape({\n callback: React.PropTypes.func.isRequired,\n timeToFuse: PropTypes.number\n }),\n React.PropTypes.func,\n])\n``` \nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \n\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \n\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\n\nNote that timeToFuse defaults to 2000ms.\n\nFor example:\n``` \n_onFuse(source){\n // User has hovered over object for timeToFuse milliseconds\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "9-0": "**onFuse**" }, "cols": 2, "rows": 25 } [/block]