ms-vite-plugin 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/api/device.md +47 -0
- package/docs/apicn/device.md +47 -0
- package/docs/apipython/device.md +46 -0
- package/docs/httpapi/api.md +128 -0
- package/package.json +1 -1
package/docs/api/device.md
CHANGED
|
@@ -316,6 +316,53 @@ function setScreenBrightness(brightness: number): boolean;
|
|
|
316
316
|
device.setScreenBrightness(0.5);
|
|
317
317
|
```
|
|
318
318
|
|
|
319
|
+
### getVolume - 获取系统音量。
|
|
320
|
+
|
|
321
|
+
```typescript
|
|
322
|
+
function getVolume(): number;
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
**返回值:**
|
|
326
|
+
|
|
327
|
+
| 类型 | 描述 |
|
|
328
|
+
| -------- | ------------------------ |
|
|
329
|
+
| `number` | 系统音量,范围 `0.0-1.0` |
|
|
330
|
+
|
|
331
|
+
**示例:**
|
|
332
|
+
|
|
333
|
+
```typescript
|
|
334
|
+
// 获取系统音量
|
|
335
|
+
const volume = device.getVolume();
|
|
336
|
+
logi(`系统音量: ${volume}`);
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### setVolume - 设置系统音量。
|
|
340
|
+
|
|
341
|
+
设置系统音量,音量范围为 `0.0-1.0`。
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
function setVolume(volume: number): boolean;
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
**参数说明:**
|
|
348
|
+
|
|
349
|
+
| 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
|
|
350
|
+
| -------- | -------- | -------- | ------ | ---------------------------- |
|
|
351
|
+
| `volume` | `number` | 是 | - | 目标系统音量,范围 `0.0-1.0` |
|
|
352
|
+
|
|
353
|
+
**返回值:**
|
|
354
|
+
|
|
355
|
+
| 类型 | 描述 |
|
|
356
|
+
| --------- | ------------ |
|
|
357
|
+
| `boolean` | 是否设置成功 |
|
|
358
|
+
|
|
359
|
+
**示例:**
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
// 设置系统音量到 50%
|
|
363
|
+
device.setVolume(0.5);
|
|
364
|
+
```
|
|
365
|
+
|
|
319
366
|
### getOrientation - 获取屏幕方向。
|
|
320
367
|
|
|
321
368
|
**注意事项**
|
package/docs/apicn/device.md
CHANGED
|
@@ -330,6 +330,53 @@ function 设置屏幕亮度(亮度: 数字): 布尔值;
|
|
|
330
330
|
$设备.设置屏幕亮度(0.5);
|
|
331
331
|
```
|
|
332
332
|
|
|
333
|
+
### 获取音量
|
|
334
|
+
|
|
335
|
+
```typescript
|
|
336
|
+
function 获取音量(): 数字;
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
**返回值:**
|
|
340
|
+
|
|
341
|
+
| 类型 | 描述 |
|
|
342
|
+
| ---- | ------------------------ |
|
|
343
|
+
| 数字 | 系统音量,范围 `0.0-1.0` |
|
|
344
|
+
|
|
345
|
+
**示例:**
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
// 获取系统音量
|
|
349
|
+
const 音量 = $设备.获取音量();
|
|
350
|
+
$打印信息日志(`系统音量: ${音量}`);
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### 设置音量
|
|
354
|
+
|
|
355
|
+
设置系统音量,音量范围为 `0.0-1.0`。
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
function 设置音量(音量: 数字): 布尔值;
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
**参数说明:**
|
|
362
|
+
|
|
363
|
+
| 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
|
|
364
|
+
| ------ | ---- | -------- | ------ | ---------------------------- |
|
|
365
|
+
| `音量` | 数字 | 是 | - | 目标系统音量,范围 `0.0-1.0` |
|
|
366
|
+
|
|
367
|
+
**返回值:**
|
|
368
|
+
|
|
369
|
+
| 类型 | 描述 |
|
|
370
|
+
| ------ | ------------ |
|
|
371
|
+
| 布尔值 | 是否设置成功 |
|
|
372
|
+
|
|
373
|
+
**示例:**
|
|
374
|
+
|
|
375
|
+
```typescript
|
|
376
|
+
// 设置系统音量到 50%
|
|
377
|
+
$设备.设置音量(0.5);
|
|
378
|
+
```
|
|
379
|
+
|
|
333
380
|
### 获取屏幕方向
|
|
334
381
|
|
|
335
382
|
**注意事项**
|
package/docs/apipython/device.md
CHANGED
|
@@ -310,6 +310,52 @@ from kuaijs import device
|
|
|
310
310
|
device.setScreenBrightness(0.5)
|
|
311
311
|
```
|
|
312
312
|
|
|
313
|
+
### getVolume - 获取系统音量。
|
|
314
|
+
|
|
315
|
+
```python
|
|
316
|
+
def getVolume() -> float
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
**返回值:**
|
|
320
|
+
|
|
321
|
+
| 类型 | 描述 |
|
|
322
|
+
| ------- | ------------------------ |
|
|
323
|
+
| `float` | 系统音量,范围 `0.0-1.0` |
|
|
324
|
+
|
|
325
|
+
**示例:**
|
|
326
|
+
|
|
327
|
+
```python
|
|
328
|
+
from kuaijs import device
|
|
329
|
+
print(device.getVolume())
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### setVolume - 设置系统音量。
|
|
333
|
+
|
|
334
|
+
设置系统音量,音量范围为 `0.0-1.0`。
|
|
335
|
+
|
|
336
|
+
```python
|
|
337
|
+
def setVolume(volume: float) -> bool
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
**参数说明:**
|
|
341
|
+
|
|
342
|
+
| 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
|
|
343
|
+
| -------- | ------- | -------- | ------ | ---------------------------- |
|
|
344
|
+
| `volume` | `float` | 是 | - | 目标系统音量,范围 `0.0-1.0` |
|
|
345
|
+
|
|
346
|
+
**返回值:**
|
|
347
|
+
|
|
348
|
+
| 类型 | 描述 |
|
|
349
|
+
| ------ | ------------ |
|
|
350
|
+
| `bool` | 是否设置成功 |
|
|
351
|
+
|
|
352
|
+
**示例:**
|
|
353
|
+
|
|
354
|
+
```python
|
|
355
|
+
from kuaijs import device
|
|
356
|
+
device.setVolume(0.5)
|
|
357
|
+
```
|
|
358
|
+
|
|
313
359
|
### getOrientation - 获取屏幕方向。
|
|
314
360
|
|
|
315
361
|
**注意事项:**
|
package/docs/httpapi/api.md
CHANGED
|
@@ -300,6 +300,134 @@ GET /api/activeAppInfo
|
|
|
300
300
|
|»» bundleId|string|true|none|应用包名|none|
|
|
301
301
|
|»» pid|integer|true|none||none|
|
|
302
302
|
|
|
303
|
+
## GET 获取屏幕亮度
|
|
304
|
+
|
|
305
|
+
GET /api/getScreenBrightness
|
|
306
|
+
|
|
307
|
+
> 返回示例
|
|
308
|
+
|
|
309
|
+
> 200 Response
|
|
310
|
+
|
|
311
|
+
```json
|
|
312
|
+
{
|
|
313
|
+
"success": true,
|
|
314
|
+
"data": 0.5
|
|
315
|
+
}
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### 返回结果
|
|
319
|
+
|
|
320
|
+
|状态码|状态码含义|说明|数据模型|
|
|
321
|
+
|---|---|---|---|
|
|
322
|
+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
|
323
|
+
|
|
324
|
+
### 返回数据结构
|
|
325
|
+
|
|
326
|
+
状态码 **200**
|
|
327
|
+
|
|
328
|
+
|名称|类型|必选|约束|中文名|说明|
|
|
329
|
+
|---|---|---|---|---|---|
|
|
330
|
+
|» success|boolean|true|none|是否成功|none|
|
|
331
|
+
|» data|number|true|none|屏幕亮度|范围 `0.0-1.0`|
|
|
332
|
+
|
|
333
|
+
## GET 设置屏幕亮度
|
|
334
|
+
|
|
335
|
+
GET /api/setScreenBrightness
|
|
336
|
+
|
|
337
|
+
### 请求参数
|
|
338
|
+
|
|
339
|
+
|名称|位置|类型|必选|中文名|说明|
|
|
340
|
+
|---|---|---|---|---|---|
|
|
341
|
+
|brightness|query|number| 是 |屏幕亮度|范围 `0.0-1.0`|
|
|
342
|
+
|
|
343
|
+
> 返回示例
|
|
344
|
+
|
|
345
|
+
> 200 Response
|
|
346
|
+
|
|
347
|
+
```json
|
|
348
|
+
{
|
|
349
|
+
"success": true
|
|
350
|
+
}
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### 返回结果
|
|
354
|
+
|
|
355
|
+
|状态码|状态码含义|说明|数据模型|
|
|
356
|
+
|---|---|---|---|
|
|
357
|
+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
|
358
|
+
|
|
359
|
+
### 返回数据结构
|
|
360
|
+
|
|
361
|
+
状态码 **200**
|
|
362
|
+
|
|
363
|
+
|名称|类型|必选|约束|中文名|说明|
|
|
364
|
+
|---|---|---|---|---|---|
|
|
365
|
+
|» success|boolean|true|none|是否成功|none|
|
|
366
|
+
|
|
367
|
+
## GET 获取系统音量
|
|
368
|
+
|
|
369
|
+
GET /api/getVolume
|
|
370
|
+
|
|
371
|
+
> 返回示例
|
|
372
|
+
|
|
373
|
+
> 200 Response
|
|
374
|
+
|
|
375
|
+
```json
|
|
376
|
+
{
|
|
377
|
+
"success": true,
|
|
378
|
+
"data": 0.5
|
|
379
|
+
}
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### 返回结果
|
|
383
|
+
|
|
384
|
+
|状态码|状态码含义|说明|数据模型|
|
|
385
|
+
|---|---|---|---|
|
|
386
|
+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
|
387
|
+
|
|
388
|
+
### 返回数据结构
|
|
389
|
+
|
|
390
|
+
状态码 **200**
|
|
391
|
+
|
|
392
|
+
|名称|类型|必选|约束|中文名|说明|
|
|
393
|
+
|---|---|---|---|---|---|
|
|
394
|
+
|» success|boolean|true|none|是否成功|none|
|
|
395
|
+
|» data|number|true|none|系统音量|范围 `0.0-1.0`|
|
|
396
|
+
|
|
397
|
+
## GET 设置系统音量
|
|
398
|
+
|
|
399
|
+
GET /api/setVolume
|
|
400
|
+
|
|
401
|
+
### 请求参数
|
|
402
|
+
|
|
403
|
+
|名称|位置|类型|必选|中文名|说明|
|
|
404
|
+
|---|---|---|---|---|---|
|
|
405
|
+
|volume|query|number| 是 |系统音量|范围 `0.0-1.0`|
|
|
406
|
+
|
|
407
|
+
> 返回示例
|
|
408
|
+
|
|
409
|
+
> 200 Response
|
|
410
|
+
|
|
411
|
+
```json
|
|
412
|
+
{
|
|
413
|
+
"success": true
|
|
414
|
+
}
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### 返回结果
|
|
418
|
+
|
|
419
|
+
|状态码|状态码含义|说明|数据模型|
|
|
420
|
+
|---|---|---|---|
|
|
421
|
+
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
|
422
|
+
|
|
423
|
+
### 返回数据结构
|
|
424
|
+
|
|
425
|
+
状态码 **200**
|
|
426
|
+
|
|
427
|
+
|名称|类型|必选|约束|中文名|说明|
|
|
428
|
+
|---|---|---|---|---|---|
|
|
429
|
+
|» success|boolean|true|none|是否成功|none|
|
|
430
|
+
|
|
303
431
|
## POST 登录接口
|
|
304
432
|
|
|
305
433
|
POST /api/login
|