@stampgis/webrtc 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -4642,25 +4642,39 @@ interface CoreLoadOptions {
     pixelstreamingUrl?: string;
     playerControlUrl?: string;
     /**
-     * 服务器 IP，覆盖 stamp_core_config.js 中的默认值。
+     * 匹配器 IP，覆盖 stamp_core_config.js 中的默认值。
      * 如果传入，会在脚本加载后修改 window.stamp_core_config 的相关字段。
      */
-    serverIp?: string;
+    match_maker?: string;
     /** 超时时间（毫秒），默认 30 秒（像素流连接较慢） */
     timeout?: number;
 }
 /**
- * 地图初始化配置（initVideoPlayer 参数）
+ * 地图初始化配置（initMap 参数）
  */
-interface InitVideoPlayerOptions {
-    /** 地球容器 DOM 元素 */
-    earthDomElement: HTMLElement;
-    /** 错误提示容器 DOM 元素 */
-    errorDomElement?: HTMLElement;
+interface InitMapOptions {
+    /** 地球容器 DOM 元素或元素 id */
+    container: string | HTMLElement;
+    /** 错误提示容器 DOM 元素或元素 id，不传则在内部自动创建 */
+    errorContainer?: string | HTMLElement;
     /** 屏幕索引：0=主屏, 1=副屏1, 2=副屏2 */
-    iIndex?: number;
+    mapIndex?: number;
     /** 是否显示提示信息 */
     showTips?: boolean;
+    /**
+     * 核心脚本加载配置（可选）。
+     *
+     * 如果 StampAPI 尚未就绪，initMap 会自动调用 loadCore()。
+     * 不传则默认使用 useBundledAssets: true。
+     *
+     * 示例：
+     *   // 自动加载（默认从包内 assets）
+     *   await initMap({ container: 'earthDiv' })
+     *
+     *   // 指定加载方式
+     *   await initMap({ container: document.getElementById('earth')!, coreOptions: { baseUrl: '/gis/' } })
+     */
+    coreOptions?: CoreLoadOptions;
 }
 /**
  * stamp_core_config 配置对象结构（部分关键字段）
@@ -4711,7 +4725,7 @@ declare global {
                 errorDomElement?: HTMLElement;
                 iIndex?: number;
                 showTips?: boolean;
-            }): void;
+            }): Promise<unknown>;
             initErrorDiv(opts: {
                 earthDomElement: HTMLElement;
                 errorDomElement: HTMLElement;
@@ -4781,7 +4795,7 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  *   2. pixelstreaming.js     → 注册 window.StampPixelStreaming
  *   3. playerControl.js      → 注册 window.StampAPI（依赖前两个脚本）
  *
- * 加载完成后，如果传入了 serverIp，会覆盖 stamp_core_config 中的服务器地址。
+ * 加载完成后，如果传入了 match_maker，会覆盖 stamp_core_config 中的匹配器地址。
  *
  * @param options 加载配置
  *
@@ -4798,7 +4812,7 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  *   configUrl: 'https://cdn.example.com/config/stamp_core_config.js',
  *   pixelstreamingUrl: 'https://cdn.example.com/core/pixelstreaming.js',
  *   playerControlUrl: 'https://cdn.example.com/core/playerControl.js',
- *   serverIp: '192.168.1.100',
+ *   match_maker: '/matchmaker',
  * });
  *
  * // 方式四：通过打包器 import 获取 URL（最大灵活性）
@@ -4810,25 +4824,36 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  */
 declare function loadCore(options?: CoreLoadOptions): Promise<void>;
 /**
- * 初始化视频播放器（地球渲染）
+ * 初始化地图（地球渲染）
  *
- * 对应原项目中 Earth.vue 的调用：
- *   StampAPI.initVideoPlayer({ earthDomElement, errorDomElement, iIndex })
- *
- * 必须在 loadCore() 之后调用。
+ * 如果核心脚本尚未加载（window.StampAPI 不存在），会自动调用 loadCore()。
+ * 默认使用 useBundledAssets: true，也可通过 coreOptions 指定加载方式。
  *
  * @param options 初始化参数
  *
  * @example
  * ```ts
- * await loadCore({ useBundledAssets: true });
+ * // 最简用法：自动加载 + 初始化（通过 id 指定容器）
+ * await initMap({ container: 'earthDiv' });
+ *
+ * // 传入 DOM 元素 + 自定义错误容器
+ * await initMap({
+ *   container: document.getElementById('earth')!,
+ *   errorContainer: 'errorDiv',
+ *   mapIndex: 0,
+ * });
+ *
+ * // errorContainer 不传则内部自动创建
+ * await initMap({ container: 'earthDiv' });
  *
- * const earthDiv = document.getElementById('earth')!;
- * const errorDiv = document.getElementById('error')!;
- * initVideoPlayer({ earthDomElement: earthDiv, errorDomElement: errorDiv });
+ * // 指定加载方式
+ * await initMap({
+ *   container: 'earthDiv',
+ *   coreOptions: { baseUrl: '/gis/' },
+ * });
  * ```
  */
-declare function initVideoPlayer(options: InitVideoPlayerOptions): void;
+declare function initMap(options: InitMapOptions): Promise<unknown>;
 
 declare const ASSET_PATHS: {
     readonly config: "@stampgis/webrtc/assets/config/stamp_core_config.js";
@@ -4836,4 +4861,4 @@ declare const ASSET_PATHS: {
     readonly playerControl: "@stampgis/webrtc/assets/core/playerControl.js";
 };
 
-export { ASSET_PATHS, type CoreLoadOptions, type InitVideoPlayerOptions, STAMP_RTTI, type StampCoreConfig, StampUtil, StampUtil as default, initVideoPlayer, loadCore, loadScript, waitForGlobal };
+export { ASSET_PATHS, type CoreLoadOptions, type InitMapOptions, STAMP_RTTI, type StampCoreConfig, StampUtil, StampUtil as default, initMap, loadCore, loadScript, waitForGlobal };

package/dist/index.d.ts

@@ -4642,25 +4642,39 @@ interface CoreLoadOptions {
     pixelstreamingUrl?: string;
     playerControlUrl?: string;
     /**
-     * 服务器 IP，覆盖 stamp_core_config.js 中的默认值。
+     * 匹配器 IP，覆盖 stamp_core_config.js 中的默认值。
      * 如果传入，会在脚本加载后修改 window.stamp_core_config 的相关字段。
      */
-    serverIp?: string;
+    match_maker?: string;
     /** 超时时间（毫秒），默认 30 秒（像素流连接较慢） */
     timeout?: number;
 }
 /**
- * 地图初始化配置（initVideoPlayer 参数）
+ * 地图初始化配置（initMap 参数）
  */
-interface InitVideoPlayerOptions {
-    /** 地球容器 DOM 元素 */
-    earthDomElement: HTMLElement;
-    /** 错误提示容器 DOM 元素 */
-    errorDomElement?: HTMLElement;
+interface InitMapOptions {
+    /** 地球容器 DOM 元素或元素 id */
+    container: string | HTMLElement;
+    /** 错误提示容器 DOM 元素或元素 id，不传则在内部自动创建 */
+    errorContainer?: string | HTMLElement;
     /** 屏幕索引：0=主屏, 1=副屏1, 2=副屏2 */
-    iIndex?: number;
+    mapIndex?: number;
     /** 是否显示提示信息 */
     showTips?: boolean;
+    /**
+     * 核心脚本加载配置（可选）。
+     *
+     * 如果 StampAPI 尚未就绪，initMap 会自动调用 loadCore()。
+     * 不传则默认使用 useBundledAssets: true。
+     *
+     * 示例：
+     *   // 自动加载（默认从包内 assets）
+     *   await initMap({ container: 'earthDiv' })
+     *
+     *   // 指定加载方式
+     *   await initMap({ container: document.getElementById('earth')!, coreOptions: { baseUrl: '/gis/' } })
+     */
+    coreOptions?: CoreLoadOptions;
 }
 /**
  * stamp_core_config 配置对象结构（部分关键字段）
@@ -4711,7 +4725,7 @@ declare global {
                 errorDomElement?: HTMLElement;
                 iIndex?: number;
                 showTips?: boolean;
-            }): void;
+            }): Promise<unknown>;
             initErrorDiv(opts: {
                 earthDomElement: HTMLElement;
                 errorDomElement: HTMLElement;
@@ -4781,7 +4795,7 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  *   2. pixelstreaming.js     → 注册 window.StampPixelStreaming
  *   3. playerControl.js      → 注册 window.StampAPI（依赖前两个脚本）
  *
- * 加载完成后，如果传入了 serverIp，会覆盖 stamp_core_config 中的服务器地址。
+ * 加载完成后，如果传入了 match_maker，会覆盖 stamp_core_config 中的匹配器地址。
  *
  * @param options 加载配置
  *
@@ -4798,7 +4812,7 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  *   configUrl: 'https://cdn.example.com/config/stamp_core_config.js',
  *   pixelstreamingUrl: 'https://cdn.example.com/core/pixelstreaming.js',
  *   playerControlUrl: 'https://cdn.example.com/core/playerControl.js',
- *   serverIp: '192.168.1.100',
+ *   match_maker: '/matchmaker',
  * });
  *
  * // 方式四：通过打包器 import 获取 URL（最大灵活性）
@@ -4810,25 +4824,36 @@ declare function waitForGlobal(globalName: string, timeout?: number, interval?:
  */
 declare function loadCore(options?: CoreLoadOptions): Promise<void>;
 /**
- * 初始化视频播放器（地球渲染）
+ * 初始化地图（地球渲染）
  *
- * 对应原项目中 Earth.vue 的调用：
- *   StampAPI.initVideoPlayer({ earthDomElement, errorDomElement, iIndex })
- *
- * 必须在 loadCore() 之后调用。
+ * 如果核心脚本尚未加载（window.StampAPI 不存在），会自动调用 loadCore()。
+ * 默认使用 useBundledAssets: true，也可通过 coreOptions 指定加载方式。
  *
  * @param options 初始化参数
  *
  * @example
  * ```ts
- * await loadCore({ useBundledAssets: true });
+ * // 最简用法：自动加载 + 初始化（通过 id 指定容器）
+ * await initMap({ container: 'earthDiv' });
+ *
+ * // 传入 DOM 元素 + 自定义错误容器
+ * await initMap({
+ *   container: document.getElementById('earth')!,
+ *   errorContainer: 'errorDiv',
+ *   mapIndex: 0,
+ * });
+ *
+ * // errorContainer 不传则内部自动创建
+ * await initMap({ container: 'earthDiv' });
  *
- * const earthDiv = document.getElementById('earth')!;
- * const errorDiv = document.getElementById('error')!;
- * initVideoPlayer({ earthDomElement: earthDiv, errorDomElement: errorDiv });
+ * // 指定加载方式
+ * await initMap({
+ *   container: 'earthDiv',
+ *   coreOptions: { baseUrl: '/gis/' },
+ * });
  * ```
  */
-declare function initVideoPlayer(options: InitVideoPlayerOptions): void;
+declare function initMap(options: InitMapOptions): Promise<unknown>;
 
 declare const ASSET_PATHS: {
     readonly config: "@stampgis/webrtc/assets/config/stamp_core_config.js";
@@ -4836,4 +4861,4 @@ declare const ASSET_PATHS: {
     readonly playerControl: "@stampgis/webrtc/assets/core/playerControl.js";
 };
 
-export { ASSET_PATHS, type CoreLoadOptions, type InitVideoPlayerOptions, STAMP_RTTI, type StampCoreConfig, StampUtil, StampUtil as default, initVideoPlayer, loadCore, loadScript, waitForGlobal };
+export { ASSET_PATHS, type CoreLoadOptions, type InitMapOptions, STAMP_RTTI, type StampCoreConfig, StampUtil, StampUtil as default, initMap, loadCore, loadScript, waitForGlobal };