@realsee/vreo 0.2.0-alpha.13 → 0.2.0-alpha.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +13 -2
  2. package/docs/assets/search.js +1 -1
  3. package/docs/classes/Player.AudioLike.html +2 -2
  4. package/docs/classes/Player.Controller.html +3 -3
  5. package/docs/classes/Player.Player-1.html +3 -3
  6. package/docs/classes/Player.VideoAgentMesh.html +11 -11
  7. package/docs/classes/Player.VideoAgentScene.html +1 -1
  8. package/docs/demo/assets/{AppReact.388465e9.js → AppReact.2978a2aa.js} +1 -1
  9. package/docs/demo/assets/default.0c3b245d.js +64 -0
  10. package/docs/demo/assets/{default.0350c336.css → default.70243c83.css} +1 -1
  11. package/docs/demo/assets/dynamic.37c058ac.js +1 -0
  12. package/docs/demo/assets/{examples.02abaf01.js → examples.4104efd4.js} +2 -2
  13. package/docs/demo/assets/{index.485f13f7.js → index.863d264e.js} +1 -1
  14. package/docs/demo/assets/{main.0b6b41ab.js → main.f8c52f62.js} +1 -1
  15. package/docs/demo/assets/{react.b14dadc7.js → react.98c8f46f.js} +2 -2
  16. package/docs/demo/assets/{vendor.d3e0753c.js → vendor.f4c5cb32.js} +67 -68
  17. package/docs/demo/examples.html +4 -4
  18. package/docs/demo/index-react-dynamic.html +6 -6
  19. package/docs/demo/index-react.html +6 -6
  20. package/docs/demo/index.html +5 -5
  21. package/docs/enums/Player.InfoPanelStyleEnum.html +1 -1
  22. package/docs/enums/Player.InfoPanelTypeEnum.html +1 -1
  23. package/docs/enums/Player.PanoEffectEnum.html +1 -1
  24. package/docs/enums/Player.PanoTagEnum.html +1 -1
  25. package/docs/enums/Player.PanoTagStyleEnum.html +2 -2
  26. package/docs/enums/Player.VreoKeyframeEnum.html +12 -12
  27. package/docs/enums/fivePlugins.CameraMovementEffect.html +1 -1
  28. package/docs/enums/fivePlugins.Rotation.html +1 -1
  29. package/docs/index.html +10 -3
  30. package/docs/interfaces/Player.CustomVreoKeyframeProps.html +1 -1
  31. package/docs/interfaces/Player.PlayerConfigs.html +2 -2
  32. package/docs/interfaces/Player.Vertex.html +1 -1
  33. package/docs/interfaces/Player.VideoAgentMeshOptions.html +8 -1
  34. package/docs/interfaces/Player.VreoKeyframe.html +1 -1
  35. package/docs/interfaces/Player.VreoUnit.html +1 -1
  36. package/docs/interfaces/Player.VreoVideo.html +1 -1
  37. package/docs/interfaces/fivePlugins.CSS3DRenderPluginExportType.html +4 -0
  38. package/docs/interfaces/fivePlugins.CameraMovementOptsCallback.html +1 -1
  39. package/docs/interfaces/fivePlugins.CameraMovementPluginExportType.html +2 -2
  40. package/docs/interfaces/fivePlugins.ModelTVVideoPluginData.html +1 -1
  41. package/docs/interfaces/fivePlugins.ModelTVVideoPluginExportType.html +1 -1
  42. package/docs/interfaces/fivePlugins.ModelTVVideoPluginParameterType.html +1 -1
  43. package/docs/interfaces/fivePlugins.Vector3Position.html +3 -0
  44. package/docs/interfaces/react.VreoActionCallbacks.html +6 -6
  45. package/docs/interfaces/react.VreoProviderProps.html +1 -1
  46. package/docs/modules/Player.html +17 -15
  47. package/docs/modules/custom.html +1 -1
  48. package/docs/modules/fivePlugins.html +5 -2
  49. package/docs/modules/react.html +1 -1
  50. package/lib/Player/custom/SpatialScenePanel/index.js +2 -2
  51. package/lib/Player/modules/VideoAgent/VideoAgentMesh.d.ts +12 -0
  52. package/lib/Player/modules/VideoAgent/VideoAgentMesh.js +26 -10
  53. package/lib/Player/modules/VideoAgent/VideoAgentScene.d.ts +1 -0
  54. package/lib/Player/modules/VideoAgent/VideoAgentScene.js +1 -2
  55. package/lib/Player/modules/keyframes/PanoTextLabel/index.d.ts +3 -0
  56. package/lib/Player/modules/keyframes/PanoTextLabel/index.js +96 -43
  57. package/lib/fivePlugins/CSS3DRenderPlugin/centerPoint.d.ts +2 -0
  58. package/lib/fivePlugins/CSS3DRenderPlugin/centerPoint.js +12 -0
  59. package/lib/fivePlugins/CSS3DRenderPlugin/createResizeObserver.d.ts +7 -0
  60. package/lib/fivePlugins/CSS3DRenderPlugin/createResizeObserver.js +32 -0
  61. package/lib/fivePlugins/CSS3DRenderPlugin/evenNumber.d.ts +3 -0
  62. package/lib/fivePlugins/CSS3DRenderPlugin/evenNumber.js +11 -0
  63. package/lib/fivePlugins/CSS3DRenderPlugin/index.d.ts +56 -0
  64. package/lib/fivePlugins/CSS3DRenderPlugin/index.js +275 -0
  65. package/lib/fivePlugins/CSS3DRenderPlugin/transformPositionToVector3.d.ts +7 -0
  66. package/lib/fivePlugins/CSS3DRenderPlugin/transformPositionToVector3.js +18 -0
  67. package/lib/typings/VreoUnit.d.ts +11 -0
  68. package/package.json +1 -1
  69. package/resources/Player/custom/SpatialScenePanel/index.tsx +4 -4
  70. package/resources/Player/index.tsx +1 -1
  71. package/resources/Player/modules/VideoAgent/VideoAgentMesh.ts +17 -2
  72. package/resources/Player/modules/VideoAgent/VideoAgentScene.ts +2 -4
  73. package/resources/Player/modules/keyframes/PanoTextLabel/index.tsx +87 -34
  74. package/resources/fivePlugins/CSS3DRenderPlugin/centerPoint.ts +5 -0
  75. package/resources/fivePlugins/CSS3DRenderPlugin/createResizeObserver.ts +17 -0
  76. package/resources/fivePlugins/CSS3DRenderPlugin/evenNumber.ts +4 -0
  77. package/resources/fivePlugins/CSS3DRenderPlugin/index.ts +254 -0
  78. package/resources/fivePlugins/CSS3DRenderPlugin/transformPositionToVector3.ts +5 -0
  79. package/resources/typings/VreoUnit.ts +13 -1
  80. package/stylesheets/default.css +5 -1
  81. package/docs/demo/assets/default.f03f1cdd.js +0 -64
  82. package/docs/demo/assets/dynamic.3f7479e4.js +0 -1
