@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/ModelPOI.md

@@ -0,0 +1,279 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / ModelPOI
+
+# Class: ModelPOI
+
+模型气泡（ModelPOI）管理 API。
+
+## Agent Title
+
+模型气泡
+
+## Agent Capabilities
+
+模型气泡添加, 模型气泡删除, 模型气泡查询, 模型气泡更新, 分组显隐控制
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### add()
+
+> **add**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+添加模型气泡。
+默认值：`visible=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIAddRequest`](../../types/interfaces/ModelPOIAddRequest.md) | 创建参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.add(
+  { id: '123', groupName: 'cameraGroup', assetPath: 'dotPop', targetId: 'Camera01' },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### deleteById()
+
+> **deleteById**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+按编号批量删除模型气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIDeleteByIdRequest`](../../types/interfaces/ModelPOIDeleteByIdRequest.md) | 删除参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.deleteById({ groupName: 'cameraGroup', ids: ['Camera01'] }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### deleteByGroup()
+
+> **deleteByGroup**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+删除指定组下全部模型气泡。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIDeleteByGroupRequest`](../../types/interfaces/ModelPOIDeleteByGroupRequest.md) | 删除组参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.deleteByGroup({ groupName: 'myGroup' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getPOIInfo()
+
+> **getPOIInfo**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取单个模型气泡信息。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIGetInfoRequest`](../../types/interfaces/ModelPOIGetInfoRequest.md) | 查询参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.getPOIInfo({ groupName: 'cameraGroup', id: 'Camera01' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### update()
+
+> **update**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+更新模型气泡信息。
+默认值：`visible=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIUpdateRequest`](../../types/interfaces/ModelPOIUpdateRequest.md) | 更新参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.update(
+  { id: '123', groupName: 'cameraGroup', assetPath: 'dotPop', visible: false },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### setVisibleByGroup()
+
+> **setVisibleByGroup**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置指定组模型气泡显隐。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelPOIVisibleByGroupRequest`](../../types/interfaces/ModelPOIVisibleByGroupRequest.md) | 组显隐参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelPOI.setVisibleByGroup({ groupName: 'myGroup', visible: true }, (result) => {
+  console.log(result);
+});
+```