ViroVideo

{"_id":"5bec8a15287d1b00426efe2a","category":{"_id":"5bec8a15287d1b00426efdcb","version":"5bec8a15287d1b00426efe54","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"},"user":"57bb7defafc18c0e00529cf1","parentDoc":null,"project":"578c4badbd223d2000cc1441","version":{"_id":"5bec8a15287d1b00426efe54","project":"578c4badbd223d2000cc1441","__v":0,"forked_from":"5ba2b5747091250003437507","createdAt":"2018-04-23T20:03:35.726Z","releaseDate":"2018-04-23T20:03:35.726Z","categories":["5bec8a15287d1b00426efdc6","5bec8a15287d1b00426efdc7","5bec8a15287d1b00426efdc8","5bec8a15287d1b00426efdc9","5bec8a15287d1b00426efdca","5bec8a15287d1b00426efdcb","5bec8a15287d1b00426efdcc","5bec8a15287d1b00426efdcd","5bec8a15287d1b00426efdce"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.12.0","version":"2.12.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T00:07:16.586Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":47,"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[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<ViroVideo\\n source={require('./video/myvid.mp4')}\\n loop={true}\\n position={[0,2,-5]}\\n scale={[2, 2, 0]}\\n />\",\n \"language\": \"javascript\"\n }\n ]\n}\n[/block]\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]\n##Optional Props\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"**animation**\",\n \"8-0\": \"**materials**\",\n \"9-0\": \"**muted**\",\n \"17-0\": \"**onFinish**\",\n \"19-0\": \"**onHover**\",\n \"27-0\": \"**opacity**\",\n \"28-0\": \"**paused**\",\n \"30-0\": \"**position**\",\n \"31-0\": \"**rotation**\",\n \"33-0\": \"**scale**\",\n \"37-0\": \"**transformBehaviors**\",\n \"39-0\": \"**visible**\",\n \"h-0\": \"PropKey\",\n \"h-1\": \"PropType\",\n \"0-1\": \"**PropTypes.shape({\\n name: PropTypes.string,\\n delay: PropTypes.number,\\n loop: PropTypes.bool,\\n onStart: PropTypes.func,\\n onFinish: PropTypes.func,\\n run: PropTypes.bool,\\n })**\\n\\nA collection of parameters that determine if this component should animate. For more information on animated components please see our [Animation](doc:animation) Guide.\",\n \"8-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 \"9-1\": \"**PropTypes.bool**\\n\\nSet to true to mute the video. This is set to false by default.\",\n \"17-1\": \"**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 \"19-1\": \"**PropTypes.func**\\n\\nCalled when the user hovers on or off the control.\\n\\nFor example:\\n``` \\n_onHover(isHovering, position, 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 \"27-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 \"28-1\": \"**PropTypes.bool**\\n\\nSet to true to pause the video. This is set to false by default.\",\n \"30-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the video in 3D world space, specified as [x, y, z].\",\n \"31-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 \"33-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 \"37-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 \"39-1\": \"**PropTypes.bool**\\n\\nFalse if the video should be hidden. By default the video is visible and this value is true.\",\n \"41-0\": \"**width**\",\n \"41-1\": \"**PropTypes.number**\\n\\nThe width of the video in 3D space. Default value is 1.\",\n \"7-0\": \"**loop**\",\n \"7-1\": \"**PropTypes.bool**\\n\\nSet to true to loop the video. This is set to false by default.\",\n \"12-0\": \"**onClick**\",\n \"12-1\": \"**PropTypes.func**\\n\\nCalled when an object has been clicked.\\n\\nExample code:\\n``` \\n_onClick(position, source) {\\n // user has clicked the object\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n \"13-0\": \"**onClickState**\",\n \"13-1\": \"**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, position, 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 \"15-1\": \"**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 \"15-0\": \"**onDrag**\",\n \"22-0\": \"**onScroll**\",\n \"23-0\": \"**onSwipe**\",\n \"24-0\": \"**onTouch**\",\n \"22-1\": \"**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 \"23-1\": \"**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 \"24-1\": \"**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 \"26-0\": \"**onUpdateTime**\",\n \"26-1\": \"**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 \"16-0\": \"**onError**\",\n \"16-1\": \"**PropTypes.func**\\n\\nCallback invoked when the Video fails to load. The error message is contained in event.nativeEvent.error\",\n \"36-1\": \"**PropTypes.oneOf(['leftRight', 'rightLeft', 'topBottom', 'bottomTop', 'none'])**\\n\\nSpecifies the alignment mode of the provided stereo video in source. The video will be rendered in the given order, the first being the left eye, the next the right eye.\\n\\nFor example, leftRight will render the left half of the video to the left eye, and the right half of the video to the right eye. Similarly, topBottom will render the top half of the video to the left eye, and the bottom half of the video to the right eye. \\n\\nDefaults to none.\",\n \"36-0\": \"**stereoMode**\",\n \"18-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 \"18-0\": \"**onFuse**\",\n \"34-0\": \"**scalePivot**\",\n \"32-0\": \"**rotationPivot**\",\n \"3-0\": \"**height**\",\n \"3-1\": \"**PropTypes.number**\\n\\nThe height of the video in 3D space. Default value is 1.\",\n \"6-0\": \"**lightReceivingBitMask**\",\n \"35-0\": \"**shadowCastingBitMask**\",\n \"25-0\": \"**onTransformUpdate**\",\n \"5-0\": \"**ignoreEventHandling**\",\n \"2-0\": \"**dragType**\",\n \"20-0\": \"**onPinch**\",\n \"21-0\": \"**onRotate**\",\n \"11-0\": \"**onBufferStart**\",\n \"10-0\": \"**onBufferEnd**\",\n \"29-0\": \"**physicsBody**\",\n \"38-0\": \"**viroTag**\",\n \"40-0\": \"**volume**\",\n \"40-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 \"14-0\": \"**onCollision**\",\n \"2-1\": \"**PropTypes.oneOf([\\\"FixedDistance\\\", \\\"FixedToWorld\\\"])**\\n\\nDetermines the behavior of drag if **onDrag** is specified.\\n\\n|Value|Description|\\n|:------|:----------:|\\n|FixedDistance| Dragging is limited to a fixed radius around the user, dragged from the point at which the user has grabbed the geometry containing this draggable node|\\n|FixedDistanceOrigin| Dragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space.|\\n|FixedToWorld| Dragging is based on intersection with real world objects. **Available only in AR** |\\n|FixedToPlane| Dragging is limited to a fixed plane around the user. The configuration of this plane is defined by the **dragPlane** property.|\\n\\nThe default value is \\\"FixedDistance\\\".\",\n \"5-1\": \"**PropTypes.bool**\\n\\nWhen set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.\\n\\nThe default value is false.\",\n \"6-1\": \"**PropTypes.number**\\n\\nA bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then the light will illuminate this object. For more information please see the [Lighting and Materials](doc:3d-scene-lighting) Guide.\",\n \"20-1\": \"**PropTypes.func**\\n\\nCalled when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points. \\n\\nFor example:\\n```\\n _onPinch(pinchState, scaleFactor, source) {\\n if(pinchState == 3) {\\n // update scale of obj by multiplying by scaleFactor when pinch ends.\\n return;\\n }\\n //set scale using native props to reflect pinch.\\n }\\n```\\npinchState can be the following values:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Pinch Start: Triggered when the user has started a pinch gesture.|\\n|2| Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers. |\\n|3| Pinch End: When the user has finishes the pinch gesture and released both touch points. |\\n\\n**This event is only available in AR**\",\n \"21-1\": \"**PropTypes.func**\\n\\nCalled when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees.\\n\\nWhen setting rotation, the rotation should be relative to it's current rotation, *not* set to the absolute value of the given rotationFactor.\\n\\nFor example:\\n\\n```\\n _onRotate(rotateState, rotationFactor, source) {\\n\\n if (rotateState == 3) {\\n //set to current rotation - rotationFactor.\\n return;\\n }\\n //update rotation using setNativeProps\\n },\\n\\n```\\nrotationFactor can be the following values:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Rotation Start: Triggered when the user has started a rotation gesture.|\\n|2| Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers. |\\n|3| Rotation End: When the user has finishes the rotation gesture and released both touch points. |\\n\\n**This event is only available in AR**.\",\n \"32-1\": \"**PropTypes.arrayOf(PropTypes.number) **\\n\\nCartesian position in [x,y,z] about which rotation is applied relative to the component's position.\",\n \"34-1\": \"**PropTypes.arrayOf(PropTypes.number) **\\n\\nCartesian position in [x,y,z] from which scale is applied relative to the component's position.\",\n \"35-1\": \"**PropTypes.number**\\n\\nA bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then this object will cast shadows from the light. For more information please see the [Lighting and Materials](doc:3d-scene-lighting) Guide.\",\n \"10-1\": \"**PropTypes.func**\\n\\nCallback invoked when the underlying video component has finished buffering.\",\n \"11-1\": \"**PropTypes.func**\\n\\nCallback invoked when video begins buffering. Called at least once at the beginning of playback/video creation.\",\n \"14-1\": \"**React.PropTypes.func**\\n\\nCalled when this component's physics body collides with another component's physics body. Also invoked by [ViroScene](doc:viroscene)/[ViroARScene](doc:viroarscene)'s `findCollisions...` functions.\\n\\n|Return Value | Description |\\n|---|---|\\n|viroTag | the given viroTag (string) of the collided component |\\n|collidedPoint | an array of numbers representing the position, in world coordinates, of the point of collision|\\n|collidedNormal | an array representing the normal of the collision in world coordinates. |\",\n \"25-1\": \"**PropTypes.func**\\n\\nA function that is invoked when the component moves and provides an array of numbers representing the component's position in world coordinates.\",\n \"29-1\": \"**PropTypes.shape({..[physics.api](http://docs.viromedia.com/docs/physics#physicsbody-api)..}),**\\n\\nCreates and binds a physics body that is configured with the provided collection of physics properties associated with this control.\\n\\nFor more information on physics components, please see the [physics.api](http://docs.viromedia.com/docs/physics#physicsbody-api).\",\n \"38-1\": \"**PropTypes.string**\\n\\nA tag given to other components when their physics body collides with this component's physics body. Refer to [physics](doc:physics) for more information.\",\n \"1-1\": \"**PropTypes.shape({\\n planePoint:PropTypes.arrayOf(PropTypes.number),\\n planeNormal:PropTypes.arrayOf(PropTypes.number), \\n maxDistance:PropTypes.number\\n})**\\n\\n\\nWhen a drag type of \\\"FixedToPlane\\\" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity).\",\n \"1-0\": \"**dragPlane**\",\n \"4-0\": \"**highAccuracyEvents**\",\n \"4-1\": \"**PropTypes.bool**\\n\\nTrue if events should use the geometry of the object to determine if the user is interacting with this object. If false, the object's axis-aligned bounding box will be used instead. Enabling this is more accurate but takes more processing power, so it is set to false by default.\",\n \"42-1\": \"**PropTypes.number**\\n\\nThis determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0.\",\n \"42-0\": \"**renderingOrder**\"\n },\n \"cols\": 2,\n \"rows\": 43\n}\n[/block]\n\n[block:api-header]\n{\n \"title\": \"Methods\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"async getBoundingBoxAsync()\",\n \"0-0\": \"[Async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function that returns the component's bounding box in world coordinates.\\n\\nReturns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that will be completed with the following object:\\n\\n```\\n{\\n `boundingBox` : {\\n `minX` : number,\\n `maxX` : number, \\n `minY` : number,\\n `maxY` : number,\\n `minZ` : number,\\n `maxZ` : number\\n }\\n}\\n```\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"seekToTime(timeInSeconds: number)\",\n \"0-0\": \"Sets the video to the specified time in seconds. \\n\\n|Parameters | Description | \\n| ------------- |:------------- |\\n|timeInSeconds | Number of seconds into video to seek to. |\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"async getTransformAsync()\",\n \"0-0\": \"[Async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function that returns the component's transform (position, scale and rotation).\\n\\n|Return value | Description|\\n|---|---|\\n| transform | an object that contains \\\"position\\\", \\\"scale\\\" and \\\"rotation\\\" keys which point to number arrays |\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"applyImpulse(force: arrayOf(number), position: arrayOf(number))\",\n \"0-0\": \"A function used with [physics](doc:physics) to apply an impulse (instantaneous) force to an object with a physics body.\\n\\n|Parameter|Description|\\n|---|---|\\n|force |an array of magnitudes to be applied as force (N) to the object in the positive x, y and z directions|\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"applyTorqueImpulse(torque: arrayOf(number), position: arrayOf(number))\",\n \"0-0\": \"A function used with [physics](doc:physics) to apply an impulse (instantaneous) torque to an object with a physics body.\\n\\n|Parameter|Description|\\n|---|---|\\n|torque |an array of magnitudes to be applied as a torque (N * m) to the object in the positive x, y and z directions at the given position|\\n|position | a position relative to the object from which to apply the given torque|\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"setVelocity(velocity: arrayOf(number))\",\n \"0-0\": \"A function used with [physics](doc:physics) to set the velocity of an object with a physics body.\\n\\n|Parameter|Description|\\n|---|---|\\n|velocity | an array of numbers corresponding to x, y, and z velocity |\"\n },\n \"cols\": 1,\n \"rows\": 1\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"setNativeProps(nativeProps: object)\",\n \"0-0\": \"A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on [Direct Manipulation](https://facebook.github.io/react-native/docs/direct-manipulation.html) for more information.\\n\\n|Parameter|Description|\\n|---|---|\\n|nativeProps | an object where the keys are the properties to set and the values are the values to set |\\n\\nFor example, setting position natively would look like this:\\n\\n```\\ncomponentRef.setNativeProps({\\n position : [0, 0, -1]\\n});\\n```\"\n },\n \"cols\": 1,\n \"rows\": 1\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: [block:code] { "codes": [ { "code": "<ViroVideo\n source={require('./video/myvid.mp4')}\n loop={true}\n position={[0,2,-5]}\n scale={[2, 2, 0]}\n />", "language": "javascript" } ] } [/block] [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": "**animation**", "8-0": "**materials**", "9-0": "**muted**", "17-0": "**onFinish**", "19-0": "**onHover**", "27-0": "**opacity**", "28-0": "**paused**", "30-0": "**position**", "31-0": "**rotation**", "33-0": "**scale**", "37-0": "**transformBehaviors**", "39-0": "**visible**", "h-0": "PropKey", "h-1": "PropType", "0-1": "**PropTypes.shape({\n name: PropTypes.string,\n delay: PropTypes.number,\n loop: PropTypes.bool,\n onStart: PropTypes.func,\n onFinish: PropTypes.func,\n run: PropTypes.bool,\n })**\n\nA collection of parameters that determine if this component should animate. For more information on animated components please see our [Animation](doc:animation) Guide.", "8-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.", "9-1": "**PropTypes.bool**\n\nSet to true to mute the video. This is set to false by default.", "17-1": "**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.", "19-1": "**PropTypes.func**\n\nCalled when the user hovers on or off the control.\n\nFor example:\n``` \n_onHover(isHovering, position, 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.", "27-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.", "28-1": "**PropTypes.bool**\n\nSet to true to pause the video. This is set to false by default.", "30-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the video in 3D world space, specified as [x, y, z].", "31-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.", "33-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.", "37-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|", "39-1": "**PropTypes.bool**\n\nFalse if the video should be hidden. By default the video is visible and this value is true.", "41-0": "**width**", "41-1": "**PropTypes.number**\n\nThe width of the video in 3D space. Default value is 1.", "7-0": "**loop**", "7-1": "**PropTypes.bool**\n\nSet to true to loop the video. This is set to false by default.", "12-0": "**onClick**", "12-1": "**PropTypes.func**\n\nCalled when an object has been clicked.\n\nExample code:\n``` \n_onClick(position, source) {\n // user has clicked the object\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "13-0": "**onClickState**", "13-1": "**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, position, 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.", "15-1": "**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", "15-0": "**onDrag**", "22-0": "**onScroll**", "23-0": "**onSwipe**", "24-0": "**onTouch**", "22-1": "**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)", "23-1": "**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)", "24-1": "**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).", "26-0": "**onUpdateTime**", "26-1": "**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```", "16-0": "**onError**", "16-1": "**PropTypes.func**\n\nCallback invoked when the Video fails to load. The error message is contained in event.nativeEvent.error", "36-1": "**PropTypes.oneOf(['leftRight', 'rightLeft', 'topBottom', 'bottomTop', 'none'])**\n\nSpecifies the alignment mode of the provided stereo video in source. The video will be rendered in the given order, the first being the left eye, the next the right eye.\n\nFor example, leftRight will render the left half of the video to the left eye, and the right half of the video to the right eye. Similarly, topBottom will render the top half of the video to the left eye, and the bottom half of the video to the right eye. \n\nDefaults to none.", "36-0": "**stereoMode**", "18-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.", "18-0": "**onFuse**", "34-0": "**scalePivot**", "32-0": "**rotationPivot**", "3-0": "**height**", "3-1": "**PropTypes.number**\n\nThe height of the video in 3D space. Default value is 1.", "6-0": "**lightReceivingBitMask**", "35-0": "**shadowCastingBitMask**", "25-0": "**onTransformUpdate**", "5-0": "**ignoreEventHandling**", "2-0": "**dragType**", "20-0": "**onPinch**", "21-0": "**onRotate**", "11-0": "**onBufferStart**", "10-0": "**onBufferEnd**", "29-0": "**physicsBody**", "38-0": "**viroTag**", "40-0": "**volume**", "40-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.", "14-0": "**onCollision**", "2-1": "**PropTypes.oneOf([\"FixedDistance\", \"FixedToWorld\"])**\n\nDetermines the behavior of drag if **onDrag** is specified.\n\n|Value|Description|\n|:------|:----------:|\n|FixedDistance| Dragging is limited to a fixed radius around the user, dragged from the point at which the user has grabbed the geometry containing this draggable node|\n|FixedDistanceOrigin| Dragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space.|\n|FixedToWorld| Dragging is based on intersection with real world objects. **Available only in AR** |\n|FixedToPlane| Dragging is limited to a fixed plane around the user. The configuration of this plane is defined by the **dragPlane** property.|\n\nThe default value is \"FixedDistance\".", "5-1": "**PropTypes.bool**\n\nWhen set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.\n\nThe default value is false.", "6-1": "**PropTypes.number**\n\nA bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then the light will illuminate this object. For more information please see the [Lighting and Materials](doc:3d-scene-lighting) Guide.", "20-1": "**PropTypes.func**\n\nCalled when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points. \n\nFor example:\n```\n _onPinch(pinchState, scaleFactor, source) {\n if(pinchState == 3) {\n // update scale of obj by multiplying by scaleFactor when pinch ends.\n return;\n }\n //set scale using native props to reflect pinch.\n }\n```\npinchState can be the following values:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Pinch Start: Triggered when the user has started a pinch gesture.|\n|2| Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers. |\n|3| Pinch End: When the user has finishes the pinch gesture and released both touch points. |\n\n**This event is only available in AR**", "21-1": "**PropTypes.func**\n\nCalled when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees.\n\nWhen setting rotation, the rotation should be relative to it's current rotation, *not* set to the absolute value of the given rotationFactor.\n\nFor example:\n\n```\n _onRotate(rotateState, rotationFactor, source) {\n\n if (rotateState == 3) {\n //set to current rotation - rotationFactor.\n return;\n }\n //update rotation using setNativeProps\n },\n\n```\nrotationFactor can be the following values:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Rotation Start: Triggered when the user has started a rotation gesture.|\n|2| Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers. |\n|3| Rotation End: When the user has finishes the rotation gesture and released both touch points. |\n\n**This event is only available in AR**.", "32-1": "**PropTypes.arrayOf(PropTypes.number) **\n\nCartesian position in [x,y,z] about which rotation is applied relative to the component's position.", "34-1": "**PropTypes.arrayOf(PropTypes.number) **\n\nCartesian position in [x,y,z] from which scale is applied relative to the component's position.", "35-1": "**PropTypes.number**\n\nA bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then this object will cast shadows from the light. For more information please see the [Lighting and Materials](doc:3d-scene-lighting) Guide.", "10-1": "**PropTypes.func**\n\nCallback invoked when the underlying video component has finished buffering.", "11-1": "**PropTypes.func**\n\nCallback invoked when video begins buffering. Called at least once at the beginning of playback/video creation.", "14-1": "**React.PropTypes.func**\n\nCalled when this component's physics body collides with another component's physics body. Also invoked by [ViroScene](doc:viroscene)/[ViroARScene](doc:viroarscene)'s `findCollisions...` functions.\n\n|Return Value | Description |\n|---|---|\n|viroTag | the given viroTag (string) of the collided component |\n|collidedPoint | an array of numbers representing the position, in world coordinates, of the point of collision|\n|collidedNormal | an array representing the normal of the collision in world coordinates. |", "25-1": "**PropTypes.func**\n\nA function that is invoked when the component moves and provides an array of numbers representing the component's position in world coordinates.", "29-1": "**PropTypes.shape({..[physics.api](http://docs.viromedia.com/docs/physics#physicsbody-api)..}),**\n\nCreates and binds a physics body that is configured with the provided collection of physics properties associated with this control.\n\nFor more information on physics components, please see the [physics.api](http://docs.viromedia.com/docs/physics#physicsbody-api).", "38-1": "**PropTypes.string**\n\nA tag given to other components when their physics body collides with this component's physics body. Refer to [physics](doc:physics) for more information.", "1-1": "**PropTypes.shape({\n planePoint:PropTypes.arrayOf(PropTypes.number),\n planeNormal:PropTypes.arrayOf(PropTypes.number), \n maxDistance:PropTypes.number\n})**\n\n\nWhen a drag type of \"FixedToPlane\" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity).", "1-0": "**dragPlane**", "4-0": "**highAccuracyEvents**", "4-1": "**PropTypes.bool**\n\nTrue if events should use the geometry of the object to determine if the user is interacting with this object. If false, the object's axis-aligned bounding box will be used instead. Enabling this is more accurate but takes more processing power, so it is set to false by default.", "42-1": "**PropTypes.number**\n\nThis determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0.", "42-0": "**renderingOrder**" }, "cols": 2, "rows": 43 } [/block] [block:api-header] { "title": "Methods" } [/block] [block:parameters] { "data": { "h-0": "async getBoundingBoxAsync()", "0-0": "[Async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function that returns the component's bounding box in world coordinates.\n\nReturns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that will be completed with the following object:\n\n```\n{\n `boundingBox` : {\n `minX` : number,\n `maxX` : number, \n `minY` : number,\n `maxY` : number,\n `minZ` : number,\n `maxZ` : number\n }\n}\n```" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "seekToTime(timeInSeconds: number)", "0-0": "Sets the video to the specified time in seconds. \n\n|Parameters | Description | \n| ------------- |:------------- |\n|timeInSeconds | Number of seconds into video to seek to. |" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "async getTransformAsync()", "0-0": "[Async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function that returns the component's transform (position, scale and rotation).\n\n|Return value | Description|\n|---|---|\n| transform | an object that contains \"position\", \"scale\" and \"rotation\" keys which point to number arrays |" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "applyImpulse(force: arrayOf(number), position: arrayOf(number))", "0-0": "A function used with [physics](doc:physics) to apply an impulse (instantaneous) force to an object with a physics body.\n\n|Parameter|Description|\n|---|---|\n|force |an array of magnitudes to be applied as force (N) to the object in the positive x, y and z directions|" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "applyTorqueImpulse(torque: arrayOf(number), position: arrayOf(number))", "0-0": "A function used with [physics](doc:physics) to apply an impulse (instantaneous) torque to an object with a physics body.\n\n|Parameter|Description|\n|---|---|\n|torque |an array of magnitudes to be applied as a torque (N * m) to the object in the positive x, y and z directions at the given position|\n|position | a position relative to the object from which to apply the given torque|" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "setVelocity(velocity: arrayOf(number))", "0-0": "A function used with [physics](doc:physics) to set the velocity of an object with a physics body.\n\n|Parameter|Description|\n|---|---|\n|velocity | an array of numbers corresponding to x, y, and z velocity |" }, "cols": 1, "rows": 1 } [/block] [block:parameters] { "data": { "h-0": "setNativeProps(nativeProps: object)", "0-0": "A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on [Direct Manipulation](https://facebook.github.io/react-native/docs/direct-manipulation.html) for more information.\n\n|Parameter|Description|\n|---|---|\n|nativeProps | an object where the keys are the properties to set and the values are the values to set |\n\nFor example, setting position natively would look like this:\n\n```\ncomponentRef.setNativeProps({\n position : [0, 0, -1]\n});\n```" }, "cols": 1, "rows": 1 } [/block]

ViroReact

Getting Started

iOS - Platform Setup

Android - Platform Setup

Basics

Augmented Reality

Enhanced Scenes

Design

Other

API Reference