@arcgis/map-components 4.33.0-next.61 → 4.33.0-next.63

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-03-28T05:02:55",
+  "timestamp": "2025-03-30T04:52:30",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.61",
+    "version": "4.33.0-next.63",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -22907,7 +22907,7 @@
               "name": "labelFormatFunction",
               "description": "A function used to format labels.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction)",
               "type": {
-                "text": "(value: number, type?: \"max\" | \"min\" | \"average\" | \"value\" | \"tick\" | undefined, index?: number | undefined) => string"
+                "text": "(value: number, type?: \"value\" | \"max\" | \"min\" | \"average\" | \"tick\" | undefined, index?: number | undefined) => string"
               }
             },
             {
@@ -51577,6 +51577,446 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/video-player/video-player.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisVideoPlayer",
+          "tagName": "arcgis-video-player",
+          "description": "The VideoPlayer component provides a user interface for interacting with a VideoLayer.\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe VideoPlayer component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on the Safari browser or on iOS devices.",
+          "demos": [
+            {
+              "description": "Docs",
+              "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/"
+            },
+            {
+              "description": "Demo",
+              "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-video-player--demo&singleStory=true"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "encapsulation": "none",
+          "pascalCaseName": "ArcgisVideoPlayer",
+          "importPath": "components/arcgis-video-player",
+          "members": [
+            {
+              "kind": "field",
+              "name": "autoDestroyDisabled",
+              "description": "If true, the component will not be destroyed automatically when\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "auto-destroy-disabled"
+            },
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "const arcgisVideoPlayer = document.createElement(\"arcgis-video-player\");\ndocument.body.append(arcgisVideoPlayer);\narcgisVideoPlayer.componentOnReady().then(() => {\n  console.log(\"arcgis-video-player is ready to go!\");\n});"
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "description": "Permanently destroy the component.",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(): Promise<void>",
+              "async": true
+            },
+            {
+              "kind": "field",
+              "name": "icon",
+              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"video-web\"",
+              "attribute": "icon",
+              "reflects": true,
+              "docsTags": [
+                {
+                  "name": "see",
+                  "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
+                },
+                {
+                  "name": "example",
+                  "text": "// Use a different icon for the VideoPlayer\nvideoPlayer.icon = \"livestream-video-layer\";"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "description": "The component's default label.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "label",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "layer",
+              "description": "The [VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html) to use as the data source for the video player.",
+              "type": {
+                "text": "VideoLayer",
+                "references": [
+                  {
+                    "name": "VideoLayer",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html",
+                    "start": 0,
+                    "end": 10
+                  }
+                ]
+              },
+              "default": "null",
+              "docsTags": [
+                {
+                  "name": "noautocast"
+                },
+                {
+                  "name": "example",
+                  "text": "// Create a new VideoPlayer with a VideoLayer\nvideoPlayer.layer = videoLayer;"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "messageOverrides",
+              "description": "Overwrite localized strings for this component",
+              "type": {
+                "text": "{\n    beginning?: string | undefined;\n    color?: string | undefined;\n    end?: string | undefined;\n    errorLoadingLayer?: string | undefined;\n    follow?: string | undefined;\n    forward?: string | undefined;\n    frame?: string | undefined;\n    frameCenter?: string | undefined;\n    frameInfo?: string | undefined;\n    frameOutline?: string | undefined;\n    graphics?: string | undefined;\n    layers?: string | undefined;\n    metadata?: string | undefined;\n    metadataDescription?: string | undefined;\n    metadataNotLoaded?: string | undefined;\n    missionInfo?: string | undefined;\n    none?: string | undefined;\n    pause?: string | undefined;\n    platformInfo?: string | undefined;\n    play?: string | undefined;\n    playbackSpeed?: string | undefined;\n    quality?: string | undefined;\n    reverse?: string | undefined;\n    sensor?: string | undefined;\n    sensorTrail?: string | undefined;\n    settings?: string | undefined;\n    sightLine?: string | undefined;\n    speed?: string | undefined;\n    video?: string | undefined;\n}"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "position",
+              "type": {
+                "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
+                "values": [
+                  {
+                    "value": "bottom-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-trailing",
+                    "type": "string"
+                  },
+                  {
+                    "value": "manual",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-trailing",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"top-left\"",
+              "attribute": "position",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "referenceElement",
+              "type": {
+                "text": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
+                "references": [
+                  {
+                    "name": "HTMLArcgisLinkChartElement",
+                    "module": "index.js",
+                    "start": 10,
+                    "end": 25,
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/"
+                  },
+                  {
+                    "name": "HTMLArcgisMapElement",
+                    "module": "index.js",
+                    "start": 39,
+                    "end": 48,
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/"
+                  },
+                  {
+                    "name": "HTMLArcgisSceneElement",
+                    "module": "index.js",
+                    "start": 62,
+                    "end": 73,
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/"
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "HTMLArcgisLinkChartElement"
+                  },
+                  {
+                    "type": "HTMLArcgisMapElement"
+                  },
+                  {
+                    "type": "HTMLArcgisSceneElement"
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "reference-element"
+            },
+            {
+              "kind": "field",
+              "name": "state",
+              "description": "The state of the video layer.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html#state)",
+              "type": {
+                "text": "\"can-play\" | \"data-loaded\" | \"error\" | \"not-ready\" | \"paused\" | \"playing\" | \"ready\" | \"waiting\"",
+                "values": [
+                  {
+                    "value": "can-play",
+                    "type": "string"
+                  },
+                  {
+                    "value": "data-loaded",
+                    "type": "string"
+                  },
+                  {
+                    "value": "error",
+                    "type": "string"
+                  },
+                  {
+                    "value": "not-ready",
+                    "type": "string"
+                  },
+                  {
+                    "value": "paused",
+                    "type": "string"
+                  },
+                  {
+                    "value": "playing",
+                    "type": "string"
+                  },
+                  {
+                    "value": "ready",
+                    "type": "string"
+                  },
+                  {
+                    "value": "waiting",
+                    "type": "string"
+                  }
+                ]
+              },
+              "readonly": true,
+              "docsOnlyReadonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "auto-destroy-disabled",
+              "description": "If true, the component will not be destroyed automatically when\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "autoDestroyDisabled"
+            },
+            {
+              "name": "icon",
+              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"video-web\"",
+              "fieldName": "icon"
+            },
+            {
+              "name": "label",
+              "description": "The component's default label.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "label"
+            },
+            {
+              "name": "position",
+              "type": {
+                "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
+                "values": [
+                  {
+                    "value": "bottom-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-trailing",
+                    "type": "string"
+                  },
+                  {
+                    "value": "manual",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-trailing",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"top-left\"",
+              "fieldName": "position"
+            },
+            {
+              "name": "reference-element",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "referenceElement"
+            }
+          ],
+          "events": [
+            {
+              "name": "arcgisPropertyChange",
+              "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
+              "type": {
+                "text": "{ name: \"state\" | \"layer\"; }"
+              }
+            },
+            {
+              "name": "arcgisReady",
+              "description": "Emitted when the component associated with a map view is is ready to be interacted with.",
+              "type": {
+                "text": "undefined"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-video-player",
+          "declaration": {
+            "name": "ArcgisVideoPlayer",
+            "module": "src/components/video-player/video-player.tsx"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/weather/weather.tsx",