@realsee/vreo 0.1.2 → 0.1.6-alpha.1
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.
- package/docs/assets/search.js +1 -1
- package/docs/classes/Player.Player-1.html +6 -6
- package/docs/enums/Player.InfoPanelTypeEnum.html +1 -1
- package/docs/enums/Player.PanoEffectEnum.html +1 -1
- package/docs/enums/Player.PanoTagEnum.html +1 -1
- package/docs/enums/Player.VreoKeyframeEnum.html +13 -11
- package/docs/enums/fivePlugins.CameraMovementEffect.html +1 -1
- package/docs/enums/fivePlugins.Rotation.html +1 -1
- package/docs/interfaces/Player.PlayerConfigs.html +1 -1
- package/docs/interfaces/Player.Vertex.html +1 -1
- package/docs/interfaces/Player.VreoKeyframe.html +1 -1
- package/docs/interfaces/Player.VreoUnit.html +1 -1
- package/docs/interfaces/Player.VreoVideo.html +1 -1
- package/docs/interfaces/fivePlugins.CameraMovementOptsCallback.html +1 -1
- package/docs/interfaces/fivePlugins.CameraMovementPluginExportType.html +2 -2
- package/docs/interfaces/fivePlugins.ModelTVVideoPluginData.html +1 -1
- package/docs/interfaces/fivePlugins.ModelTVVideoPluginExportType.html +1 -1
- package/docs/interfaces/fivePlugins.ModelTVVideoPluginParameterType.html +1 -1
- package/docs/interfaces/react.VreoActionCallbacks.html +6 -6
- package/docs/modules/Player.html +14 -12
- package/docs/modules/fivePlugins.html +2 -2
- package/docs/modules/react.html +1 -1
- package/lib/Player/App.js +4 -0
- package/lib/Player/Controller.d.ts +1 -0
- package/lib/Player/Controller.js +11 -4
- package/lib/Player/index.d.ts +1 -0
- package/lib/Player/index.js +50 -31
- package/lib/Player/modules/VideoAgent/VideoAgentMesh.d.ts +2 -0
- package/lib/Player/modules/VideoAgent/VideoAgentMesh.js +62 -22
- package/lib/Player/modules/VideoAgent/VideoAgentScene.d.ts +2 -0
- package/lib/Player/modules/VideoAgent/VideoAgentScene.js +7 -0
- package/lib/Player/modules/VideoAgent/index.js +6 -0
- package/lib/Player/modules/keyframes/Prompter/index.js +2 -1
- package/lib/Player/modules/keyframes/UpdateVRPanorama/index.js +4 -0
- package/lib/fivePlugins/CameraMovementPlugin/index.js +5 -4
- package/lib/fivePlugins/CameraMovementPlugin/typings.d.ts +1 -0
- package/lib/react/index.js +12 -4
- package/lib/typings/VreoUnit.d.ts +7 -1
- package/lib/typings/VreoUnit.js +1 -0
- package/package.json +6 -2
- package/resources/Player/App.tsx +3 -0
- package/resources/Player/Controller.ts +5 -5
- package/resources/Player/index.tsx +36 -23
- package/resources/Player/modules/VideoAgent/VideoAgentMesh.ts +63 -20
- package/resources/Player/modules/VideoAgent/VideoAgentScene.ts +6 -0
- package/resources/Player/modules/VideoAgent/index.tsx +5 -0
- package/resources/Player/modules/keyframes/Prompter/index.tsx +1 -0
- package/resources/Player/modules/keyframes/UpdateVRPanorama/index.tsx +5 -1
- package/resources/fivePlugins/CameraMovementPlugin/index.ts +8 -3
- package/resources/fivePlugins/CameraMovementPlugin/typings.ts +1 -0
- package/resources/react/index.tsx +11 -4
- package/resources/typings/VreoUnit.ts +7 -0
- package/stylesheets/default.css +9 -1
|
@@ -1,3 +1,3 @@
|
|
|
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><span class="tsd-signature-symbol"> & </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/7f21d45/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"> & </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/7f21d45/resources/fivePlugins/CameraMovementPlugin/typings.ts#L44">resources/fivePlugins/CameraMovementPlugin/typings.ts:44</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>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"> & </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/7f21d45/resources/fivePlugins/CameraMovementPlugin/typings.ts#L48">resources/fivePlugins/CameraMovementPlugin/typings.ts:48</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"> & </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/7f21d45/resources/fivePlugins/CameraMovementPlugin/typings.ts#L55">resources/fivePlugins/CameraMovementPlugin/typings.ts:55</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/7f21d45/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.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><span class="tsd-signature-symbol"> & </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/6c8f41c/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"> & </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/6c8f41c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L44">resources/fivePlugins/CameraMovementPlugin/typings.ts:44</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>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"> & </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/6c8f41c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L48">resources/fivePlugins/CameraMovementPlugin/typings.ts:48</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"> & </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/6c8f41c/resources/fivePlugins/CameraMovementPlugin/typings.ts#L55">resources/fivePlugins/CameraMovementPlugin/typings.ts:55</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/6c8f41c/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
2
|
<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/
|
|
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/6c8f41c/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="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>
|
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></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"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/7f21d45/resources/react/index.tsx#L8">resources/react/index.tsx:8</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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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"> => </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/7f21d45/resources/react/index.tsx#L54">resources/react/index.tsx:54</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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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"> => </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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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><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-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"> => </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"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/7f21d45/resources/react/index.tsx#L71">resources/react/index.tsx:71</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">"paused"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"playing"</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/7f21d45/resources/react/index.tsx#L87">resources/react/index.tsx:87</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="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-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></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"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/realsee-developer/vreo/blob/6c8f41c/resources/react/index.tsx#L8">resources/react/index.tsx:8</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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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"> => </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/6c8f41c/resources/react/index.tsx#L67">resources/react/index.tsx:67</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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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"> => </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"> => </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"> => </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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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"> => </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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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><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-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"> => </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"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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/6c8f41c/resources/react/index.tsx#L84">resources/react/index.tsx:84</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">"paused"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"playing"</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/6c8f41c/resources/react/index.tsx#L104">resources/react/index.tsx:104</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="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-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/App.js
CHANGED
|
@@ -51,6 +51,10 @@ var AppView = (0, _mobxReact.observer)(function (_ref) {
|
|
|
51
51
|
className: "vreo-panel-inner"
|
|
52
52
|
}, /*#__PURE__*/React.createElement(_VideoAgent.VideoAgent, {
|
|
53
53
|
onClick: function onClick() {
|
|
54
|
+
if (controller.isAudio) {
|
|
55
|
+
return;
|
|
56
|
+
}
|
|
57
|
+
|
|
54
58
|
if (controller.playing) {
|
|
55
59
|
controller.setPlaying(false);
|
|
56
60
|
} else {
|
package/lib/Player/Controller.js
CHANGED
|
@@ -80,6 +80,13 @@ var Controller = /*#__PURE__*/function (_Subscribe) {
|
|
|
80
80
|
}
|
|
81
81
|
|
|
82
82
|
_createClass(Controller, [{
|
|
83
|
+
key: "isAudio",
|
|
84
|
+
get: function get() {
|
|
85
|
+
var _this$videoAgentScene, _this$videoAgentScene2;
|
|
86
|
+
|
|
87
|
+
return !((_this$videoAgentScene = this.videoAgentScene) !== null && _this$videoAgentScene !== void 0 && (_this$videoAgentScene2 = _this$videoAgentScene.videoAgentMesh.videoUrl) !== null && _this$videoAgentScene2 !== void 0 && _this$videoAgentScene2.endsWith('.mp4'));
|
|
88
|
+
}
|
|
89
|
+
}, {
|
|
83
90
|
key: "setVisible",
|
|
84
91
|
value: function setVisible(v) {
|
|
85
92
|
this.visible = v;
|
|
@@ -112,9 +119,9 @@ var Controller = /*#__PURE__*/function (_Subscribe) {
|
|
|
112
119
|
}, {
|
|
113
120
|
key: "currentTime",
|
|
114
121
|
get: function get() {
|
|
115
|
-
var _this$
|
|
122
|
+
var _this$videoAgentScene3;
|
|
116
123
|
|
|
117
|
-
return ((_this$
|
|
124
|
+
return ((_this$videoAgentScene3 = this.videoAgentScene) === null || _this$videoAgentScene3 === void 0 ? void 0 : _this$videoAgentScene3.videoAgentMesh.currentTime) || 0;
|
|
118
125
|
}
|
|
119
126
|
}, {
|
|
120
127
|
key: "currentKeyframes",
|
|
@@ -133,9 +140,9 @@ var Controller = /*#__PURE__*/function (_Subscribe) {
|
|
|
133
140
|
}, {
|
|
134
141
|
key: "videoInstance",
|
|
135
142
|
get: function get() {
|
|
136
|
-
var _this$
|
|
143
|
+
var _this$videoAgentScene4;
|
|
137
144
|
|
|
138
|
-
return (_this$
|
|
145
|
+
return (_this$videoAgentScene4 = this.videoAgentScene) === null || _this$videoAgentScene4 === void 0 ? void 0 : _this$videoAgentScene4.videoAgentMesh.videoInstance;
|
|
139
146
|
}
|
|
140
147
|
/**
|
|
141
148
|
* 逐帧任务
|
package/lib/Player/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { VreoKeyframeEvent, VreoUnit } from '../typings/VreoUnit';
|
|
|
3
3
|
import { PlayerConfigs } from './typings';
|
|
4
4
|
export declare class Player extends Subscribe<VreoKeyframeEvent> {
|
|
5
5
|
$five: Five;
|
|
6
|
+
private controller;
|
|
6
7
|
configs: Readonly<PlayerConfigs>;
|
|
7
8
|
constructor(five: Five, configs?: Partial<PlayerConfigs>);
|
|
8
9
|
load(vreoUnit: VreoUnit, currentTime?: number): Promise<boolean>;
|
package/lib/Player/index.js
CHANGED
|
@@ -49,8 +49,6 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
|
|
|
49
49
|
|
|
50
50
|
function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
|
|
51
51
|
|
|
52
|
-
var controller = new _Controller.Controller();
|
|
53
|
-
|
|
54
52
|
var Player = /*#__PURE__*/function (_Subscribe) {
|
|
55
53
|
_inherits(Player, _Subscribe);
|
|
56
54
|
|
|
@@ -64,10 +62,12 @@ var Player = /*#__PURE__*/function (_Subscribe) {
|
|
|
64
62
|
_classCallCheck(this, Player);
|
|
65
63
|
|
|
66
64
|
_this = _super.call(this);
|
|
67
|
-
_this
|
|
65
|
+
_this.controller = new _Controller.Controller();
|
|
66
|
+
_this.$five = _this.controller.$five = five;
|
|
68
67
|
|
|
69
68
|
if (!configs.containter) {
|
|
70
|
-
var containter = document.createElement('div');
|
|
69
|
+
var containter = document.querySelector('#vreo-app') || document.createElement('div');
|
|
70
|
+
ReactDOM.unmountComponentAtNode(containter);
|
|
71
71
|
containter.setAttribute('id', 'vreo-app');
|
|
72
72
|
configs.containter = containter;
|
|
73
73
|
document.body.append(containter);
|
|
@@ -76,13 +76,13 @@ var Player = /*#__PURE__*/function (_Subscribe) {
|
|
|
76
76
|
_this.configs = Object.freeze(Object.assign({
|
|
77
77
|
keyframeMap: {}
|
|
78
78
|
}, configs));
|
|
79
|
-
controller.configs = _this.configs;
|
|
79
|
+
_this.controller.configs = _this.configs;
|
|
80
80
|
ReactDOM.render( /*#__PURE__*/React.createElement(_Controller.ControllerContext.Provider, {
|
|
81
|
-
value: controller
|
|
81
|
+
value: _this.controller
|
|
82
82
|
}, /*#__PURE__*/React.createElement(_App.App, null), /*#__PURE__*/React.createElement(_Drawer.Drawer, null)), configs.containter); // 监听播放情况：抛出触发时机
|
|
83
83
|
|
|
84
84
|
(0, _mobx.reaction)(function () {
|
|
85
|
-
return controller.playing;
|
|
85
|
+
return _this.controller.playing;
|
|
86
86
|
}, function (playing) {
|
|
87
87
|
_this.emit(playing ? 'playing' : 'paused');
|
|
88
88
|
});
|
|
@@ -93,12 +93,12 @@ var Player = /*#__PURE__*/function (_Subscribe) {
|
|
|
93
93
|
key: "load",
|
|
94
94
|
value: function () {
|
|
95
95
|
var _load = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(vreoUnit) {
|
|
96
|
-
var
|
|
96
|
+
var _this$controller$vide,
|
|
97
97
|
_this2 = this;
|
|
98
98
|
|
|
99
99
|
var currentTime,
|
|
100
|
-
|
|
101
|
-
|
|
100
|
+
_this$controller$vide2,
|
|
101
|
+
_this$controller$vide3,
|
|
102
102
|
_args = arguments;
|
|
103
103
|
|
|
104
104
|
return regeneratorRuntime.wrap(function _callee$(_context) {
|
|
@@ -107,36 +107,50 @@ var Player = /*#__PURE__*/function (_Subscribe) {
|
|
|
107
107
|
case 0:
|
|
108
108
|
currentTime = _args.length > 1 && _args[1] !== undefined ? _args[1] : 0;
|
|
109
109
|
|
|
110
|
-
if (controller.
|
|
111
|
-
|
|
112
|
-
|
|
110
|
+
if (this.controller.visible) {
|
|
111
|
+
_context.next = 5;
|
|
112
|
+
break;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
this.controller.setVisible(true);
|
|
116
|
+
_context.next = 5;
|
|
117
|
+
return new Promise(function (resolve) {
|
|
118
|
+
setTimeout(function () {
|
|
119
|
+
return resolve(true);
|
|
120
|
+
}, 500);
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
case 5:
|
|
124
|
+
if (this.controller.stopInterval) {
|
|
125
|
+
this.controller.stopInterval();
|
|
126
|
+
this.controller.stopInterval = undefined;
|
|
113
127
|
}
|
|
114
128
|
|
|
115
|
-
controller.vreoUnit = vreoUnit;
|
|
116
|
-
(
|
|
129
|
+
this.controller.vreoUnit = vreoUnit;
|
|
130
|
+
(_this$controller$vide = this.controller.videoInstance) === null || _this$controller$vide === void 0 ? void 0 : _this$controller$vide.pause();
|
|
117
131
|
|
|
118
132
|
if (!vreoUnit.video.url) {
|
|
119
|
-
_context.next =
|
|
133
|
+
_context.next = 13;
|
|
120
134
|
break;
|
|
121
135
|
}
|
|
122
136
|
|
|
123
|
-
if ((
|
|
124
|
-
controller.videoAgentScene.videoAgentMesh.videoInstance.currentTime = currentTime / 1000;
|
|
137
|
+
if ((_this$controller$vide2 = this.controller.videoAgentScene) !== null && _this$controller$vide2 !== void 0 && _this$controller$vide2.videoAgentMesh.videoInstance) {
|
|
138
|
+
this.controller.videoAgentScene.videoAgentMesh.videoInstance.currentTime = currentTime / 1000;
|
|
125
139
|
}
|
|
126
140
|
|
|
127
|
-
_context.next =
|
|
128
|
-
return (
|
|
141
|
+
_context.next = 12;
|
|
142
|
+
return (_this$controller$vide3 = this.controller.videoAgentScene) === null || _this$controller$vide3 === void 0 ? void 0 : _this$controller$vide3.videoAgentMesh.play(vreoUnit.video.url);
|
|
129
143
|
|
|
130
|
-
case
|
|
144
|
+
case 12:
|
|
131
145
|
this.play();
|
|
132
146
|
|
|
133
|
-
case
|
|
134
|
-
controller.run(function (type, keyframe) {
|
|
147
|
+
case 13:
|
|
148
|
+
this.controller.run(function (type, keyframe) {
|
|
135
149
|
return _this2.emit(type, keyframe);
|
|
136
150
|
});
|
|
137
151
|
return _context.abrupt("return", true);
|
|
138
152
|
|
|
139
|
-
case
|
|
153
|
+
case 15:
|
|
140
154
|
case "end":
|
|
141
155
|
return _context.stop();
|
|
142
156
|
}
|
|
@@ -153,34 +167,39 @@ var Player = /*#__PURE__*/function (_Subscribe) {
|
|
|
153
167
|
}, {
|
|
154
168
|
key: "paused",
|
|
155
169
|
get: function get() {
|
|
156
|
-
return !controller.playing;
|
|
170
|
+
return !this.controller.playing;
|
|
157
171
|
}
|
|
158
172
|
}, {
|
|
159
173
|
key: "play",
|
|
160
174
|
value: function play() {
|
|
161
|
-
if (controller.playing) return true;
|
|
162
|
-
controller.setPlaying(true);
|
|
175
|
+
if (this.controller.playing) return true;
|
|
176
|
+
this.controller.setPlaying(true);
|
|
163
177
|
return true;
|
|
164
178
|
}
|
|
165
179
|
}, {
|
|
166
180
|
key: "pause",
|
|
167
181
|
value: function pause() {
|
|
168
|
-
controller.setPlaying(false);
|
|
182
|
+
this.controller.setPlaying(false);
|
|
169
183
|
}
|
|
170
184
|
}, {
|
|
171
185
|
key: "show",
|
|
172
186
|
value: function show() {
|
|
173
|
-
controller.setVisible(true);
|
|
187
|
+
this.controller.setVisible(true);
|
|
174
188
|
}
|
|
175
189
|
}, {
|
|
176
190
|
key: "hide",
|
|
177
191
|
value: function hide() {
|
|
178
|
-
controller.setVisible(false);
|
|
192
|
+
this.controller.setVisible(false);
|
|
179
193
|
}
|
|
180
194
|
}, {
|
|
181
195
|
key: "dispose",
|
|
182
196
|
value: function dispose() {
|
|
183
|
-
|
|
197
|
+
this.pause();
|
|
198
|
+
this.controller.dispose();
|
|
199
|
+
|
|
200
|
+
if (this.configs.containter) {
|
|
201
|
+
ReactDOM.unmountComponentAtNode(this.configs.containter);
|
|
202
|
+
}
|
|
184
203
|
}
|
|
185
204
|
}]);
|
|
186
205
|
|
|
@@ -11,6 +11,7 @@ export declare class VideoAgentMesh extends THREE.Mesh {
|
|
|
11
11
|
freeze: boolean;
|
|
12
12
|
paused: boolean;
|
|
13
13
|
audioInstance: HTMLAudioElement;
|
|
14
|
+
$removeEventListener: () => void;
|
|
14
15
|
get videoInstance(): HTMLAudioElement;
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
@@ -27,4 +28,5 @@ export declare class VideoAgentMesh extends THREE.Mesh {
|
|
|
27
28
|
* 转成毫秒，保障精准度
|
|
28
29
|
*/
|
|
29
30
|
get currentTime(): number;
|
|
31
|
+
dispose(): void;
|
|
30
32
|
}
|