@realsee/vr-signals

Version:

vr 信号器

18 lines (17 loc) • 65.8 kB

HTML

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultEventMap | @realsee/vr-signals API Documentation - v2.0.0</title><meta name="description" content="Documentation for @realsee/vr-signals API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@realsee/vr-signals API Documentation - v2.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DefaultEventMap</a></li></ul><h1>Interface DefaultEventMap</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography">核心 Event 类型定义 包含了与 @realsee/five SDK 对应的核心功能 Events，支持状态同步、相机事件、标签事件、监控事件等。 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript">import { DefaultEventMap } from '@realsee/vr-signals' // 使用核心 Event 类型 const client = new RealseeVRSignalsClient<DefaultActionMap, DefaultEventMap>({ vrLink: 'http://localhost:3000/vr-app', element: iframeElement }) // 监听核心 Events client.on('stateSynced', (data) => { console.log('状态同步:', data) }) client.on('cameraUpdate', (data) => { console.log('相机更新:', data.state) }) </code><button type="button">Copy</button></pre> </div></div></section><div class="tsd-signature">interface DefaultEventMap { <a class="tsd-kind-property" href="#statesynced">stateSynced</a>: ( data: { mode?: "panorama" | "floorplan" | "topview"; longitude?: number; latitude?: number; fov?: number; panoIndex?: number; offset?: { x: number; y: number; z: number }; }, ) => void; <a class="tsd-kind-property" href="#cameraupdate">cameraUpdate</a>: ( data: { state: { longitude?: number; latitude?: number; fov?: number; offset?: { x: number; y: number; z: number }; }; userAction: boolean; }, ) => void; <a class="tsd-kind-property" href="#tagclick">"tag.click"</a>: ( data: { id: string; data: { id: string; title: string; description: string; type: string; extraData: string; }; }, ) => void; <a class="tsd-kind-property" href="#monitoropen">"monitor.open"</a>: ( data: { id: string; data: { id: string; name: string; videoSrc: string; type: string; extraData: string; }; }, ) => void; <a class="tsd-kind-property" href="#monitorclose">"monitor.close"</a>: ( data: { id: string; data: { id: string; name: string; videoSrc: string; type: string; extraData: string; }; }, ) => void; <a class="tsd-kind-property" href="#overlayvisible">"overlay.visible"</a>: (data: { visible: boolean }) => void; <a class="tsd-kind-property" href="#sdkavailabilityactionregistered">"sdk.availability.action.registered"</a>: ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void; <a class="tsd-kind-property" href="#sdkavailabilityactionunregistered">"sdk.availability.action.unregistered"</a>: ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void; <a class="tsd-kind-property" href="#sdkavailabilityactionbatch_registered">"sdk.availability.action.batch_registered"</a>: ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void; <a class="tsd-kind-property" href="#sdkavailabilityactionbatch_unregistered">"sdk.availability.action.batch_unregistered"</a>: ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void; <a class="tsd-kind-property" href="#sdkavailabilityactioncleared">"sdk.availability.action.cleared"</a>: ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void; [name: string]: (arg: any) => any; }</div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><ul class="tsd-signatures"><li class="tsd-index-signature"><div class="tsd-signature">[name: string]: (arg: any) => any</div></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:155</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#statesynced" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>stateSynced</a> <a href="#cameraupdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>cameraUpdate</a> <a href="#tagclick" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>tag.click</a> <a href="#monitoropen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>monitor.open</a> <a href="#monitorclose" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>monitor.close</a> <a href="#overlayvisible" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>overlay.visible</a> <a href="#sdkavailabilityactionregistered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>sdk.availability.action.registered</a> <a href="#sdkavailabilityactionunregistered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>sdk.availability.action.unregistered</a> <a href="#sdkavailabilityactionbatch_registered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>sdk.availability.action.batch_registered</a> <a href="#sdkavailabilityactionbatch_unregistered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>sdk.availability.action.batch_unregistered</a> <a href="#sdkavailabilityactioncleared" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg>sdk.availability.action.cleared</a> </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="statesynced">stateSynced<a href="#statesynced" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">stateSynced: ( data: { mode?: "panorama" | "floorplan" | "topview"; longitude?: number; latitude?: number; fov?: number; panoIndex?: number; offset?: { x: number; y: number; z: number }; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:157</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cameraupdate">cameraUpdate<a href="#cameraupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">cameraUpdate: ( data: { state: { longitude?: number; latitude?: number; fov?: number; offset?: { x: number; y: number; z: number }; }; userAction: boolean; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:167</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tagclick">tag.click<a href="#tagclick" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"tag.click": ( data: { id: string; data: { id: string; title: string; description: string; type: string; extraData: string; }; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:178</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="monitoropen">monitor.open<a href="#monitoropen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"monitor.open": ( data: { id: string; data: { id: string; name: string; videoSrc: string; type: string; extraData: string; }; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:190</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="monitorclose">monitor.close<a href="#monitorclose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"monitor.close": ( data: { id: string; data: { id: string; name: string; videoSrc: string; type: string; extraData: string; }; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:201</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="overlayvisible">overlay.visible<a href="#overlayvisible" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"overlay.visible": (data: { visible: boolean }) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:213</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sdkavailabilityactionregistered">sdk.availability.action.registered<a href="#sdkavailabilityactionregistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"sdk.availability.action.registered": ( data: { actionName: string[]; timestamp: number; stats: { total: number; registered: (string | number | symbol)[]; timestamp: number; }; }, ) => void</div><aside class="tsd-sources"><ul><li>Defined in src/default-types.ts:216</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sdkavailabilityactionunregistered">sdk.availability.action.unregistered<a href="#sdkavailabilityactionunregistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">"sdk.availability.action.unregistered": ( data: { actionName: string[]; timestamp: