@mapgis/webclient-video-plugin
Version:
2,153 lines (705 loc) • 29.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> Global</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
</head>
<body class="layout small-header">
<div id="stickyNavbarOverlay"></div>
<div class="top-nav">
<div class="inner">
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
<div class="logo">
<h1> MapGIS Client for JavaScript API</h1>
</div>
<div class="menu">
<div class="navigation">
<a
class="link user-link "
href="/static/modules/common/api/common-mapgis/index.html"
>
Common
</a>
<a
class="link user-link "
href="/static/modules/cesium/api/cesium-mapgis/index.html"
>
Cesium-Plugin
</a>
<a
class="link user-link "
href="/static/modules/mapboxgl/api/mapboxgl-mapgis/index.html"
>
MapboxGL-Plugin
</a>
<a
class="link user-link "
href="/static/modules/leaflet/api/leaflet-mapgis/index.html"
>
Leaflet-Plugin
</a>
<a
class="link user-link "
href="/static/modules/openlayers/api/openLayers-mapgis/index.html"
>
OpenLayers-Plugin
</a>
<a
class="link user-link "
href="/static/modules/video/api/video-mapgis/index.html"
>
Video-Plugin
</a>
</div>
</div>
</div>
</div>
<div id="main">
<div
class="sidebar "
id="sidebarNav"
>
<div>
<span class="mapgis-api-document-span"><a href="index.html">API文档</a></span>
</div>
<div class="search-wrapper">
<input id="search" type="text" placeholder="搜索文档..." class="input">
</div>
<nav>
<div class="category"><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">视图模块</div><ul class="mapgis-sidebar-menus"><li style="white-space: nowrap;overflow: hidden;text-overflow: ellipsis;" title="MapView"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="MapView.html">MapView</a><span style="display: none;"><p>视频地图视图类 <br/>
继承自<a href='http://webclient.smaryun.com/static/modules/common/api/common-mapgis/BaseView.html' target='_blank'>zondy.BaseView</a><br/>
支持MP4,HLS,RTMP视频格式。</p></span></li></ul><div style="font-weight: bold;vertical-align: middle;padding: 0.4rem 0;" class="mapgis-menu-span"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/m.png" alt="">草图编辑模块</div><ul class="mapgis-sidebar-menus"><li style="white-space: nowrap;overflow: hidden;text-overflow: ellipsis;" title="SketchEditor"><img style="width: 20px;margin-right: 6px;vertical-align: middle;" src="./styles/c.png" alt=""><a href="SketchEditor.html">SketchEditor</a><span style="display: none;"><p>视频草图编辑类<br/>
继承自<a href='http://webclient.smaryun.com/static/modules/leaflet/api/leaflet-mapgis/SketchEditor.html' target='_blank'>zondy.leaflet.SketchEditor</a><br/>
<br>[ES5引入方式]:<br/>
const { SketchEditor } = zondy.video.tool.sketch <br/>
[ES6引入方式]:<br/>
import { SketchEditor } from "@mapgis/webclient-leaflet-plugin" <br/></p></span></li></ul></div>
</nav>
</div>
<div class="core" id="main-content-wrapper">
<div class="content">
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">Global</span>
</header>
<section>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<div class='vertical-section'>
<h3 id='function'>方法</h3>
<div class="members">
<div class="member">
<h4 class="name" id="GDALApplyGeoTransform">
<a class="href-link" href="#GDALApplyGeoTransform">#</a>
<span class="code-name" style="font-size:30px">
GDALApplyGeoTransform<span class="signature">(padfGeoTransform, dfPixel, dfLine)</span>
</span>
</h4>
<div class="description">
<p>Applies the following computation, converting a (pixel, line) coordinate into a georeferenced (geo_x, geo_y) location.</p>
</div>
<h4>参数:</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>padfGeoTransform</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>Six coefficient GeoTransform to apply.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfPixel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Input pixel position.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfLine</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Input line position.</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值:</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>output location</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Object</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="GDALComposeGeoTransforms">
<a class="href-link" href="#GDALComposeGeoTransforms">#</a>
<span class="code-name" style="font-size:30px">
GDALComposeGeoTransforms<span class="signature">(padfGT1, padfGT2, padfGTOut)</span>
</span>
</h4>
<div class="description">
<p>The resulting geotransform is the equivalent to padfGT1 and then padfGT2 being applied to a point.</p>
</div>
<h4>参数:</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>padfGT1</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>the first geotransform, six values.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>padfGT2</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>the second geotransform, six values.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>padfGTOut</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>the output geotransform, six values, may safely be the same array as padfGT1 or padfGT2.</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="GDALGCPsToGeoTransform">
<a class="href-link" href="#GDALGCPsToGeoTransform">#</a>
<span class="code-name" style="font-size:30px">
GDALGCPsToGeoTransform<span class="signature">(pasGCPs, padfGeoTransform, bApproxOK)</span>
</span>
</h4>
<div class="description">
<p>Given a set of GCPs perform first order fit as a geotransform.</p>
</div>
<h4>参数:</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>pasGCPs</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#GCP">GCP</a>></span>
</td>
<td class="description last"><p>the list of GCP structures.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>padfGeoTransform</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>the six double array in which the affine geotransformation will be returned.</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>bApproxOK</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>If FALSE the function will fail if the geotransform is not essentially an exact fit (within 0.25 pixel) for all GCPs.</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值:</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>TRUE on success or FALSE if there aren't enough points to prepare a geotransform, the pointers are ill-determined or if bApproxOK is FALSE and the fit is poor.</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Boolean</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="GDALInvGeoTransform">
<a class="href-link" href="#GDALInvGeoTransform">#</a>
<span class="code-name" style="font-size:30px">
GDALInvGeoTransform<span class="signature">(gt_in, gt_out)</span>
</span>
</h4>
<div class="description">
<p>Invert Geotransform.</p>
</div>
<h4>参数:</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>gt_in</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>Input geotransform (six doubles - unaltered).</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>gt_out</code></td>
<td class="type">
<span class="param-type">Float64Array</span>
</td>
<td class="description last"><p>Output geotransform (six doubles - updated).</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值:</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>TRUE on success or FALSE if the equation is uninvertable.</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Number</span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class='vertical-section'>
<h1>类型定义</h1>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Object</span>
</span>
<h4 class="name" id="CalibrationParam">
<a class="href-link" href="#CalibrationParam">#</a>
<span class="code-name">
CalibrationParam
</span>
</h4>
<div class="description">
<p>标定参数</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>groundControlPointList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#GroundControlPoint">GroundControlPoint</a>></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Object</span>
</span>
<h4 class="name" id="CameraParam">
<a class="href-link" href="#CameraParam">#</a>
<span class="code-name">
CameraParam
</span>
</h4>
<div class="description">
<p>相机内外参数</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>cameraPosition</code></td>
<td class="type">
<span class="param-type">Array.<Number></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>heading</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>pitch</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>roll</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>hFOV</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>vFOV</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Object</span>
</span>
<h4 class="name" id="GCP">
<a class="href-link" href="#GCP">#</a>
<span class="code-name">
GCP
</span>
</h4>
<div class="description">
<p>Ground Control Point</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>pszId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Unique identifier, often numeric</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>pszInfo</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Informational message or ""</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfGCPPixel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Pixel (x) location of GCP on raster</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfGCPLine</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Line (y) location of GCP on raster</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfGCPX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>X position of GCP in georeferenced space</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfGCPY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Y position of GCP in georeferenced space</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>dfGCPZ</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Elevation of GCP, or zero if not known</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Object</span>
</span>
<h4 class="name" id="GroundControlPoint">
<a class="href-link" href="#GroundControlPoint">#</a>
<span class="code-name">
GroundControlPoint
</span>
</h4>
<div class="description">
<p>标定配准参数</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>控制点标识</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>控制的描述</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>pixelX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>控制点在图像上的像素坐标x分量</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>pixelY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>控制点在图像上的像素坐标y分量</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>控制点的地理坐标x分量</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>控制点的地理坐标y分量</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>控制点的地理坐标高程</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">Object</span>
</span>
<h4 class="name" id="VideoSource">
<a class="href-link" href="#VideoSource">#</a>
<span class="code-name">
VideoSource
</span>
</h4>
<div class="description">
<p>视频源数据</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>videoUrl</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>视频源地址</p></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>protocol</code></td>
<td class="type">
<span class="param-type">VideoSourceType</span>
</td>
<td class="description last"><p>视频传输协议</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
</div>
</div>
</div>
</article>
</section>
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>文档生成<a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
<p class="sidebar-created-by">
<a href="http://www.smaryun.com" target="_blank">司马云</a> <span>© 2023 云生态圈</span>
<a href="http://webclient.smaryun.com:8086/#/index" target="_blank">MapGIS Client for JavaScript</a>
</p>
</div>
</footer>
</div>
<div id="side-nav" class="side-nav">
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#page-title">构造函数</a>
</div>
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#member">成员变量</a>
</div>
<div style="margin-bottom: 10px;">
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#function">方法</a>
</div>
<div>
<img style="vertical-align: middle;margin-right: 10px;width: 30px;" src="./styles/anchor.png"/><a href="#event">事件</a>
</div>
</div>
</div>
<script src="scripts/linenumber.js"> </script>
<script src="scripts/search.js"> </script>
</body>
</html>