package/docs/modules/fivePlugins.html CHANGED
@@ -1,3 +1,6 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>fivePlugins | Vreo</title><meta name="description" content="Documentation for Vreo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Vreo</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Vreo</a></li><li><a href="fivePlugins.html">fivePlugins</a></li></ul><h1>Module fivePlugins</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.CameraMovementEffect.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Effect</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.Rotation.html" class="tsd-kind-icon">Rotation</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Opts<wbr/>Callback</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginData.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveArgs" class="tsd-kind-icon">Move<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveOpts" class="tsd-kind-icon">Move<wbr/>Opts</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateArgs" class="tsd-kind-icon">Rotate<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateOpts" class="tsd-kind-icon">Rotate<wbr/>Opts</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CameraMovementPlugin" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#ModelTVVideoPlugin" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="MoveArgs" class="tsd-anchor"></a><h3>Move<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Move<wbr/>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mode</span><span class="tsd-signature-symbol">; </span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transEffect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;fly&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fade&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;instant&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Pose</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L39">resources/fivePlugins/CameraMovementPlugin/typings.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="MoveOpts" class="tsd-anchor"></a><h3>Move<wbr/>Opts</h3><div class="tsd-signature tsd-kind-icon">Move<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementOptsCallback</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L45">resources/fivePlugins/CameraMovementPlugin/typings.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RotateArgs" class="tsd-anchor"></a><h3>Rotate<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Rotate<wbr/>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>loop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Mode</span><span class="tsd-signature-symbol">; </span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotateSpeed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotation<span class="tsd-signature-symbol">: </span><a href="../enums/fivePlugins.Rotation.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Rotation</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Pose</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L49">resources/fivePlugins/CameraMovementPlugin/typings.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RotateOpts" class="tsd-anchor"></a><h3>Rotate<wbr/>Opts</h3><div class="tsd-signature tsd-kind-icon">Rotate<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementOptsCallback</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L57">resources/fivePlugins/CameraMovementPlugin/typings.ts:57</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="CameraMovementPlugin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> Camera<wbr/>Movement<wbr/>Plugin</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<span class="tsd-signature-symbol">(</span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Five</span>, parameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginExportType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/CameraMovementPlugin/index.ts#L50">resources/fivePlugins/CameraMovementPlugin/index.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>fivePlugins | Vreo</title><meta name="description" content="Documentation for Vreo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Vreo</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Vreo</a></li><li><a href="fivePlugins.html">fivePlugins</a></li></ul><h1>Module fivePlugins</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.CameraMovementEffect.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Effect</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.Rotation.html" class="tsd-kind-icon">Rotation</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CSS3DRenderPluginExportType.html" class="tsd-kind-icon">CSS3DRender<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Opts<wbr/>Callback</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginData.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.Vector3Position.html" class="tsd-kind-icon">Vector3<wbr/>Position</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveArgs" class="tsd-kind-icon">Move<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveOpts" class="tsd-kind-icon">Move<wbr/>Opts</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateArgs" class="tsd-kind-icon">Rotate<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateOpts" class="tsd-kind-icon">Rotate<wbr/>Opts</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CSS3DRenderPlugin" class="tsd-kind-icon">CSS3DRender<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CameraMovementPlugin" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#ModelTVVideoPlugin" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="MoveArgs" class="tsd-anchor"></a><h3>Move<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Move<wbr/>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mode</span><span class="tsd-signature-symbol">; </span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transEffect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;fly&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fade&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;instant&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Pose</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CameraMovementPlugin/typings.ts#L39">resources/fivePlugins/CameraMovementPlugin/typings.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="MoveOpts" class="tsd-anchor"></a><h3>Move<wbr/>Opts</h3><div class="tsd-signature tsd-kind-icon">Move<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementOptsCallback</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CameraMovementPlugin/typings.ts#L45">resources/fivePlugins/CameraMovementPlugin/typings.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RotateArgs" class="tsd-anchor"></a><h3>Rotate<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Rotate<wbr/>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>loop<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>mode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Mode</span><span class="tsd-signature-symbol">; </span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotateSpeed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotation<span class="tsd-signature-symbol">: </span><a href="../enums/fivePlugins.Rotation.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Rotation</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Pose</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CameraMovementPlugin/typings.ts#L49">resources/fivePlugins/CameraMovementPlugin/typings.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RotateOpts" class="tsd-anchor"></a><h3>Rotate<wbr/>Opts</h3><div class="tsd-signature tsd-kind-icon">Rotate<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementOptsCallback</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CameraMovementPlugin/typings.ts#L57">resources/fivePlugins/CameraMovementPlugin/typings.ts:57</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="CSS3DRenderPlugin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> CSS3DRender<wbr/>Plugin</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">CSS3DRender<wbr/>Plugin<span class="tsd-signature-symbol">(</span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Five</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.CSS3DRenderPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CSS3DRenderPluginExportType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CSS3DRenderPlugin/index.ts#L68">resources/fivePlugins/CSS3DRenderPlugin/index.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p><strong>CSS3DRenderPlugin</strong> 提供矩形区域（三维空间四个坐标点），你可以在此矩形区域中渲染 DOM 内容。
3
+ 实现原理参考<a href="https://threejs.org/docs/index.html?q=CSS3D#examples/en/renderers/CSS3DRenderer">CSS3DRenderer</a>。</p>
4
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>five: <span class="tsd-signature-type">Five</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/fivePlugins.CSS3DRenderPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CSS3DRenderPluginExportType</a></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="CameraMovementPlugin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> Camera<wbr/>Movement<wbr/>Plugin</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<span class="tsd-signature-symbol">(</span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Five</span>, parameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginExportType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/CameraMovementPlugin/index.ts#L50">resources/fivePlugins/CameraMovementPlugin/index.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
5
  <p><strong>运镜插件</strong> 模拟类似于电影运镜效果。</p>
3
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>five: <span class="tsd-signature-type">Five</span></h5></li><li><h5>parameters: <a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginParameterType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginExportType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="ModelTVVideoPlugin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> ModelTVVideo<wbr/>Plugin</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">ModelTVVideo<wbr/>Plugin<span class="tsd-signature-symbol">(</span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Five</span>, parameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginExportType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/fivePlugins/ModelTVVideoPlugin/index.ts#L33">resources/fivePlugins/ModelTVVideoPlugin/index.ts:33</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>five: <span class="tsd-signature-type">Five</span></h5></li><li><h5>parameters: <a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginParameterType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginExportType</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="Player.html">Player</a></li><li class=" tsd-kind-module"><a href="custom.html">custom</a></li><li class="current tsd-kind-module"><a href="fivePlugins.html">five<wbr/>Plugins</a></li><li class=" tsd-kind-module"><a href="react.html">react</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.CameraMovementEffect.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Effect</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.Rotation.html" class="tsd-kind-icon">Rotation</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Opts<wbr/>Callback</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginData.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveArgs" class="tsd-kind-icon">Move<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveOpts" class="tsd-kind-icon">Move<wbr/>Opts</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateArgs" class="tsd-kind-icon">Rotate<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateOpts" class="tsd-kind-icon">Rotate<wbr/>Opts</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CameraMovementPlugin" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#ModelTVVideoPlugin" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
6
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>five: <span class="tsd-signature-type">Five</span></h5></li><li><h5>parameters: <a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginParameterType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">CameraMovementPluginExportType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="ModelTVVideoPlugin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> ModelTVVideo<wbr/>Plugin</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">ModelTVVideo<wbr/>Plugin<span class="tsd-signature-symbol">(</span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Five</span>, parameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginParameterType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginExportType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/fivePlugins/ModelTVVideoPlugin/index.ts#L33">resources/fivePlugins/ModelTVVideoPlugin/index.ts:33</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>five: <span class="tsd-signature-type">Five</span></h5></li><li><h5>parameters: <a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginParameterType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-signature-type" data-tsd-kind="Interface">ModelTVVideoPluginExportType</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="Player.html">Player</a></li><li class=" tsd-kind-module"><a href="custom.html">custom</a></li><li class="current tsd-kind-module"><a href="fivePlugins.html">five<wbr/>Plugins</a></li><li class=" tsd-kind-module"><a href="react.html">react</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.CameraMovementEffect.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Effect</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/fivePlugins.Rotation.html" class="tsd-kind-icon">Rotation</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CSS3DRenderPluginExportType.html" class="tsd-kind-icon">CSS3DRender<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementOptsCallback.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Opts<wbr/>Callback</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginExportType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.CameraMovementPluginParameterType.html" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginData.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginExportType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Export<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.ModelTVVideoPluginParameterType.html" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin<wbr/>Parameter<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/fivePlugins.Vector3Position.html" class="tsd-kind-icon">Vector3<wbr/>Position</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveArgs" class="tsd-kind-icon">Move<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#MoveOpts" class="tsd-kind-icon">Move<wbr/>Opts</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateArgs" class="tsd-kind-icon">Rotate<wbr/>Args</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="fivePlugins.html#RotateOpts" class="tsd-kind-icon">Rotate<wbr/>Opts</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CSS3DRenderPlugin" class="tsd-kind-icon">CSS3DRender<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#CameraMovementPlugin" class="tsd-kind-icon">Camera<wbr/>Movement<wbr/>Plugin</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="fivePlugins.html#ModelTVVideoPlugin" class="tsd-kind-icon">ModelTVVideo<wbr/>Plugin</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/modules/react.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>react | Vreo</title><meta name="description" content="Documentation for Vreo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Vreo</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Vreo</a></li><li><a href="react.html">react</a></li></ul><h1>Module react</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoActionCallbacks.html" class="tsd-kind-icon">Vreo<wbr/>Action<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoProviderProps.html" class="tsd-kind-icon">Vreo<wbr/>Provider<wbr/>Props</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#VreoProvider" class="tsd-kind-icon">Vreo<wbr/>Provider</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoAction" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useVreoEventCallback" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoPausedState" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="VreoProvider" class="tsd-anchor"></a><h3>Vreo<wbr/>Provider</h3><div class="tsd-signature tsd-kind-icon">Vreo<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.FC</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/react.VreoProviderProps.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoProviderProps</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/react/index.tsx#L13">resources/react/index.tsx:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useVreoAction" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Action</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/react/index.tsx#L76">resources/react/index.tsx:76</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vreoUnit: <a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> currentTime: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> currentTime: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="useVreoEventCallback" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Event<wbr/>Callback</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, callback<span class="tsd-signature-symbol">: </span><a href="Player.html#VreoKeyframeEvent" class="tsd-signature-type" data-tsd-kind="Type alias">VreoKeyframeEvent</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/react/index.tsx#L93">resources/react/index.tsx:93</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../enums/Player.VreoKeyframeEnum.html" class="tsd-signature-type" data-tsd-kind="Enumeration">VreoKeyframeEnum</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;paused&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;playing&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unknownKeyframeType&quot;</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>callback: <a href="Player.html#VreoKeyframeEvent" class="tsd-signature-type" data-tsd-kind="Type alias">VreoKeyframeEvent</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useVreoPausedState" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Paused<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/3ba6c8c/resources/react/index.tsx#L113">resources/react/index.tsx:113</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="Player.html">Player</a></li><li class=" tsd-kind-module"><a href="custom.html">custom</a></li><li class=" tsd-kind-module"><a href="fivePlugins.html">five<wbr/>Plugins</a></li><li class="current tsd-kind-module"><a href="react.html">react</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoActionCallbacks.html" class="tsd-kind-icon">Vreo<wbr/>Action<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoProviderProps.html" class="tsd-kind-icon">Vreo<wbr/>Provider<wbr/>Props</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#VreoProvider" class="tsd-kind-icon">Vreo<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoAction" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useVreoEventCallback" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoPausedState" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>react | Vreo</title><meta name="description" content="Documentation for Vreo"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Vreo</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Vreo</a></li><li><a href="react.html">react</a></li></ul><h1>Module react</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoActionCallbacks.html" class="tsd-kind-icon">Vreo<wbr/>Action<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoProviderProps.html" class="tsd-kind-icon">Vreo<wbr/>Provider<wbr/>Props</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#VreoProvider" class="tsd-kind-icon">Vreo<wbr/>Provider</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoAction" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useVreoEventCallback" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoPausedState" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="VreoProvider" class="tsd-anchor"></a><h3>Vreo<wbr/>Provider</h3><div class="tsd-signature tsd-kind-icon">Vreo<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.FC</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/react.VreoProviderProps.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoProviderProps</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/react/index.tsx#L13">resources/react/index.tsx:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useVreoAction" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Action</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/react/index.tsx#L76">resources/react/index.tsx:76</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>hide<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>load<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vreoUnit<span class="tsd-signature-symbol">: </span><a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a>, currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vreoUnit: <a href="../interfaces/Player.VreoUnit.html" class="tsd-signature-type" data-tsd-kind="Interface">VreoUnit</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> currentTime: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>pause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>play<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>currentTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> currentTime: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="useVreoEventCallback" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Event<wbr/>Callback</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, callback<span class="tsd-signature-symbol">: </span><a href="Player.html#VreoKeyframeEvent" class="tsd-signature-type" data-tsd-kind="Type alias">VreoKeyframeEvent</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/react/index.tsx#L93">resources/react/index.tsx:93</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../enums/Player.VreoKeyframeEnum.html" class="tsd-signature-type" data-tsd-kind="Enumeration">VreoKeyframeEnum</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;paused&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;playing&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unknownKeyframeType&quot;</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>callback: <a href="Player.html#VreoKeyframeEvent" class="tsd-signature-type" data-tsd-kind="Type alias">VreoKeyframeEvent</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useVreoPausedState" class="tsd-anchor"></a><h3>use<wbr/>Vreo<wbr/>Paused<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/07cb055/resources/react/index.tsx#L113">resources/react/index.tsx:113</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="Player.html">Player</a></li><li class=" tsd-kind-module"><a href="custom.html">custom</a></li><li class=" tsd-kind-module"><a href="fivePlugins.html">five<wbr/>Plugins</a></li><li class="current tsd-kind-module"><a href="react.html">react</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoActionCallbacks.html" class="tsd-kind-icon">Vreo<wbr/>Action<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.VreoProviderProps.html" class="tsd-kind-icon">Vreo<wbr/>Provider<wbr/>Props</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#VreoProvider" class="tsd-kind-icon">Vreo<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoAction" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useVreoEventCallback" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useVreoPausedState" class="tsd-kind-icon">use<wbr/>Vreo<wbr/>Paused<wbr/>State</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/lib/Player/custom/SpatialScenePanel/index.js CHANGED
@@ -13,9 +13,9 @@ var _reactDom = _interopRequireDefault(require("react-dom"));
13
13
 
14
14
  var _three = require("three");
15
15
 
16
- var _BetterTween = require("@realsee/dnalogel/shared-utils/animationFrame/BetterTween");
16
+ var _BetterTween = require("../../../shared-utils/animationFrame/BetterTween");
17
17
 
18
- var _CSS3DRenderPlugin = require("@realsee/dnalogel/plugins/CSS3DRenderPlugin");
18
+ var _CSS3DRenderPlugin = require("../../../fivePlugins/CSS3DRenderPlugin");
19
19
 
20
20
  var _VreoUnit = require("../../../typings/VreoUnit");
21
21
 
package/lib/Player/modules/VideoAgent/VideoAgentMesh.d.ts CHANGED
@@ -1,8 +1,20 @@
1
1
  import * as THREE from 'three';
2
2
  import AudioLike from '../../../shared-utils/AduioLike';
3
3
  export interface VideoAgentMeshOptions {
4
+ /**
5
+ * 自定义视频实例。
6
+ */
4
7
  videoInstance?: HTMLVideoElement;
8
+ /**
9
+ * 自定义音频实例。
10
+ */
5
11
  audioInstance?: HTMLAudioElement;
12
+ /**
13
+ * 是否开启音视频预载能力。
14
+ *
15
+ * @description 开启预载能力后会通过 `Fetch/XHR` 方式将音视频文件下载下载转成二进制 [`Blob`](https://developer.mozilla.org/zh-CN/docs/Web/API/Blob) 提供给多媒体实例。这样的好处是 **能够保障音视频播放过程中不卡顿**。 但在部分 iOS 系统中会存在兼容问题——播 25s 之后会静音（`muted` 为 `false`，但是没有声音）。
16
+ */
17
+ preload?: boolean;
6
18
  }
7
19
  /**
8
20
  * 视频经纪人MESH
package/lib/Player/modules/VideoAgent/VideoAgentMesh.js CHANGED
@@ -74,7 +74,9 @@ var VideoAgentMesh = /*#__PURE__*/function (_THREE$Mesh) {
74
74
 
75
75
  var _this;
76
76
 
77
- var options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
77
+ var options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {
78
+ preload: true
79
+ };
78
80
 
79
81
  _classCallCheck(this, VideoAgentMesh);
80
82
 
@@ -225,17 +227,31 @@ var VideoAgentMesh = /*#__PURE__*/function (_THREE$Mesh) {
225
227
  case 6:
226
228
  uniforms = this.material.uniforms;
227
229
  this.videoInstance.muted = true;
228
- _context.t0 = URL;
229
- _context.next = 11;
230
+
231
+ if (!this.options.preload) {
232
+ _context.next = 18;
233
+ break;
234
+ }
235
+
236
+ _context.t1 = URL;
237
+ _context.next = 12;
230
238
  return _Preloader.Preloader.blob(this.videoUrl);
231
239
 
232
- case 11:
233
- _context.t1 = _context.sent;
234
- _context.next = 14;
235
- return _context.t0.createObjectURL.call(_context.t0, _context.t1);
240
+ case 12:
241
+ _context.t2 = _context.sent;
242
+ _context.next = 15;
243
+ return _context.t1.createObjectURL.call(_context.t1, _context.t2);
236
244
 
237
- case 14:
238
- this.videoInstance.src = _context.sent;
245
+ case 15:
246
+ _context.t0 = _context.sent;
247
+ _context.next = 19;
248
+ break;
249
+
250
+ case 18:
251
+ _context.t0 = this.videoUrl;
252
+
253
+ case 19:
254
+ this.videoInstance.src = _context.t0;
239
255
  this.videoInstance.setAttribute('data-src', this.videoUrl);
240
256
 
241
257
  onStart = function onStart() {
@@ -251,7 +267,7 @@ var VideoAgentMesh = /*#__PURE__*/function (_THREE$Mesh) {
251
267
 
252
268
  this.videoInstance.addEventListener('timeupdate', onStart, false);
253
269
 
254
- case 18:
270
+ case 23:
255
271
  case "end":
256
272
  return _context.stop();
257
273
  }
package/lib/Player/modules/VideoAgent/VideoAgentScene.d.ts CHANGED
@@ -9,6 +9,7 @@ export declare class VideoAgentScene {
9
9
  constructor(container: HTMLElement, needRender?: boolean, options?: {
10
10
  videoInstance?: HTMLVideoElement;
11
11
  audioInstance?: HTMLAudioElement;
12
+ preload?: boolean;
12
13
  });
13
14
  run: () => void;
14
15
  dispose: () => void;
package/lib/Player/modules/VideoAgent/VideoAgentScene.js CHANGED
@@ -38,8 +38,7 @@ var VideoAgentScene = function VideoAgentScene(container) {
38
38
  _defineProperty(this, "run", function () {
39
39
  var _this$videoAgentMesh$;
40
40
 
41
- var domElement = _this.renderer.domElement; // console.log('renderder', this.videoAgentMesh.paused, this.videoAgentMesh.freeze)
42
- // 视频开始 1s 不渲染：规避某些设备黑屏闪烁问题。视频前 2s 是最好是静默的。
41
+ var domElement = _this.renderer.domElement; // 视频开始 1s 不渲染：规避某些设备黑屏闪烁问题。视频前 2s 是最好是静默的。
43
42
 
44
43
  if (!(_this.videoAgentMesh.paused || _this.videoAgentMesh.freeze) && _this.videoAgentMesh.currentTime > 1000) {
45
44
  _this.renderer.render(_this.scene, _this.camera);
package/lib/Player/modules/keyframes/PanoTextLabel/index.d.ts CHANGED
@@ -1,2 +1,5 @@
1
1
  /// <reference types="react" />
2
+ /**
3
+ * 空间文本标签。
4
+ */
2
5
  export declare function PanoTextLabel(): JSX.Element;