@ray-js/api 0.6.22-beta-2 → 0.6.25
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/@types/BaseKit.d.ts +1345 -1357
- package/@types/MiniKit.d.ts +9 -10
- package/lib/BaseKit-3.0.0.d.ts +80 -80
- package/lib/DeviceKit-3.0.0.d.ts +0 -1
- package/lib/DeviceKit-3.0.0.js +3 -4
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/panel/README.md +3 -0
- package/lib/panel/index.d.ts +4 -0
- package/lib/panel/index.js +6 -0
- package/package.json +7 -5
package/@types/BaseKit.d.ts
CHANGED
@@ -1543,858 +1543,1321 @@ declare namespace ty {
|
|
1543
1543
|
encoding?: string
|
1544
1544
|
}
|
1545
1545
|
|
1546
|
-
export
|
1546
|
+
export type HTTPMethod =
|
1547
1547
|
/** HTTP 请求 OPTIONS */
|
1548
|
-
|
1548
|
+
| 'OPTIONS'
|
1549
1549
|
|
1550
1550
|
/** HTTP 请求 GET */
|
1551
|
-
|
1551
|
+
| 'GET'
|
1552
1552
|
|
1553
1553
|
/** HTTP 请求 HEAD */
|
1554
|
-
|
1554
|
+
| 'HEAD'
|
1555
1555
|
|
1556
1556
|
/** HTTP 请求 POST */
|
1557
|
-
|
1557
|
+
| 'POST'
|
1558
1558
|
|
1559
1559
|
/** HTTP 请求 PUT */
|
1560
|
-
|
1560
|
+
| 'PUT'
|
1561
1561
|
|
1562
1562
|
/** HTTP 请求 DELETE */
|
1563
|
-
|
1563
|
+
| 'DELETE'
|
1564
1564
|
|
1565
1565
|
/** HTTP 请求 TRACE */
|
1566
|
-
|
1566
|
+
| 'TRACE'
|
1567
1567
|
|
1568
1568
|
/** HTTP 请求 TRACE */
|
1569
|
-
|
1570
|
-
}
|
1569
|
+
| 'CONNECT'
|
1571
1570
|
|
1572
|
-
export
|
1571
|
+
export type AccelerometerInterval =
|
1573
1572
|
/** 适用于更新游戏的回调频率,在 20ms/次 左右 */
|
1574
|
-
|
1573
|
+
| 'game'
|
1575
1574
|
|
1576
1575
|
/** 适用于更新 UI 的回调频率,在 60ms/次 左右 */
|
1577
|
-
|
1576
|
+
| 'ui'
|
1578
1577
|
|
1579
1578
|
/** 普通的回调频率,在 200ms/次 左右 */
|
1580
|
-
|
1581
|
-
}
|
1579
|
+
| 'normal'
|
1582
1580
|
|
1583
|
-
export
|
1581
|
+
export type DeviceMotionInterval =
|
1584
1582
|
/** 适用于更新游戏的回调频率,在 20ms/次 左右 */
|
1585
|
-
|
1583
|
+
| 'game'
|
1586
1584
|
|
1587
1585
|
/** 适用于更新 UI 的回调频率,在 60ms/次 左右 */
|
1588
|
-
|
1586
|
+
| 'ui'
|
1589
1587
|
|
1590
1588
|
/** 普通的回调频率,在 200ms/次 左右 */
|
1591
|
-
|
1592
|
-
|
1589
|
+
| 'normal'
|
1590
|
+
}
|
1593
1591
|
|
1594
|
-
|
1595
|
-
|
1596
|
-
|
1592
|
+
export type GyroscopeInterval =
|
1593
|
+
/** 适用于更新游戏的回调频率,在 20ms/次 左右 */
|
1594
|
+
| 'game'
|
1597
1595
|
|
1598
|
-
|
1599
|
-
|
1596
|
+
/** 适用于更新 UI 的回调频率,在 60ms/次 左右 */
|
1597
|
+
| 'ui'
|
1600
1598
|
|
1601
|
-
|
1602
|
-
|
1603
|
-
}
|
1599
|
+
/** 普通的回调频率,在 200ms/次 左右 */
|
1600
|
+
| 'normal'
|
1604
1601
|
|
1605
|
-
|
1606
|
-
|
1607
|
-
|
1608
|
-
|
1609
|
-
|
1610
|
-
|
1602
|
+
export type TempFileCB = {
|
1603
|
+
/** 本地临时文件路径 (本地路径) */
|
1604
|
+
path: string
|
1605
|
+
/** 本地临时文件大小,单位 B */
|
1606
|
+
size?: number
|
1607
|
+
}
|
1611
1608
|
|
1612
|
-
|
1613
|
-
|
1614
|
-
|
1615
|
-
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1623
|
-
|
1624
|
-
|
1625
|
-
|
1626
|
-
|
1627
|
-
|
1628
|
-
|
1629
|
-
|
1630
|
-
|
1631
|
-
|
1609
|
+
export type TempMediaFileCB = {
|
1610
|
+
/** 本地临时文件路径 (本地路径) */
|
1611
|
+
tempFilePath: string
|
1612
|
+
/** 本地临时文件大小,单位 B */
|
1613
|
+
size: number
|
1614
|
+
/** 视频的时间长度 */
|
1615
|
+
duration: number
|
1616
|
+
/** 视频的高度 */
|
1617
|
+
height: number
|
1618
|
+
/** 视频的宽度 */
|
1619
|
+
width: number
|
1620
|
+
/** 视频缩略图临时文件路径 */
|
1621
|
+
thumbTempFilePath: string
|
1622
|
+
/**
|
1623
|
+
* 文件类型
|
1624
|
+
* 'image' 图片
|
1625
|
+
* 'video' 视频
|
1626
|
+
*/
|
1627
|
+
fileType: string
|
1628
|
+
}
|
1632
1629
|
|
1633
|
-
|
1634
|
-
|
1635
|
-
|
1636
|
-
|
1637
|
-
|
1638
|
-
|
1639
|
-
|
1640
|
-
|
1630
|
+
export type SafeArea = {
|
1631
|
+
left: number
|
1632
|
+
right: number
|
1633
|
+
top: number
|
1634
|
+
bottom: number
|
1635
|
+
width: number
|
1636
|
+
height: number
|
1637
|
+
}
|
1641
1638
|
|
1642
|
-
|
1643
|
-
dark = 'dark',
|
1639
|
+
export type Themes = 'dark' | 'light'
|
1644
1640
|
|
1645
|
-
|
1646
|
-
}
|
1641
|
+
export type Orientation = 'portrait' | 'landscape'
|
1647
1642
|
|
1648
|
-
|
1649
|
-
|
1643
|
+
export type StorageDataBean = {
|
1644
|
+
/** 本地缓存中指定的 key */
|
1645
|
+
key: string
|
1646
|
+
/** key对应的内容 */
|
1647
|
+
data: string
|
1648
|
+
}
|
1650
1649
|
|
1651
|
-
|
1652
|
-
|
1650
|
+
export type StorageKeyBean = {
|
1651
|
+
/** 本地缓存中指定的 key */
|
1652
|
+
key: string
|
1653
|
+
}
|
1653
1654
|
|
1654
|
-
|
1655
|
-
|
1656
|
-
|
1657
|
-
|
1658
|
-
data: string
|
1659
|
-
}
|
1655
|
+
export type CurrentVolumeResponse = {
|
1656
|
+
/** 音量,阈值【0 - 1】 */
|
1657
|
+
value: number
|
1658
|
+
}
|
1660
1659
|
|
1661
|
-
|
1662
|
-
|
1663
|
-
|
1664
|
-
|
1660
|
+
export type WifiListResponse = {
|
1661
|
+
/** Wi-Fi列表 */
|
1662
|
+
wifiList: WifiInfo[]
|
1663
|
+
}
|
1665
1664
|
|
1666
|
-
|
1667
|
-
|
1668
|
-
|
1669
|
-
|
1665
|
+
export type AudioRecordBufferBean = {
|
1666
|
+
/** 数据流 */
|
1667
|
+
buffer: number[]
|
1668
|
+
}
|
1670
1669
|
|
1671
|
-
|
1672
|
-
|
1673
|
-
|
1674
|
-
|
1670
|
+
export type InnerAudioContext = {
|
1671
|
+
/** InnerAudioContext 对象 ContextId */
|
1672
|
+
contextId: string
|
1673
|
+
}
|
1675
1674
|
|
1676
|
-
|
1677
|
-
|
1678
|
-
|
1679
|
-
|
1675
|
+
export type AudioFileParams = {
|
1676
|
+
/** 音频文件路径 */
|
1677
|
+
path: string
|
1678
|
+
}
|
1680
1679
|
|
1681
|
-
|
1682
|
-
|
1683
|
-
|
1684
|
-
|
1680
|
+
export type AudioFileResponse = {
|
1681
|
+
/** 音频时长 */
|
1682
|
+
duration: number
|
1683
|
+
}
|
1685
1684
|
|
1686
|
-
|
1687
|
-
|
1688
|
-
|
1689
|
-
|
1685
|
+
export type InnerAudioBean = {
|
1686
|
+
/**
|
1687
|
+
* InnerAudioContext 对象 contextId
|
1688
|
+
* 需要传递createInnerAudioContext方法创建的InnerAudioContext对象Id才能找到播放实例
|
1689
|
+
*/
|
1690
|
+
contextId: string
|
1691
|
+
/** src 音频资源的地址 */
|
1692
|
+
src: string
|
1693
|
+
/** startTime 开始播放的位置 */
|
1694
|
+
startTime?: number
|
1695
|
+
/** autoplay 是否自动开始播放 */
|
1696
|
+
autoplay?: boolean
|
1697
|
+
/** 是否循环播放,默认为 false */
|
1698
|
+
loop?: boolean
|
1699
|
+
/** 音量。范围 0~1。默认为 1 */
|
1700
|
+
volume?: number
|
1701
|
+
/** 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
|
1702
|
+
playbackRate?: number
|
1703
|
+
}
|
1690
1704
|
|
1691
|
-
|
1692
|
-
|
1693
|
-
|
1694
|
-
|
1705
|
+
export type InnerAudioSeekBean = {
|
1706
|
+
/** InnerAudioContext 对象 ContextId */
|
1707
|
+
contextId: string
|
1708
|
+
/** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
|
1709
|
+
position?: number
|
1710
|
+
}
|
1695
1711
|
|
1696
|
-
|
1697
|
-
|
1698
|
-
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
|
1703
|
-
|
1704
|
-
|
1705
|
-
|
1706
|
-
|
1707
|
-
|
1708
|
-
|
1709
|
-
|
1710
|
-
/** 音量。范围 0~1。默认为 1 */
|
1711
|
-
volume?: number
|
1712
|
-
/** 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
|
1713
|
-
playbackRate?: number
|
1714
|
-
}
|
1712
|
+
export type AuthorizeBean = {
|
1713
|
+
/**
|
1714
|
+
* scope 权限名称
|
1715
|
+
* 举例子:
|
1716
|
+
* scope.bluetooth 蓝牙权限
|
1717
|
+
* scope.writePhotosAlbum 写入相册权限
|
1718
|
+
* scope.userLocationBackground 后台定位权限
|
1719
|
+
* scope.record 麦克风权限
|
1720
|
+
* scope.camera 摄像头权限
|
1721
|
+
* scope.userLocation 低精度定位权限
|
1722
|
+
* scope.userPreciseLocation 高精度定位权限
|
1723
|
+
*/
|
1724
|
+
scope: string
|
1725
|
+
}
|
1715
1726
|
|
1716
|
-
|
1717
|
-
|
1718
|
-
|
1719
|
-
|
1720
|
-
|
1721
|
-
|
1727
|
+
export type ToMiniProgramBean = {
|
1728
|
+
/** 要打开的小程序appId */
|
1729
|
+
appId?: string
|
1730
|
+
/** 打开的页面路径,如果为空则打开首页,path 中 ? 后面的部分会成为 query,在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数 */
|
1731
|
+
path?: string
|
1732
|
+
/** 打开小程序的转场方式,分为right|bottom,指代水平和竖直方向 */
|
1733
|
+
position?: string
|
1734
|
+
/** 传递给目标小程序的数据,目标小程序可在 `App.onLaunch`,`App.onShow` 中获取到这份数据 */
|
1735
|
+
extraData?: Record<string, any>
|
1736
|
+
/** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版 */
|
1737
|
+
envVersion?: string
|
1738
|
+
/** 小程序链接,当传递该参数后,可以不传 appId 和 path */
|
1739
|
+
shortLink?: string
|
1740
|
+
}
|
1722
1741
|
|
1723
|
-
|
1724
|
-
|
1725
|
-
|
1726
|
-
|
1727
|
-
* scope.bluetooth 蓝牙权限
|
1728
|
-
* scope.writePhotosAlbum 写入相册权限
|
1729
|
-
* scope.userLocationBackground 后台定位权限
|
1730
|
-
* scope.record 麦克风权限
|
1731
|
-
* scope.camera 摄像头权限
|
1732
|
-
* scope.userLocation 低精度定位权限
|
1733
|
-
* scope.userPreciseLocation 高精度定位权限
|
1734
|
-
*/
|
1735
|
-
scope: string
|
1736
|
-
}
|
1742
|
+
export type DeviceMotionBean = {
|
1743
|
+
/** 监听加速度数据回调函数的执行频率 */
|
1744
|
+
interval?: DeviceMotionInterval
|
1745
|
+
}
|
1737
1746
|
|
1738
|
-
|
1739
|
-
|
1740
|
-
|
1741
|
-
|
1742
|
-
|
1743
|
-
|
1744
|
-
|
1745
|
-
|
1746
|
-
|
1747
|
-
|
1748
|
-
|
1749
|
-
|
1750
|
-
shortLink?: string
|
1751
|
-
}
|
1747
|
+
export type DownLoadBean = {
|
1748
|
+
/** 网络请求id */
|
1749
|
+
requestId: string
|
1750
|
+
/** 下载资源的 url */
|
1751
|
+
url: string
|
1752
|
+
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
1753
|
+
header?: Record<string, string>
|
1754
|
+
/** 超时时间,单位为毫秒 */
|
1755
|
+
timeout?: number
|
1756
|
+
/** 指定文件下载后存储的路径 (本地路径) */
|
1757
|
+
filePath?: string
|
1758
|
+
}
|
1752
1759
|
|
1753
|
-
|
1754
|
-
|
1755
|
-
|
1756
|
-
|
1760
|
+
export type DownLoadResult = {
|
1761
|
+
/** 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 */
|
1762
|
+
tempFilePath: string
|
1763
|
+
/** 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 */
|
1764
|
+
filePath: string
|
1765
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
1766
|
+
statusCode: number
|
1767
|
+
/** 网络请求过程中一些调试信息 */
|
1768
|
+
profile: Profile
|
1769
|
+
}
|
1757
1770
|
|
1758
|
-
|
1759
|
-
|
1760
|
-
|
1761
|
-
|
1762
|
-
url: string
|
1763
|
-
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
1764
|
-
header?: Record<string, string>
|
1765
|
-
/** 超时时间,单位为毫秒 */
|
1766
|
-
timeout?: number
|
1767
|
-
/** 指定文件下载后存储的路径 (本地路径) */
|
1768
|
-
filePath?: string
|
1769
|
-
}
|
1771
|
+
export type RequestBean = {
|
1772
|
+
/** 网络请求id */
|
1773
|
+
requestId: string
|
1774
|
+
}
|
1770
1775
|
|
1771
|
-
|
1772
|
-
|
1773
|
-
|
1774
|
-
|
1775
|
-
filePath: string
|
1776
|
-
/** 开发者服务器返回的 HTTP 状态码 */
|
1777
|
-
statusCode: number
|
1778
|
-
/** 网络请求过程中一些调试信息 */
|
1779
|
-
profile: Profile
|
1780
|
-
}
|
1776
|
+
export type AccessFileParams = {
|
1777
|
+
/** 要判断是否存在的文件/目录路径 (本地路径) */
|
1778
|
+
path: string
|
1779
|
+
}
|
1781
1780
|
|
1782
|
-
|
1783
|
-
|
1784
|
-
|
1785
|
-
|
1781
|
+
export type ReadFileBean = {
|
1782
|
+
/** 文件内容 */
|
1783
|
+
data: string
|
1784
|
+
}
|
1786
1785
|
|
1787
|
-
|
1788
|
-
|
1789
|
-
|
1790
|
-
|
1786
|
+
export type SaveFileSyncCallback = {
|
1787
|
+
/** 【待废弃, 不建议使用】存储后的文件路径 */
|
1788
|
+
savedFilePath: string
|
1789
|
+
}
|
1791
1790
|
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1791
|
+
export type FileStatsResponse = {
|
1792
|
+
/** 文件列表 */
|
1793
|
+
fileStatsList: FileStats[]
|
1794
|
+
}
|
1796
1795
|
|
1797
|
-
|
1798
|
-
|
1799
|
-
|
1800
|
-
|
1796
|
+
export type RemoveFileParams = {
|
1797
|
+
/** taskId */
|
1798
|
+
fileId: string
|
1799
|
+
/** 需要删除的文件路径 (本地路径) */
|
1800
|
+
filePath: string
|
1801
|
+
}
|
1801
1802
|
|
1802
|
-
|
1803
|
-
|
1804
|
-
|
1805
|
-
|
1803
|
+
export type GyroscopeBean = {
|
1804
|
+
/** 监听陀螺仪数据回调函数的执行频率 */
|
1805
|
+
interval?: GyroscopeInterval
|
1806
|
+
}
|
1806
1807
|
|
1807
|
-
|
1808
|
-
|
1809
|
-
|
1810
|
-
|
1811
|
-
|
1812
|
-
|
1808
|
+
export type ChooseImageBean = {
|
1809
|
+
/** 最多可以选择的图片张数 */
|
1810
|
+
count?: number
|
1811
|
+
/** sizeType ['original', 'compressed'] */
|
1812
|
+
sizeType?: string[]
|
1813
|
+
/** 选择图片的来源 ['album', 'camera'] */
|
1814
|
+
sourceType?: string[]
|
1815
|
+
}
|
1813
1816
|
|
1814
|
-
|
1815
|
-
|
1816
|
-
|
1817
|
-
|
1817
|
+
export type ChooseImageCB = {
|
1818
|
+
/** 图片的本地临时文件路径列表 (本地路径) */
|
1819
|
+
tempFilePaths: string[]
|
1820
|
+
/** sizeType ['original', 'compressed'] */
|
1821
|
+
tempFiles?: TempFileCB[]
|
1822
|
+
}
|
1818
1823
|
|
1819
|
-
|
1820
|
-
|
1821
|
-
|
1822
|
-
|
1823
|
-
|
1824
|
-
|
1825
|
-
|
1826
|
-
|
1824
|
+
export type ChooseMediaBean = {
|
1825
|
+
/** 最多可以选择的文件数 */
|
1826
|
+
count?: number
|
1827
|
+
/**
|
1828
|
+
* 选择类型, 默认图片
|
1829
|
+
* 'image' 只能拍摄图片或从相册选择图片
|
1830
|
+
* 'video' 只能拍摄视频或从相册选择视频
|
1831
|
+
*/
|
1832
|
+
mediaType?: string
|
1833
|
+
/**
|
1834
|
+
* 图片和视频选择的来源, 默认['album', 'camera']
|
1835
|
+
* 'album' 从相册选择
|
1836
|
+
* 'camera' 使用相机拍摄
|
1837
|
+
*/
|
1838
|
+
sourceType?: string[]
|
1839
|
+
/**
|
1840
|
+
* 拍摄视频最长拍摄时间,单位秒。默认10s
|
1841
|
+
* 时间范围为 3s 至 60s 之间。不限制相册。
|
1842
|
+
*/
|
1843
|
+
maxDuration?: number
|
1844
|
+
}
|
1827
1845
|
|
1828
|
-
|
1829
|
-
|
1830
|
-
|
1831
|
-
|
1832
|
-
|
1833
|
-
|
1846
|
+
export type ChooseMediaCB = {
|
1847
|
+
/**
|
1848
|
+
* 文件类型
|
1849
|
+
* 'image' 图片
|
1850
|
+
* 'video' 视频
|
1851
|
+
*/
|
1852
|
+
type: string
|
1853
|
+
/** 本地临时文件列表 */
|
1854
|
+
tempFiles?: TempMediaFileCB[]
|
1855
|
+
}
|
1834
1856
|
|
1835
|
-
|
1836
|
-
|
1837
|
-
|
1838
|
-
|
1839
|
-
* 选择类型, 默认图片
|
1840
|
-
* 'image' 只能拍摄图片或从相册选择图片
|
1841
|
-
* 'video' 只能拍摄视频或从相册选择视频
|
1842
|
-
*/
|
1843
|
-
mediaType?: string
|
1844
|
-
/**
|
1845
|
-
* 图片和视频选择的来源, 默认['album', 'camera']
|
1846
|
-
* 'album' 从相册选择
|
1847
|
-
* 'camera' 使用相机拍摄
|
1848
|
-
*/
|
1849
|
-
sourceType?: string[]
|
1850
|
-
/**
|
1851
|
-
* 拍摄视频最长拍摄时间,单位秒。默认10s
|
1852
|
-
* 时间范围为 3s 至 60s 之间。不限制相册。
|
1853
|
-
*/
|
1854
|
-
maxDuration?: number
|
1855
|
-
}
|
1857
|
+
export type ChooseCropImageBean = {
|
1858
|
+
/** 选择图片的来源 ['album', 'camera'],默认都支持 */
|
1859
|
+
sourceType?: string[]
|
1860
|
+
}
|
1856
1861
|
|
1857
|
-
|
1858
|
-
|
1859
|
-
|
1860
|
-
|
1861
|
-
* 'video' 视频
|
1862
|
-
*/
|
1863
|
-
type: string
|
1864
|
-
/** 本地临时文件列表 */
|
1865
|
-
tempFiles?: TempMediaFileCB[]
|
1866
|
-
}
|
1862
|
+
export type ChooseCropImageCB = {
|
1863
|
+
/** 文件路径 */
|
1864
|
+
path: string
|
1865
|
+
}
|
1867
1866
|
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1867
|
+
export type PreviewImageBean = {
|
1868
|
+
/** 需要预览的图片链接列表 */
|
1869
|
+
urls: string[]
|
1870
|
+
/** 当前显示图片的链接 */
|
1871
|
+
current: number
|
1872
|
+
}
|
1872
1873
|
|
1873
|
-
|
1874
|
-
|
1875
|
-
|
1876
|
-
|
1874
|
+
export type GetImageInfoParams = {
|
1875
|
+
/** 图片的路径,支持网络路径、本地路径 */
|
1876
|
+
src: string
|
1877
|
+
}
|
1877
1878
|
|
1878
|
-
|
1879
|
-
|
1880
|
-
|
1881
|
-
|
1882
|
-
|
1883
|
-
|
1879
|
+
export type ImageInfoCB = {
|
1880
|
+
/** 图片原始宽度,单位px。不考虑旋转。 */
|
1881
|
+
width: number
|
1882
|
+
/** 图片原始高度,单位px。不考虑旋转。 */
|
1883
|
+
height: number
|
1884
|
+
/**
|
1885
|
+
* 拍照时设备方向
|
1886
|
+
* 合法值 说明
|
1887
|
+
* up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
|
1888
|
+
* up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
|
1889
|
+
* down 旋转180度,对应 Exif 中的 3
|
1890
|
+
* down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
|
1891
|
+
* left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
|
1892
|
+
* right 顺时针旋转90度,对应 Exif 中的 6
|
1893
|
+
* right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
|
1894
|
+
* left 逆时针旋转90度,对应 Exif 中的 8
|
1895
|
+
*/
|
1896
|
+
orientation: string
|
1897
|
+
/**
|
1898
|
+
* 图片格式。
|
1899
|
+
* 合法值 说明
|
1900
|
+
* unknown 未知格式
|
1901
|
+
* jpeg jpeg压缩格式
|
1902
|
+
* png png压缩格式
|
1903
|
+
* gif gif压缩格式
|
1904
|
+
* tiff tiff压缩格式
|
1905
|
+
*/
|
1906
|
+
type: string
|
1907
|
+
}
|
1884
1908
|
|
1885
|
-
|
1886
|
-
|
1887
|
-
|
1888
|
-
|
1909
|
+
export type GetVideoInfoParams = {
|
1910
|
+
/** 视频文件路径,可以是临时文件路径也可以是永久文件路径 */
|
1911
|
+
src: string
|
1912
|
+
}
|
1889
1913
|
|
1890
|
-
|
1891
|
-
|
1892
|
-
|
1893
|
-
|
1894
|
-
|
1895
|
-
|
1896
|
-
|
1897
|
-
|
1898
|
-
|
1899
|
-
|
1900
|
-
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
|
1909
|
-
|
1910
|
-
|
1911
|
-
|
1912
|
-
|
1913
|
-
|
1914
|
-
|
1915
|
-
|
1916
|
-
|
1917
|
-
|
1918
|
-
|
1914
|
+
export type VideoInfoCB = {
|
1915
|
+
/** 图片原始宽度,单位px。不考虑旋转。 */
|
1916
|
+
width: number
|
1917
|
+
/** 图片原始高度,单位px。不考虑旋转。 */
|
1918
|
+
height: number
|
1919
|
+
/**
|
1920
|
+
* 画面方向
|
1921
|
+
* 合法值 说明
|
1922
|
+
* up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
|
1923
|
+
* up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
|
1924
|
+
* down 旋转180度,对应 Exif 中的 3
|
1925
|
+
* down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
|
1926
|
+
* left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
|
1927
|
+
* right 顺时针旋转90度,对应 Exif 中的 6
|
1928
|
+
* right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
|
1929
|
+
* left 逆时针旋转90度,对应 Exif 中的 8
|
1930
|
+
*/
|
1931
|
+
orientation: string
|
1932
|
+
/** 视频格式 */
|
1933
|
+
type: string
|
1934
|
+
/** 视频时长 */
|
1935
|
+
duration: number
|
1936
|
+
/** 视频大小,单位 kB */
|
1937
|
+
size: number
|
1938
|
+
/** 视频帧率 */
|
1939
|
+
fps: number
|
1940
|
+
/** 视频码率,单位 kbps */
|
1941
|
+
bitrate: number
|
1942
|
+
}
|
1919
1943
|
|
1920
|
-
|
1921
|
-
|
1922
|
-
|
1923
|
-
|
1944
|
+
export type SaveVideoParams = {
|
1945
|
+
/** 视频文件路径,可以是临时文件路径也可以是永久文件路径 (本地路径) */
|
1946
|
+
filePath: string
|
1947
|
+
}
|
1924
1948
|
|
1925
|
-
|
1926
|
-
|
1927
|
-
|
1928
|
-
|
1929
|
-
|
1930
|
-
|
1931
|
-
|
1932
|
-
|
1933
|
-
|
1934
|
-
|
1935
|
-
|
1936
|
-
|
1937
|
-
* left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
|
1938
|
-
* right 顺时针旋转90度,对应 Exif 中的 6
|
1939
|
-
* right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
|
1940
|
-
* left 逆时针旋转90度,对应 Exif 中的 8
|
1941
|
-
*/
|
1942
|
-
orientation: string
|
1943
|
-
/** 视频格式 */
|
1944
|
-
type: string
|
1945
|
-
/** 视频时长 */
|
1946
|
-
duration: number
|
1947
|
-
/** 视频大小,单位 kB */
|
1948
|
-
size: number
|
1949
|
-
/** 视频帧率 */
|
1950
|
-
fps: number
|
1951
|
-
/** 视频码率,单位 kbps */
|
1952
|
-
bitrate: number
|
1953
|
-
}
|
1949
|
+
export type ToastBean = {
|
1950
|
+
/** 提示的内容 */
|
1951
|
+
title: string
|
1952
|
+
/** 图标 'success' / 'error' / 'loading' / 'none' */
|
1953
|
+
icon?: string
|
1954
|
+
/** 自定义图标的本地路径,image 的优先级高于 icon */
|
1955
|
+
image?: string
|
1956
|
+
/** 提示的延迟时间 */
|
1957
|
+
duration?: number
|
1958
|
+
/** 是否显示透明蒙层,防止触摸穿透 */
|
1959
|
+
mask?: boolean
|
1960
|
+
}
|
1954
1961
|
|
1955
|
-
|
1956
|
-
|
1957
|
-
|
1958
|
-
|
1962
|
+
export type ModalBean = {
|
1963
|
+
/** 提示的标题 */
|
1964
|
+
title: string
|
1965
|
+
/** 提示的内容 */
|
1966
|
+
content?: string
|
1967
|
+
/** 是否显示取消按钮 */
|
1968
|
+
showCancel?: boolean
|
1969
|
+
/** 取消按钮的文字,最多 4 个字符 */
|
1970
|
+
cancelText?: string
|
1971
|
+
/** 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
|
1972
|
+
cancelColor?: string
|
1973
|
+
/** 确认按钮的文字,最多 4 个字符 */
|
1974
|
+
confirmText?: string
|
1975
|
+
/** 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
|
1976
|
+
confirmColor?: string
|
1977
|
+
}
|
1959
1978
|
|
1960
|
-
|
1961
|
-
|
1962
|
-
|
1963
|
-
|
1964
|
-
|
1965
|
-
|
1966
|
-
image?: string
|
1967
|
-
/** 提示的延迟时间 */
|
1968
|
-
duration?: number
|
1969
|
-
/** 是否显示透明蒙层,防止触摸穿透 */
|
1970
|
-
mask?: boolean
|
1971
|
-
}
|
1979
|
+
export type ModalCallback = {
|
1980
|
+
/** 为 true 时,表示用户点击了确定按钮 */
|
1981
|
+
confirm: boolean
|
1982
|
+
/** 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
|
1983
|
+
cancel: boolean
|
1984
|
+
}
|
1972
1985
|
|
1973
|
-
|
1974
|
-
|
1975
|
-
|
1976
|
-
|
1977
|
-
|
1978
|
-
|
1979
|
-
showCancel?: boolean
|
1980
|
-
/** 取消按钮的文字,最多 4 个字符 */
|
1981
|
-
cancelText?: string
|
1982
|
-
/** 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
|
1983
|
-
cancelColor?: string
|
1984
|
-
/** 确认按钮的文字,最多 4 个字符 */
|
1985
|
-
confirmText?: string
|
1986
|
-
/** 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
|
1987
|
-
confirmColor?: string
|
1988
|
-
}
|
1986
|
+
export type LoadingBean = {
|
1987
|
+
/** 提示的内容 */
|
1988
|
+
title: string
|
1989
|
+
/** 是否显示透明蒙层,防止触摸穿透 */
|
1990
|
+
mask?: boolean
|
1991
|
+
}
|
1989
1992
|
|
1990
|
-
|
1991
|
-
|
1992
|
-
|
1993
|
-
|
1994
|
-
|
1995
|
-
|
1993
|
+
export type ActionSheet = {
|
1994
|
+
/** 警示文案 */
|
1995
|
+
alertText?: string
|
1996
|
+
/** 按钮的文字数组,数组长度最大为 6 */
|
1997
|
+
itemList: string[]
|
1998
|
+
/** 按钮的文字颜色 */
|
1999
|
+
itemColor?: string
|
2000
|
+
}
|
1996
2001
|
|
1997
|
-
|
1998
|
-
|
1999
|
-
|
2000
|
-
|
2001
|
-
mask?: boolean
|
2002
|
-
}
|
2003
|
-
|
2004
|
-
export type ActionSheet = {
|
2005
|
-
/** 警示文案 */
|
2006
|
-
alertText?: string
|
2007
|
-
/** 按钮的文字数组,数组长度最大为 6 */
|
2008
|
-
itemList: string[]
|
2009
|
-
/** 按钮的文字颜色 */
|
2010
|
-
itemColor?: string
|
2011
|
-
}
|
2012
|
-
|
2013
|
-
export type ActionSheetCallback = {
|
2014
|
-
/** 用户点击的按钮序号,从上到下的顺序,从0开始 */
|
2015
|
-
tapIndex: number
|
2016
|
-
}
|
2002
|
+
export type ActionSheetCallback = {
|
2003
|
+
/** 用户点击的按钮序号,从上到下的顺序,从0开始 */
|
2004
|
+
tapIndex: number
|
2005
|
+
}
|
2017
2006
|
|
2018
|
-
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2029
|
-
|
2030
|
-
|
2031
|
-
|
2032
|
-
|
2033
|
-
|
2034
|
-
|
2035
|
-
|
2036
|
-
|
2037
|
-
|
2038
|
-
|
2039
|
-
|
2040
|
-
|
2041
|
-
|
2007
|
+
export type HTTPRequest = {
|
2008
|
+
/** 开发者服务器接口地址 */
|
2009
|
+
url: string
|
2010
|
+
/** 网络请求 id */
|
2011
|
+
taskId: string
|
2012
|
+
/** 请求的参数 */
|
2013
|
+
data?: string
|
2014
|
+
/** 设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json */
|
2015
|
+
header?: Record<string, string>
|
2016
|
+
/** 超时时间,单位为毫秒 */
|
2017
|
+
timeout?: number
|
2018
|
+
/** HTTP 请求方法 */
|
2019
|
+
method?: HTTPMethod
|
2020
|
+
/** 返回的数据格式 */
|
2021
|
+
dataType?: any
|
2022
|
+
/** 返回的数据类型 */
|
2023
|
+
responseType?: string
|
2024
|
+
/** enableHttp2 */
|
2025
|
+
enableHttp2?: boolean
|
2026
|
+
/** enableQuic */
|
2027
|
+
enableQuic?: boolean
|
2028
|
+
/** enableCache */
|
2029
|
+
enableCache?: boolean
|
2030
|
+
}
|
2042
2031
|
|
2043
|
-
|
2044
|
-
|
2045
|
-
|
2046
|
-
|
2047
|
-
|
2048
|
-
|
2049
|
-
|
2050
|
-
|
2051
|
-
|
2052
|
-
|
2053
|
-
|
2054
|
-
|
2055
|
-
|
2056
|
-
|
2032
|
+
export type SuccessResult = {
|
2033
|
+
/** 开发者服务器返回的数据 */
|
2034
|
+
data: string
|
2035
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
2036
|
+
statusCode: number
|
2037
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2038
|
+
header: Record<string, string>
|
2039
|
+
/** 开发者服务器返回的 cookies,格式为字符串数组 */
|
2040
|
+
cookies: string[]
|
2041
|
+
/** 网络请求过程中一些调试信息 */
|
2042
|
+
profile: Profile
|
2043
|
+
/** 网络请求id,用户取消、监听等操作 */
|
2044
|
+
taskId: string
|
2045
|
+
}
|
2057
2046
|
|
2058
|
-
|
2059
|
-
|
2060
|
-
|
2061
|
-
|
2047
|
+
export type RequestContext = {
|
2048
|
+
/** 网络请求id */
|
2049
|
+
taskId: string
|
2050
|
+
}
|
2062
2051
|
|
2063
|
-
|
2064
|
-
|
2065
|
-
|
2066
|
-
|
2052
|
+
export type PhoneCallBean = {
|
2053
|
+
/** 需要拨打的电话号码 */
|
2054
|
+
phoneNumber: string
|
2055
|
+
}
|
2067
2056
|
|
2068
|
-
|
2069
|
-
|
2070
|
-
|
2071
|
-
|
2057
|
+
export type ClipboradDataBean = {
|
2058
|
+
/** 剪贴板的内容 */
|
2059
|
+
data: string
|
2060
|
+
}
|
2072
2061
|
|
2073
|
-
|
2074
|
-
|
2075
|
-
|
2076
|
-
|
2077
|
-
|
2078
|
-
|
2079
|
-
|
2080
|
-
|
2081
|
-
|
2082
|
-
|
2083
|
-
|
2084
|
-
|
2085
|
-
|
2086
|
-
|
2087
|
-
|
2062
|
+
export type WifiInfo = {
|
2063
|
+
/** wifi的SSID */
|
2064
|
+
SSID: string
|
2065
|
+
/** wifi的BSSID */
|
2066
|
+
BSSID: string
|
2067
|
+
/** Wi-Fi 信号强度, 安卓取值 0 ~ 100 ,iOS 取值 0 ~ 1 ,值越大强度越大 */
|
2068
|
+
signalStrength: number
|
2069
|
+
/**
|
2070
|
+
* Wi-Fi是否安全
|
2071
|
+
* Android:Android系统12开始支持。
|
2072
|
+
*/
|
2073
|
+
secure: boolean
|
2074
|
+
/** Wi-Fi 频段单位 MHz */
|
2075
|
+
frequency: number
|
2076
|
+
}
|
2088
2077
|
|
2089
|
-
|
2090
|
-
|
2091
|
-
|
2092
|
-
|
2078
|
+
export type UpdateVolumeParams = {
|
2079
|
+
/** 音量,阈值【0 - 1】 */
|
2080
|
+
value: number
|
2081
|
+
}
|
2093
2082
|
|
2094
|
-
|
2095
|
-
|
2096
|
-
|
2097
|
-
|
2098
|
-
|
2099
|
-
|
2100
|
-
|
2101
|
-
|
2102
|
-
|
2103
|
-
|
2104
|
-
|
2105
|
-
|
2106
|
-
|
2083
|
+
export type SystemSetting = {
|
2084
|
+
/** 蓝牙的系统开关,默认false */
|
2085
|
+
bluetoothEnabled?: boolean
|
2086
|
+
/** 地理位置的系统开关,默认false */
|
2087
|
+
locationEnabled?: boolean
|
2088
|
+
/** Wi-Fi 的系统开关,默认false */
|
2089
|
+
wifiEnabled?: boolean
|
2090
|
+
/**
|
2091
|
+
* 设备方向, 默认竖屏
|
2092
|
+
* 竖屏 = "portrait", 横屏 = "landscape"
|
2093
|
+
*/
|
2094
|
+
deviceOrientation?: string
|
2095
|
+
}
|
2107
2096
|
|
2108
|
-
|
2109
|
-
|
2110
|
-
|
2111
|
-
|
2112
|
-
|
2113
|
-
|
2114
|
-
|
2115
|
-
|
2116
|
-
|
2117
|
-
|
2118
|
-
|
2119
|
-
|
2097
|
+
export type DeviceInfoResponse = {
|
2098
|
+
/** 应用二进制接口类型(仅 Android 支持) */
|
2099
|
+
abi: string
|
2100
|
+
/** 设备品牌 */
|
2101
|
+
brand: string
|
2102
|
+
/** 设备型号。新机型刚推出一段时间会显示unknown。 */
|
2103
|
+
model: string
|
2104
|
+
/** 操作系统及版本 */
|
2105
|
+
system: string
|
2106
|
+
/** 客户端平台 */
|
2107
|
+
platform: string
|
2108
|
+
}
|
2120
2109
|
|
2121
|
-
|
2122
|
-
|
2123
|
-
|
2124
|
-
|
2125
|
-
|
2126
|
-
|
2127
|
-
|
2128
|
-
|
2129
|
-
|
2130
|
-
|
2131
|
-
|
2132
|
-
|
2133
|
-
|
2134
|
-
|
2135
|
-
|
2136
|
-
|
2137
|
-
|
2138
|
-
|
2139
|
-
|
2140
|
-
|
2141
|
-
|
2142
|
-
|
2143
|
-
|
2144
|
-
|
2145
|
-
|
2146
|
-
|
2147
|
-
|
2148
|
-
|
2149
|
-
|
2110
|
+
export type SystemInfo = {
|
2111
|
+
is24Hour: boolean
|
2112
|
+
system: string
|
2113
|
+
brand: string
|
2114
|
+
model: string
|
2115
|
+
platform: string
|
2116
|
+
timezoneId: string
|
2117
|
+
pixelRatio: number
|
2118
|
+
screenWidth: number
|
2119
|
+
screenHeight: number
|
2120
|
+
windowWidth: number
|
2121
|
+
windowHeight: number
|
2122
|
+
statusBarHeight: number
|
2123
|
+
language: string
|
2124
|
+
safeArea: SafeArea
|
2125
|
+
albumAuthorized: boolean
|
2126
|
+
cameraAuthorized: boolean
|
2127
|
+
locationAuthorized: boolean
|
2128
|
+
microphoneAuthorized: boolean
|
2129
|
+
notificationAuthorized: boolean
|
2130
|
+
notificationAlertAuthorized: boolean
|
2131
|
+
notificationBadgeAuthorized: boolean
|
2132
|
+
notificationSoundAuthorized: boolean
|
2133
|
+
bluetoothEnabled: boolean
|
2134
|
+
locationEnabled: boolean
|
2135
|
+
wifiEnabled: boolean
|
2136
|
+
theme?: Themes
|
2137
|
+
deviceOrientation?: Orientation
|
2138
|
+
}
|
2150
2139
|
|
2151
|
-
|
2152
|
-
|
2153
|
-
|
2154
|
-
|
2155
|
-
|
2156
|
-
|
2157
|
-
|
2158
|
-
|
2159
|
-
|
2140
|
+
export type GetConnectedWifiParams = {
|
2141
|
+
/**
|
2142
|
+
* 是否需要返回部分 Wi-Fi 信息
|
2143
|
+
* 安卓 thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID 属性的 WifiInfo 对象。
|
2144
|
+
* iOS thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID、BSSID 属性的 WifiInfo 对象,且需要用户开启微信定位权限才能正确返回结果。
|
2145
|
+
* 默认值:false
|
2146
|
+
*/
|
2147
|
+
partialInfo?: boolean
|
2148
|
+
}
|
2160
2149
|
|
2161
|
-
|
2162
|
-
|
2163
|
-
|
2164
|
-
|
2165
|
-
|
2166
|
-
|
2150
|
+
export type NetworkTypeCB = {
|
2151
|
+
/** 网络类型 */
|
2152
|
+
networkType: string
|
2153
|
+
/** 信号强弱,单位 dbm */
|
2154
|
+
signalStrength: number
|
2155
|
+
}
|
2167
2156
|
|
2168
|
-
|
2169
|
-
|
2170
|
-
|
2171
|
-
|
2157
|
+
export type ScreenBean = {
|
2158
|
+
/** 屏幕亮度值,范围 0 ~ 1。0 最暗,1 最亮 */
|
2159
|
+
value: number
|
2160
|
+
}
|
2172
2161
|
|
2173
|
-
|
2174
|
-
|
2175
|
-
|
2176
|
-
|
2162
|
+
export type SetKeepScreenOnParam = {
|
2163
|
+
/** 是否保持屏幕常亮 */
|
2164
|
+
keepScreenOn: boolean
|
2165
|
+
}
|
2177
2166
|
|
2178
|
-
|
2179
|
-
|
2180
|
-
|
2181
|
-
|
2167
|
+
export type TUNIVibrateBean = {
|
2168
|
+
/** 震动强度类型,有效值为:heavy、medium、light */
|
2169
|
+
type: string
|
2170
|
+
}
|
2182
2171
|
|
2183
|
-
|
2184
|
-
|
2185
|
-
|
2186
|
-
|
2187
|
-
|
2188
|
-
|
2189
|
-
|
2190
|
-
|
2191
|
-
|
2192
|
-
|
2193
|
-
|
2194
|
-
|
2195
|
-
|
2196
|
-
|
2197
|
-
|
2198
|
-
|
2199
|
-
|
2200
|
-
|
2172
|
+
export type AudioStart = {
|
2173
|
+
/** 录音的时长,单位 ms,最大值 600000(10 分钟) */
|
2174
|
+
duration?: number
|
2175
|
+
/** 采样率 */
|
2176
|
+
sampleRate?: number
|
2177
|
+
/** 录音通道数 */
|
2178
|
+
numberOfChannels?: number
|
2179
|
+
/** 编码码率,有效值见下表格 */
|
2180
|
+
encodeBitRate?: number
|
2181
|
+
/** 音频格式 */
|
2182
|
+
format?: string
|
2183
|
+
/** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
|
2184
|
+
frameSize: number
|
2185
|
+
/** 指定录音的音频输入源 */
|
2186
|
+
audioSource?: string
|
2187
|
+
/** 录音上下文 */
|
2188
|
+
contextId: string
|
2189
|
+
}
|
2201
2190
|
|
2202
|
-
|
2203
|
-
|
2204
|
-
|
2205
|
-
|
2191
|
+
export type AudioRecordResult = {
|
2192
|
+
/** 录音文件的临时路径 (本地路径) */
|
2193
|
+
tempFilePath: string
|
2194
|
+
}
|
2206
2195
|
|
2207
|
-
|
2208
|
-
|
2209
|
-
|
2210
|
-
|
2196
|
+
export type AudioRecordContext = {
|
2197
|
+
/** 对象id */
|
2198
|
+
contextId: string
|
2199
|
+
}
|
2211
2200
|
|
2212
|
-
|
2213
|
-
|
2214
|
-
|
2215
|
-
|
2216
|
-
|
2217
|
-
|
2201
|
+
export type AudioRecordingRequest = {
|
2202
|
+
/** 录音上下文 */
|
2203
|
+
contextId: string
|
2204
|
+
/** 间隔时间 ms */
|
2205
|
+
period: number
|
2206
|
+
}
|
2218
2207
|
|
2219
|
-
|
2220
|
-
|
2221
|
-
|
2222
|
-
|
2223
|
-
|
2224
|
-
|
2208
|
+
export type ScanCodeBean = {
|
2209
|
+
/** 是否只能从相机扫码,不允许从相册选择图片 */
|
2210
|
+
onlyFromCamera?: boolean
|
2211
|
+
/** 扫码类型 */
|
2212
|
+
scanType?: string[]
|
2213
|
+
}
|
2225
2214
|
|
2226
|
-
|
2227
|
-
|
2228
|
-
|
2229
|
-
|
2230
|
-
|
2231
|
-
|
2232
|
-
|
2233
|
-
|
2234
|
-
|
2235
|
-
|
2236
|
-
|
2237
|
-
|
2215
|
+
export type ScanCodeResult = {
|
2216
|
+
/** 所扫码的内容 */
|
2217
|
+
result: string
|
2218
|
+
/** 所扫码的类型 */
|
2219
|
+
scanType: string
|
2220
|
+
/** 所扫码的字符集 */
|
2221
|
+
charSet: string
|
2222
|
+
/** 当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path (不一定会有返回值) */
|
2223
|
+
path: string
|
2224
|
+
/** 原始数据,base64编码 */
|
2225
|
+
rawData: string
|
2226
|
+
}
|
2238
2227
|
|
2239
|
-
|
2240
|
-
|
2241
|
-
|
2242
|
-
|
2228
|
+
export type StorageCallback = {
|
2229
|
+
/** key对应的内容 */
|
2230
|
+
data?: string
|
2231
|
+
}
|
2243
2232
|
|
2244
|
-
|
2245
|
-
|
2246
|
-
|
2247
|
-
|
2248
|
-
|
2249
|
-
|
2250
|
-
|
2251
|
-
|
2252
|
-
|
2253
|
-
|
2254
|
-
|
2255
|
-
|
2256
|
-
|
2257
|
-
|
2258
|
-
|
2259
|
-
|
2233
|
+
export type UpLoadBean = {
|
2234
|
+
/** 网络请求id */
|
2235
|
+
requestId: string
|
2236
|
+
/** 开发者服务器地址 */
|
2237
|
+
url: string
|
2238
|
+
/** 要上传文件资源的路径 (本地路径) */
|
2239
|
+
filePath: string
|
2240
|
+
/** 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 */
|
2241
|
+
name: string
|
2242
|
+
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
2243
|
+
header?: Record<string, string>
|
2244
|
+
/** HTTP 请求中其他额外的 form data */
|
2245
|
+
formData?: Record<string, string>
|
2246
|
+
/** 超时时间,单位为毫秒 */
|
2247
|
+
timeout?: number
|
2248
|
+
}
|
2260
2249
|
|
2261
|
-
|
2262
|
-
|
2263
|
-
|
2264
|
-
|
2265
|
-
|
2266
|
-
|
2250
|
+
export type UpLoadResult = {
|
2251
|
+
/** 开发者服务器返回的数据 */
|
2252
|
+
data: string
|
2253
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
2254
|
+
statusCode: number
|
2255
|
+
}
|
2267
2256
|
|
2257
|
+
/**
|
2258
|
+
* 创建内部audio上下文InnerAudioContext对象
|
2259
|
+
*/
|
2260
|
+
interface CreateInnerAudioContextTask {
|
2268
2261
|
/**
|
2269
|
-
*
|
2262
|
+
* 暂停
|
2270
2263
|
*/
|
2271
|
-
|
2272
|
-
|
2273
|
-
|
2274
|
-
|
2275
|
-
|
2276
|
-
|
2277
|
-
|
2278
|
-
fail?: (params: {
|
2279
|
-
errorMsg: string
|
2264
|
+
pause(params: {
|
2265
|
+
complete?: () => void
|
2266
|
+
success?: (params: null) => void
|
2267
|
+
fail?: (params: {
|
2268
|
+
errorMsg: string
|
2269
|
+
errorCode: string | number
|
2270
|
+
innerError: {
|
2280
2271
|
errorCode: string | number
|
2281
|
-
innerError: {
|
2282
|
-
errorCode: string | number
|
2283
|
-
errorMsg: string
|
2284
|
-
}
|
2285
|
-
}) => void
|
2286
|
-
}): void
|
2287
|
-
|
2288
|
-
/**
|
2289
|
-
* 恢复
|
2290
|
-
*/
|
2291
|
-
resume(params: {
|
2292
|
-
complete?: () => void
|
2293
|
-
success?: (params: null) => void
|
2294
|
-
fail?: (params: {
|
2295
2272
|
errorMsg: string
|
2296
|
-
|
2297
|
-
|
2298
|
-
|
2299
|
-
errorMsg: string
|
2300
|
-
}
|
2301
|
-
}) => void
|
2302
|
-
}): void
|
2303
|
-
|
2304
|
-
/**
|
2305
|
-
* 播放
|
2306
|
-
*/
|
2307
|
-
play(params: {
|
2308
|
-
/** src 音频资源的地址 */
|
2309
|
-
src: string
|
2310
|
-
/** startTime 开始播放的位置 */
|
2311
|
-
startTime?: number
|
2312
|
-
/** autoplay 是否自动开始播放 */
|
2313
|
-
autoplay?: boolean
|
2314
|
-
/** 是否循环播放,默认为 false */
|
2315
|
-
loop?: boolean
|
2316
|
-
/** 音量。范围 0~1。默认为 1 */
|
2317
|
-
volume?: number
|
2318
|
-
/** 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
|
2319
|
-
playbackRate?: number
|
2320
|
-
complete?: () => void
|
2321
|
-
success?: (params: null) => void
|
2322
|
-
fail?: (params: {
|
2323
|
-
errorMsg: string
|
2324
|
-
errorCode: string | number
|
2325
|
-
innerError: {
|
2326
|
-
errorCode: string | number
|
2327
|
-
errorMsg: string
|
2328
|
-
}
|
2329
|
-
}) => void
|
2330
|
-
}): void
|
2273
|
+
}
|
2274
|
+
}) => void
|
2275
|
+
}): void
|
2331
2276
|
|
2332
|
-
|
2333
|
-
|
2334
|
-
|
2335
|
-
|
2336
|
-
|
2337
|
-
|
2338
|
-
|
2339
|
-
|
2340
|
-
|
2341
|
-
|
2277
|
+
/**
|
2278
|
+
* 恢复
|
2279
|
+
*/
|
2280
|
+
resume(params: {
|
2281
|
+
complete?: () => void
|
2282
|
+
success?: (params: null) => void
|
2283
|
+
fail?: (params: {
|
2284
|
+
errorMsg: string
|
2285
|
+
errorCode: string | number
|
2286
|
+
innerError: {
|
2342
2287
|
errorCode: string | number
|
2343
|
-
innerError: {
|
2344
|
-
errorCode: string | number
|
2345
|
-
errorMsg: string
|
2346
|
-
}
|
2347
|
-
}) => void
|
2348
|
-
}): void
|
2349
|
-
|
2350
|
-
/**
|
2351
|
-
* 停止。停止后的音频再播放会从头开始播放
|
2352
|
-
*/
|
2353
|
-
stop(params: {
|
2354
|
-
complete?: () => void
|
2355
|
-
success?: (params: null) => void
|
2356
|
-
fail?: (params: {
|
2357
2288
|
errorMsg: string
|
2289
|
+
}
|
2290
|
+
}) => void
|
2291
|
+
}): void
|
2292
|
+
|
2293
|
+
/**
|
2294
|
+
* 播放
|
2295
|
+
*/
|
2296
|
+
play(params: {
|
2297
|
+
/** src 音频资源的地址 */
|
2298
|
+
src: string
|
2299
|
+
/** startTime 开始播放的位置 */
|
2300
|
+
startTime?: number
|
2301
|
+
/** autoplay 是否自动开始播放 */
|
2302
|
+
autoplay?: boolean
|
2303
|
+
/** 是否循环播放,默认为 false */
|
2304
|
+
loop?: boolean
|
2305
|
+
/** 音量。范围 0~1。默认为 1 */
|
2306
|
+
volume?: number
|
2307
|
+
/** 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
|
2308
|
+
playbackRate?: number
|
2309
|
+
complete?: () => void
|
2310
|
+
success?: (params: null) => void
|
2311
|
+
fail?: (params: {
|
2312
|
+
errorMsg: string
|
2313
|
+
errorCode: string | number
|
2314
|
+
innerError: {
|
2358
2315
|
errorCode: string | number
|
2359
|
-
|
2360
|
-
|
2361
|
-
|
2362
|
-
|
2363
|
-
}) => void
|
2364
|
-
}): void
|
2316
|
+
errorMsg: string
|
2317
|
+
}
|
2318
|
+
}) => void
|
2319
|
+
}): void
|
2365
2320
|
|
2366
|
-
|
2367
|
-
|
2368
|
-
|
2369
|
-
|
2370
|
-
|
2371
|
-
|
2372
|
-
|
2321
|
+
/**
|
2322
|
+
* 跳转到指定位置
|
2323
|
+
*/
|
2324
|
+
seek(params: {
|
2325
|
+
/** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
|
2326
|
+
position?: number
|
2327
|
+
complete?: () => void
|
2328
|
+
success?: (params: null) => void
|
2329
|
+
fail?: (params: {
|
2330
|
+
errorMsg: string
|
2331
|
+
errorCode: string | number
|
2332
|
+
innerError: {
|
2333
|
+
errorCode: string | number
|
2373
2334
|
errorMsg: string
|
2335
|
+
}
|
2336
|
+
}) => void
|
2337
|
+
}): void
|
2338
|
+
|
2339
|
+
/**
|
2340
|
+
* 停止。停止后的音频再播放会从头开始播放
|
2341
|
+
*/
|
2342
|
+
stop(params: {
|
2343
|
+
complete?: () => void
|
2344
|
+
success?: (params: null) => void
|
2345
|
+
fail?: (params: {
|
2346
|
+
errorMsg: string
|
2347
|
+
errorCode: string | number
|
2348
|
+
innerError: {
|
2374
2349
|
errorCode: string | number
|
2375
|
-
|
2376
|
-
|
2377
|
-
|
2378
|
-
|
2379
|
-
|
2380
|
-
|
2350
|
+
errorMsg: string
|
2351
|
+
}
|
2352
|
+
}) => void
|
2353
|
+
}): void
|
2354
|
+
|
2355
|
+
/**
|
2356
|
+
* 销毁当前实例
|
2357
|
+
*/
|
2358
|
+
destroy(params: {
|
2359
|
+
complete?: () => void
|
2360
|
+
success?: (params: null) => void
|
2361
|
+
fail?: (params: {
|
2362
|
+
errorMsg: string
|
2363
|
+
errorCode: string | number
|
2364
|
+
innerError: {
|
2365
|
+
errorCode: string | number
|
2366
|
+
errorMsg: string
|
2367
|
+
}
|
2368
|
+
}) => void
|
2369
|
+
}): void
|
2370
|
+
|
2371
|
+
/**
|
2372
|
+
* 监听音频播放进度更新事件
|
2373
|
+
*/
|
2374
|
+
onTimeUpdate(
|
2375
|
+
listener: (params: {
|
2376
|
+
/** InnerAudioContext 对象 ContextId */
|
2377
|
+
contextId: string
|
2378
|
+
/** 播放进度 【0 - 1】 */
|
2379
|
+
time: number
|
2380
|
+
}) => void
|
2381
|
+
): void
|
2382
|
+
}
|
2383
|
+
export function createInnerAudioContext(params?: {
|
2384
|
+
complete?: () => void
|
2385
|
+
success?: (params: null) => void
|
2386
|
+
fail?: (params: {
|
2387
|
+
errorMsg: string
|
2388
|
+
errorCode: string | number
|
2389
|
+
innerError: {
|
2390
|
+
errorCode: string | number
|
2391
|
+
errorMsg: string
|
2392
|
+
}
|
2393
|
+
}) => void
|
2394
|
+
}): CreateInnerAudioContextTask
|
2395
|
+
|
2396
|
+
/**
|
2397
|
+
* 一个可以监听下载进度变化事件,以及取消下载任务的对象
|
2398
|
+
*/
|
2399
|
+
interface DownloadFileTask {
|
2400
|
+
/**
|
2401
|
+
* 中断下载任务
|
2402
|
+
*/
|
2403
|
+
abort(params: {
|
2404
|
+
complete?: () => void
|
2405
|
+
success?: (params: null) => void
|
2406
|
+
failure?: (params: {
|
2407
|
+
errorMsg: string
|
2408
|
+
errorCode: string | number
|
2409
|
+
innerError: {
|
2410
|
+
errorCode: string | number
|
2411
|
+
errorMsg: string
|
2412
|
+
}
|
2413
|
+
}) => void
|
2414
|
+
}): void
|
2415
|
+
|
2416
|
+
/**
|
2417
|
+
* 监听 HTTP Response Header 事件。会比请求完成事件更早
|
2418
|
+
*/
|
2419
|
+
onHeadersReceived(
|
2420
|
+
listener: (params: {
|
2421
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2422
|
+
header: Record<string, string>
|
2423
|
+
/** 网络请求id */
|
2424
|
+
requestId: string
|
2425
|
+
}) => void
|
2426
|
+
): void
|
2427
|
+
|
2428
|
+
/**
|
2429
|
+
* 取消监听 HTTP Response Header 事件
|
2430
|
+
*/
|
2431
|
+
offHeadersReceived(
|
2432
|
+
listener: (params: {
|
2433
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2434
|
+
header: Record<string, string>
|
2435
|
+
/** 网络请求id */
|
2436
|
+
requestId: string
|
2437
|
+
}) => void
|
2438
|
+
): void
|
2439
|
+
|
2440
|
+
/**
|
2441
|
+
* 监听下载进度变化事件
|
2442
|
+
*/
|
2443
|
+
onProgressUpdate(
|
2444
|
+
listener: (params: {
|
2445
|
+
/** 下载进度百分比 */
|
2446
|
+
progress: number
|
2447
|
+
/** 已经下载的数据长度,单位 Bytes */
|
2448
|
+
totalBytesSent: number
|
2449
|
+
/** 预期需要下载的数据总长度,单位 Bytes */
|
2450
|
+
totalBytesExpectedToSend: number
|
2451
|
+
/** 网络请求id */
|
2452
|
+
requestId: string
|
2453
|
+
}) => void
|
2454
|
+
): void
|
2455
|
+
|
2456
|
+
/**
|
2457
|
+
* 取消监听下载进度变化事件
|
2458
|
+
*/
|
2459
|
+
offProgressUpdate(
|
2460
|
+
listener: (params: {
|
2461
|
+
/** 下载进度百分比 */
|
2462
|
+
progress: number
|
2463
|
+
/** 已经下载的数据长度,单位 Bytes */
|
2464
|
+
totalBytesSent: number
|
2465
|
+
/** 预期需要下载的数据总长度,单位 Bytes */
|
2466
|
+
totalBytesExpectedToSend: number
|
2467
|
+
/** 网络请求id */
|
2468
|
+
requestId: string
|
2469
|
+
}) => void
|
2470
|
+
): void
|
2471
|
+
}
|
2472
|
+
export function downloadFile(params: {
|
2473
|
+
/** 下载资源的 url */
|
2474
|
+
url: string
|
2475
|
+
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
2476
|
+
header?: Record<string, string>
|
2477
|
+
/** 超时时间,单位为毫秒 */
|
2478
|
+
timeout?: number
|
2479
|
+
/** 指定文件下载后存储的路径 (本地路径) */
|
2480
|
+
filePath?: string
|
2481
|
+
complete?: () => void
|
2482
|
+
success?: (params: {
|
2483
|
+
/** 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 */
|
2484
|
+
tempFilePath: string
|
2485
|
+
/** 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 */
|
2486
|
+
filePath: string
|
2487
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
2488
|
+
statusCode: number
|
2489
|
+
/** 网络请求过程中一些调试信息 */
|
2490
|
+
profile: Profile
|
2491
|
+
}) => void
|
2492
|
+
failure?: (params: {
|
2493
|
+
errorMsg: string
|
2494
|
+
errorCode: string | number
|
2495
|
+
innerError: {
|
2496
|
+
errorCode: string | number
|
2497
|
+
errorMsg: string
|
2498
|
+
}
|
2499
|
+
}) => void
|
2500
|
+
}): DownloadFileTask
|
2501
|
+
|
2502
|
+
/**
|
2503
|
+
* 文件管理器
|
2504
|
+
*/
|
2505
|
+
interface GetFileSystemManagerTask {
|
2506
|
+
/**
|
2507
|
+
* 判断文件/目录是否存在
|
2508
|
+
*/
|
2509
|
+
access(params: {
|
2510
|
+
/** 要判断是否存在的文件/目录路径 (本地路径) */
|
2511
|
+
path: string
|
2512
|
+
complete?: () => void
|
2513
|
+
success?: (params: null) => void
|
2514
|
+
fail?: (params: {
|
2515
|
+
errorMsg: string
|
2516
|
+
errorCode: string | number
|
2517
|
+
innerError: {
|
2518
|
+
errorCode: string | number
|
2519
|
+
errorMsg: string
|
2520
|
+
}
|
2521
|
+
}) => void
|
2522
|
+
}): void
|
2523
|
+
|
2524
|
+
/**
|
2525
|
+
* 读取本地文件内容
|
2526
|
+
*/
|
2527
|
+
readFile(params: {
|
2528
|
+
/** 要写入的文件路径 (本地路径) */
|
2529
|
+
filePath: string
|
2530
|
+
/**
|
2531
|
+
* 指定读取文件的字符编码。
|
2532
|
+
* 支持 utf8/ascii/base64。如果不传 encoding,默认utf8
|
2533
|
+
*/
|
2534
|
+
encoding?: string
|
2535
|
+
/** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
|
2536
|
+
position?: number
|
2537
|
+
/** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
|
2538
|
+
length?: number
|
2539
|
+
complete?: () => void
|
2540
|
+
success?: (params: {
|
2541
|
+
/** 文件内容 */
|
2542
|
+
data: string
|
2543
|
+
}) => void
|
2544
|
+
fail?: (params: {
|
2545
|
+
errorMsg: string
|
2546
|
+
errorCode: string | number
|
2547
|
+
innerError: {
|
2548
|
+
errorCode: string | number
|
2549
|
+
errorMsg: string
|
2550
|
+
}
|
2551
|
+
}) => void
|
2552
|
+
}): void
|
2553
|
+
|
2554
|
+
/**
|
2555
|
+
* 读取本地文件内容
|
2556
|
+
*/
|
2557
|
+
readFileSync(req?: FileReadFileReqBean): {
|
2558
|
+
/** 文件内容 */
|
2559
|
+
data: string
|
2560
|
+
}
|
2561
|
+
|
2562
|
+
/**
|
2563
|
+
* 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
|
2564
|
+
*/
|
2565
|
+
saveFile(params: {
|
2566
|
+
/** 临时存储文件路径 */
|
2567
|
+
tempFilePath: string
|
2568
|
+
/** 要存储的文件路径 */
|
2569
|
+
filePath: string
|
2570
|
+
complete?: () => void
|
2571
|
+
success?: (params: {
|
2572
|
+
/** 【待废弃, 不建议使用】存储后的文件路径 */
|
2573
|
+
savedFilePath: string
|
2574
|
+
}) => void
|
2575
|
+
fail?: (params: {
|
2576
|
+
errorMsg: string
|
2577
|
+
errorCode: string | number
|
2578
|
+
innerError: {
|
2579
|
+
errorCode: string | number
|
2580
|
+
errorMsg: string
|
2581
|
+
}
|
2582
|
+
}) => void
|
2583
|
+
}): void
|
2584
|
+
|
2585
|
+
/**
|
2586
|
+
* 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
|
2587
|
+
*/
|
2588
|
+
saveFileSync(params?: SaveFileSyncParams): {
|
2589
|
+
/** 【待废弃, 不建议使用】存储后的文件路径 */
|
2590
|
+
savedFilePath: string
|
2591
|
+
}
|
2592
|
+
|
2593
|
+
/**
|
2594
|
+
* 获取文件Stats对象,需要文件读写权限
|
2595
|
+
*/
|
2596
|
+
stat(params: {
|
2597
|
+
/** 文件/目录路径 (本地路径) */
|
2598
|
+
path: string
|
2599
|
+
/**
|
2600
|
+
* 是否递归获取目录下的每个文件的 Stats 信息
|
2601
|
+
* 默认值:false
|
2602
|
+
*/
|
2603
|
+
recursive?: boolean
|
2604
|
+
complete?: () => void
|
2605
|
+
success?: (params: {
|
2606
|
+
/** 文件列表 */
|
2607
|
+
fileStatsList: FileStats[]
|
2608
|
+
}) => void
|
2609
|
+
fail?: (params: {
|
2610
|
+
errorMsg: string
|
2611
|
+
errorCode: string | number
|
2612
|
+
innerError: {
|
2613
|
+
errorCode: string | number
|
2614
|
+
errorMsg: string
|
2615
|
+
}
|
2616
|
+
}) => void
|
2617
|
+
}): void
|
2618
|
+
|
2619
|
+
/**
|
2620
|
+
* 获取文件Stats对象,需要文件读写权限
|
2621
|
+
*/
|
2622
|
+
statSync(params?: FileStatsParams): {
|
2623
|
+
/** 文件列表 */
|
2624
|
+
fileStatsList: FileStats[]
|
2625
|
+
}
|
2626
|
+
|
2627
|
+
/**
|
2628
|
+
* 创建目录,需要文件读写权限
|
2629
|
+
*/
|
2630
|
+
mkdir(params: {
|
2631
|
+
/** 创建的目录路径 (本地路径) */
|
2632
|
+
dirPath: string
|
2633
|
+
/**
|
2634
|
+
* 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
|
2635
|
+
* 如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,
|
2636
|
+
* 以此类推直至创建 a/b/c 目录下的 d 目录。
|
2637
|
+
* 默认值:false
|
2638
|
+
*/
|
2639
|
+
recursive?: boolean
|
2640
|
+
complete?: () => void
|
2641
|
+
success?: (params: null) => void
|
2642
|
+
fail?: (params: {
|
2643
|
+
errorMsg: string
|
2644
|
+
errorCode: string | number
|
2645
|
+
innerError: {
|
2646
|
+
errorCode: string | number
|
2647
|
+
errorMsg: string
|
2648
|
+
}
|
2649
|
+
}) => void
|
2650
|
+
}): void
|
2651
|
+
|
2652
|
+
/**
|
2653
|
+
* 创建目录,需要文件读写权限
|
2654
|
+
*/
|
2655
|
+
mkdirSync(params?: MakeDirParams): null
|
2656
|
+
|
2657
|
+
/**
|
2658
|
+
* 删除目录,需要文件读写权限
|
2659
|
+
*/
|
2660
|
+
rmdir(params: {
|
2661
|
+
/** 要删除的目录路径 (本地路径) */
|
2662
|
+
dirPath: string
|
2663
|
+
/**
|
2664
|
+
* 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
|
2665
|
+
* 默认值:false
|
2666
|
+
*/
|
2667
|
+
recursive?: boolean
|
2668
|
+
complete?: () => void
|
2669
|
+
success?: (params: null) => void
|
2670
|
+
fail?: (params: {
|
2671
|
+
errorMsg: string
|
2672
|
+
errorCode: string | number
|
2673
|
+
innerError: {
|
2674
|
+
errorCode: string | number
|
2675
|
+
errorMsg: string
|
2676
|
+
}
|
2677
|
+
}) => void
|
2678
|
+
}): void
|
2679
|
+
|
2680
|
+
/**
|
2681
|
+
* 删除目录,需要文件读写权限
|
2682
|
+
*/
|
2683
|
+
rmdirSync(params?: RemoveDirParams): null
|
2684
|
+
|
2685
|
+
/**
|
2686
|
+
* 写文件,需要文件读写权限
|
2687
|
+
*/
|
2688
|
+
writeFile(params: {
|
2689
|
+
/** 要写入的文件路径 (本地路径) */
|
2690
|
+
filePath: string
|
2691
|
+
/** 要写入的文本数据, 根据encoding编码 */
|
2692
|
+
data: string
|
2693
|
+
/** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
|
2694
|
+
encoding?: string
|
2695
|
+
complete?: () => void
|
2696
|
+
success?: (params: null) => void
|
2697
|
+
fail?: (params: {
|
2698
|
+
errorMsg: string
|
2699
|
+
errorCode: string | number
|
2700
|
+
innerError: {
|
2701
|
+
errorCode: string | number
|
2702
|
+
errorMsg: string
|
2703
|
+
}
|
2704
|
+
}) => void
|
2705
|
+
}): void
|
2706
|
+
|
2707
|
+
/**
|
2708
|
+
* 写文件,需要文件读写权限
|
2709
|
+
*/
|
2710
|
+
writeFileSync(params?: WriteFileParams): null
|
2711
|
+
|
2712
|
+
/**
|
2713
|
+
* 删除已保存的本地缓存文件,需要文件读写权限
|
2714
|
+
*/
|
2715
|
+
removeSavedFile(params: {
|
2716
|
+
/** 需要删除的文件路径 (本地路径) */
|
2717
|
+
filePath: string
|
2718
|
+
complete?: () => void
|
2719
|
+
success?: (params: null) => void
|
2720
|
+
fail?: (params: {
|
2721
|
+
errorMsg: string
|
2722
|
+
errorCode: string | number
|
2723
|
+
innerError: {
|
2724
|
+
errorCode: string | number
|
2725
|
+
errorMsg: string
|
2726
|
+
}
|
2727
|
+
}) => void
|
2728
|
+
}): void
|
2729
|
+
}
|
2730
|
+
export function getFileSystemManager(params?: {
|
2731
|
+
complete?: () => void
|
2732
|
+
success?: (params: null) => void
|
2733
|
+
fail?: (params: {
|
2734
|
+
errorMsg: string
|
2735
|
+
errorCode: string | number
|
2736
|
+
innerError: {
|
2737
|
+
errorCode: string | number
|
2738
|
+
errorMsg: string
|
2739
|
+
}
|
2740
|
+
}) => void
|
2741
|
+
}): GetFileSystemManagerTask
|
2742
|
+
|
2743
|
+
/**
|
2744
|
+
* 获取网络请求任务对象RequestTask
|
2745
|
+
*/
|
2746
|
+
interface RequestTask {
|
2747
|
+
/**
|
2748
|
+
* 中断请求任务
|
2749
|
+
*/
|
2750
|
+
abort(params: {
|
2751
|
+
complete?: () => void
|
2752
|
+
success?: (params: null) => void
|
2753
|
+
failure?: (params: {
|
2754
|
+
errorMsg: string
|
2755
|
+
errorCode: string | number
|
2756
|
+
innerError: {
|
2757
|
+
errorCode: string | number
|
2758
|
+
errorMsg: string
|
2759
|
+
}
|
2760
|
+
}) => void
|
2761
|
+
}): void
|
2762
|
+
|
2763
|
+
/**
|
2764
|
+
* 监听 HTTP Response Header 事件。会比请求完成事件更早
|
2765
|
+
*/
|
2766
|
+
onHeadersReceived(
|
2767
|
+
listener: (params: {
|
2768
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2769
|
+
header: Record<string, string>
|
2770
|
+
/** 网络请求id */
|
2771
|
+
requestId: string
|
2772
|
+
}) => void
|
2773
|
+
): void
|
2774
|
+
|
2775
|
+
/**
|
2776
|
+
* 取消监听 HTTP Response Header 事件
|
2777
|
+
*/
|
2778
|
+
offHeadersReceived(
|
2779
|
+
listener: (params: {
|
2780
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2781
|
+
header: Record<string, string>
|
2782
|
+
/** 网络请求id */
|
2783
|
+
requestId: string
|
2784
|
+
}) => void
|
2785
|
+
): void
|
2786
|
+
}
|
2787
|
+
export function request(params: {
|
2788
|
+
/** 开发者服务器接口地址 */
|
2789
|
+
url: string
|
2790
|
+
/** 请求的参数 */
|
2791
|
+
data?: string
|
2792
|
+
/** 设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json */
|
2793
|
+
header?: Record<string, string>
|
2794
|
+
/** 超时时间,单位为毫秒 */
|
2795
|
+
timeout?: number
|
2796
|
+
/** HTTP 请求方法 */
|
2797
|
+
method?: HTTPMethod
|
2798
|
+
/** 返回的数据格式 */
|
2799
|
+
dataType?: any
|
2800
|
+
/** 返回的数据类型 */
|
2801
|
+
responseType?: string
|
2802
|
+
/** enableHttp2 */
|
2803
|
+
enableHttp2?: boolean
|
2804
|
+
/** enableQuic */
|
2805
|
+
enableQuic?: boolean
|
2806
|
+
/** enableCache */
|
2807
|
+
enableCache?: boolean
|
2808
|
+
complete?: () => void
|
2809
|
+
success?: (params: {
|
2810
|
+
/** 开发者服务器返回的数据 */
|
2811
|
+
data: string
|
2812
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
2813
|
+
statusCode: number
|
2814
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
2815
|
+
header: Record<string, string>
|
2816
|
+
/** 开发者服务器返回的 cookies,格式为字符串数组 */
|
2817
|
+
cookies: string[]
|
2818
|
+
/** 网络请求过程中一些调试信息 */
|
2819
|
+
profile: Profile
|
2820
|
+
/** 网络请求id,用户取消、监听等操作 */
|
2821
|
+
taskId: string
|
2822
|
+
}) => void
|
2823
|
+
failure?: (params: {
|
2824
|
+
errorMsg: string
|
2825
|
+
errorCode: string | number
|
2826
|
+
innerError: {
|
2827
|
+
errorCode: string | number
|
2828
|
+
errorMsg: string
|
2829
|
+
}
|
2830
|
+
}) => void
|
2831
|
+
}): RequestTask
|
2381
2832
|
|
2382
|
-
|
2383
|
-
|
2384
|
-
|
2385
|
-
|
2386
|
-
|
2387
|
-
|
2388
|
-
|
2389
|
-
|
2390
|
-
|
2391
|
-
|
2392
|
-
|
2393
|
-
|
2394
|
-
|
2833
|
+
/**
|
2834
|
+
* 获取全局唯一的录音管理器
|
2835
|
+
*/
|
2836
|
+
interface GetRecorderManagerTask {
|
2837
|
+
/**
|
2838
|
+
* 开始录音
|
2839
|
+
*/
|
2840
|
+
start(params: {
|
2841
|
+
/** 录音的时长,单位 ms,最大值 600000(10 分钟) */
|
2842
|
+
duration?: number
|
2843
|
+
/** 采样率 */
|
2844
|
+
sampleRate?: number
|
2845
|
+
/** 录音通道数 */
|
2846
|
+
numberOfChannels?: number
|
2847
|
+
/** 编码码率,有效值见下表格 */
|
2848
|
+
encodeBitRate?: number
|
2849
|
+
/** 音频格式 */
|
2850
|
+
format?: string
|
2851
|
+
/** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
|
2852
|
+
frameSize: number
|
2853
|
+
/** 指定录音的音频输入源 */
|
2854
|
+
audioSource?: string
|
2395
2855
|
complete?: () => void
|
2396
|
-
success?: (params:
|
2397
|
-
|
2856
|
+
success?: (params: {
|
2857
|
+
/** 录音文件的临时路径 (本地路径) */
|
2858
|
+
tempFilePath: string
|
2859
|
+
}) => void
|
2860
|
+
failure?: (params: {
|
2398
2861
|
errorMsg: string
|
2399
2862
|
errorCode: string | number
|
2400
2863
|
innerError: {
|
@@ -2402,103 +2865,16 @@ declare namespace ty {
|
|
2402
2865
|
errorMsg: string
|
2403
2866
|
}
|
2404
2867
|
}) => void
|
2405
|
-
}):
|
2868
|
+
}): void
|
2406
2869
|
|
2407
2870
|
/**
|
2408
|
-
*
|
2871
|
+
* 继续录音
|
2409
2872
|
*/
|
2410
|
-
|
2411
|
-
/**
|
2412
|
-
* 中断下载任务
|
2413
|
-
*/
|
2414
|
-
abort(params: {
|
2415
|
-
complete?: () => void
|
2416
|
-
success?: (params: null) => void
|
2417
|
-
failure?: (params: {
|
2418
|
-
errorMsg: string
|
2419
|
-
errorCode: string | number
|
2420
|
-
innerError: {
|
2421
|
-
errorCode: string | number
|
2422
|
-
errorMsg: string
|
2423
|
-
}
|
2424
|
-
}) => void
|
2425
|
-
}): void
|
2426
|
-
|
2427
|
-
/**
|
2428
|
-
* 监听 HTTP Response Header 事件。会比请求完成事件更早
|
2429
|
-
*/
|
2430
|
-
onHeadersReceived(
|
2431
|
-
listener: (params: {
|
2432
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
2433
|
-
header: Record<string, string>
|
2434
|
-
/** 网络请求id */
|
2435
|
-
requestId: string
|
2436
|
-
}) => void
|
2437
|
-
): void
|
2438
|
-
|
2439
|
-
/**
|
2440
|
-
* 取消监听 HTTP Response Header 事件
|
2441
|
-
*/
|
2442
|
-
offHeadersReceived(
|
2443
|
-
listener: (params: {
|
2444
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
2445
|
-
header: Record<string, string>
|
2446
|
-
/** 网络请求id */
|
2447
|
-
requestId: string
|
2448
|
-
}) => void
|
2449
|
-
): void
|
2450
|
-
|
2451
|
-
/**
|
2452
|
-
* 监听下载进度变化事件
|
2453
|
-
*/
|
2454
|
-
onProgressUpdate(
|
2455
|
-
listener: (params: {
|
2456
|
-
/** 下载进度百分比 */
|
2457
|
-
progress: number
|
2458
|
-
/** 已经下载的数据长度,单位 Bytes */
|
2459
|
-
totalBytesSent: number
|
2460
|
-
/** 预期需要下载的数据总长度,单位 Bytes */
|
2461
|
-
totalBytesExpectedToSend: number
|
2462
|
-
/** 网络请求id */
|
2463
|
-
requestId: string
|
2464
|
-
}) => void
|
2465
|
-
): void
|
2466
|
-
|
2467
|
-
/**
|
2468
|
-
* 取消监听下载进度变化事件
|
2469
|
-
*/
|
2470
|
-
offProgressUpdate(
|
2471
|
-
listener: (params: {
|
2472
|
-
/** 下载进度百分比 */
|
2473
|
-
progress: number
|
2474
|
-
/** 已经下载的数据长度,单位 Bytes */
|
2475
|
-
totalBytesSent: number
|
2476
|
-
/** 预期需要下载的数据总长度,单位 Bytes */
|
2477
|
-
totalBytesExpectedToSend: number
|
2478
|
-
/** 网络请求id */
|
2479
|
-
requestId: string
|
2480
|
-
}) => void
|
2481
|
-
): void
|
2482
|
-
}
|
2483
|
-
export function downloadFile(params: {
|
2484
|
-
/** 下载资源的 url */
|
2485
|
-
url: string
|
2486
|
-
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
2487
|
-
header?: Record<string, string>
|
2488
|
-
/** 超时时间,单位为毫秒 */
|
2489
|
-
timeout?: number
|
2490
|
-
/** 指定文件下载后存储的路径 (本地路径) */
|
2491
|
-
filePath?: string
|
2873
|
+
resume(params: {
|
2492
2874
|
complete?: () => void
|
2493
2875
|
success?: (params: {
|
2494
|
-
/**
|
2876
|
+
/** 录音文件的临时路径 (本地路径) */
|
2495
2877
|
tempFilePath: string
|
2496
|
-
/** 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 */
|
2497
|
-
filePath: string
|
2498
|
-
/** 开发者服务器返回的 HTTP 状态码 */
|
2499
|
-
statusCode: number
|
2500
|
-
/** 网络请求过程中一些调试信息 */
|
2501
|
-
profile: Profile
|
2502
2878
|
}) => void
|
2503
2879
|
failure?: (params: {
|
2504
2880
|
errorMsg: string
|
@@ -2508,240 +2884,18 @@ declare namespace ty {
|
|
2508
2884
|
errorMsg: string
|
2509
2885
|
}
|
2510
2886
|
}) => void
|
2511
|
-
}):
|
2887
|
+
}): void
|
2512
2888
|
|
2513
2889
|
/**
|
2514
|
-
*
|
2890
|
+
* 暂停录音
|
2515
2891
|
*/
|
2516
|
-
|
2517
|
-
/**
|
2518
|
-
* 判断文件/目录是否存在
|
2519
|
-
*/
|
2520
|
-
access(params: {
|
2521
|
-
/** 要判断是否存在的文件/目录路径 (本地路径) */
|
2522
|
-
path: string
|
2523
|
-
complete?: () => void
|
2524
|
-
success?: (params: null) => void
|
2525
|
-
fail?: (params: {
|
2526
|
-
errorMsg: string
|
2527
|
-
errorCode: string | number
|
2528
|
-
innerError: {
|
2529
|
-
errorCode: string | number
|
2530
|
-
errorMsg: string
|
2531
|
-
}
|
2532
|
-
}) => void
|
2533
|
-
}): void
|
2534
|
-
|
2535
|
-
/**
|
2536
|
-
* 读取本地文件内容
|
2537
|
-
*/
|
2538
|
-
readFile(params: {
|
2539
|
-
/** 要写入的文件路径 (本地路径) */
|
2540
|
-
filePath: string
|
2541
|
-
/**
|
2542
|
-
* 指定读取文件的字符编码。
|
2543
|
-
* 支持 utf8/ascii/base64。如果不传 encoding,默认utf8
|
2544
|
-
*/
|
2545
|
-
encoding?: string
|
2546
|
-
/** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
|
2547
|
-
position?: number
|
2548
|
-
/** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
|
2549
|
-
length?: number
|
2550
|
-
complete?: () => void
|
2551
|
-
success?: (params: {
|
2552
|
-
/** 文件内容 */
|
2553
|
-
data: string
|
2554
|
-
}) => void
|
2555
|
-
fail?: (params: {
|
2556
|
-
errorMsg: string
|
2557
|
-
errorCode: string | number
|
2558
|
-
innerError: {
|
2559
|
-
errorCode: string | number
|
2560
|
-
errorMsg: string
|
2561
|
-
}
|
2562
|
-
}) => void
|
2563
|
-
}): void
|
2564
|
-
|
2565
|
-
/**
|
2566
|
-
* 读取本地文件内容
|
2567
|
-
*/
|
2568
|
-
readFileSync(req?: FileReadFileReqBean): {
|
2569
|
-
/** 文件内容 */
|
2570
|
-
data: string
|
2571
|
-
}
|
2572
|
-
|
2573
|
-
/**
|
2574
|
-
* 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
|
2575
|
-
*/
|
2576
|
-
saveFile(params: {
|
2577
|
-
/** 临时存储文件路径 */
|
2578
|
-
tempFilePath: string
|
2579
|
-
/** 要存储的文件路径 */
|
2580
|
-
filePath: string
|
2581
|
-
complete?: () => void
|
2582
|
-
success?: (params: {
|
2583
|
-
/** 【待废弃, 不建议使用】存储后的文件路径 */
|
2584
|
-
savedFilePath: string
|
2585
|
-
}) => void
|
2586
|
-
fail?: (params: {
|
2587
|
-
errorMsg: string
|
2588
|
-
errorCode: string | number
|
2589
|
-
innerError: {
|
2590
|
-
errorCode: string | number
|
2591
|
-
errorMsg: string
|
2592
|
-
}
|
2593
|
-
}) => void
|
2594
|
-
}): void
|
2595
|
-
|
2596
|
-
/**
|
2597
|
-
* 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
|
2598
|
-
*/
|
2599
|
-
saveFileSync(params?: SaveFileSyncParams): {
|
2600
|
-
/** 【待废弃, 不建议使用】存储后的文件路径 */
|
2601
|
-
savedFilePath: string
|
2602
|
-
}
|
2603
|
-
|
2604
|
-
/**
|
2605
|
-
* 获取文件Stats对象,需要文件读写权限
|
2606
|
-
*/
|
2607
|
-
stat(params: {
|
2608
|
-
/** 文件/目录路径 (本地路径) */
|
2609
|
-
path: string
|
2610
|
-
/**
|
2611
|
-
* 是否递归获取目录下的每个文件的 Stats 信息
|
2612
|
-
* 默认值:false
|
2613
|
-
*/
|
2614
|
-
recursive?: boolean
|
2615
|
-
complete?: () => void
|
2616
|
-
success?: (params: {
|
2617
|
-
/** 文件列表 */
|
2618
|
-
fileStatsList: FileStats[]
|
2619
|
-
}) => void
|
2620
|
-
fail?: (params: {
|
2621
|
-
errorMsg: string
|
2622
|
-
errorCode: string | number
|
2623
|
-
innerError: {
|
2624
|
-
errorCode: string | number
|
2625
|
-
errorMsg: string
|
2626
|
-
}
|
2627
|
-
}) => void
|
2628
|
-
}): void
|
2629
|
-
|
2630
|
-
/**
|
2631
|
-
* 获取文件Stats对象,需要文件读写权限
|
2632
|
-
*/
|
2633
|
-
statSync(params?: FileStatsParams): {
|
2634
|
-
/** 文件列表 */
|
2635
|
-
fileStatsList: FileStats[]
|
2636
|
-
}
|
2637
|
-
|
2638
|
-
/**
|
2639
|
-
* 创建目录,需要文件读写权限
|
2640
|
-
*/
|
2641
|
-
mkdir(params: {
|
2642
|
-
/** 创建的目录路径 (本地路径) */
|
2643
|
-
dirPath: string
|
2644
|
-
/**
|
2645
|
-
* 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
|
2646
|
-
* 如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,
|
2647
|
-
* 以此类推直至创建 a/b/c 目录下的 d 目录。
|
2648
|
-
* 默认值:false
|
2649
|
-
*/
|
2650
|
-
recursive?: boolean
|
2651
|
-
complete?: () => void
|
2652
|
-
success?: (params: null) => void
|
2653
|
-
fail?: (params: {
|
2654
|
-
errorMsg: string
|
2655
|
-
errorCode: string | number
|
2656
|
-
innerError: {
|
2657
|
-
errorCode: string | number
|
2658
|
-
errorMsg: string
|
2659
|
-
}
|
2660
|
-
}) => void
|
2661
|
-
}): void
|
2662
|
-
|
2663
|
-
/**
|
2664
|
-
* 创建目录,需要文件读写权限
|
2665
|
-
*/
|
2666
|
-
mkdirSync(params?: MakeDirParams): null
|
2667
|
-
|
2668
|
-
/**
|
2669
|
-
* 删除目录,需要文件读写权限
|
2670
|
-
*/
|
2671
|
-
rmdir(params: {
|
2672
|
-
/** 要删除的目录路径 (本地路径) */
|
2673
|
-
dirPath: string
|
2674
|
-
/**
|
2675
|
-
* 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
|
2676
|
-
* 默认值:false
|
2677
|
-
*/
|
2678
|
-
recursive?: boolean
|
2679
|
-
complete?: () => void
|
2680
|
-
success?: (params: null) => void
|
2681
|
-
fail?: (params: {
|
2682
|
-
errorMsg: string
|
2683
|
-
errorCode: string | number
|
2684
|
-
innerError: {
|
2685
|
-
errorCode: string | number
|
2686
|
-
errorMsg: string
|
2687
|
-
}
|
2688
|
-
}) => void
|
2689
|
-
}): void
|
2690
|
-
|
2691
|
-
/**
|
2692
|
-
* 删除目录,需要文件读写权限
|
2693
|
-
*/
|
2694
|
-
rmdirSync(params?: RemoveDirParams): null
|
2695
|
-
|
2696
|
-
/**
|
2697
|
-
* 写文件,需要文件读写权限
|
2698
|
-
*/
|
2699
|
-
writeFile(params: {
|
2700
|
-
/** 要写入的文件路径 (本地路径) */
|
2701
|
-
filePath: string
|
2702
|
-
/** 要写入的文本数据, 根据encoding编码 */
|
2703
|
-
data: string
|
2704
|
-
/** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
|
2705
|
-
encoding?: string
|
2706
|
-
complete?: () => void
|
2707
|
-
success?: (params: null) => void
|
2708
|
-
fail?: (params: {
|
2709
|
-
errorMsg: string
|
2710
|
-
errorCode: string | number
|
2711
|
-
innerError: {
|
2712
|
-
errorCode: string | number
|
2713
|
-
errorMsg: string
|
2714
|
-
}
|
2715
|
-
}) => void
|
2716
|
-
}): void
|
2717
|
-
|
2718
|
-
/**
|
2719
|
-
* 写文件,需要文件读写权限
|
2720
|
-
*/
|
2721
|
-
writeFileSync(params?: WriteFileParams): null
|
2722
|
-
|
2723
|
-
/**
|
2724
|
-
* 删除已保存的本地缓存文件,需要文件读写权限
|
2725
|
-
*/
|
2726
|
-
removeSavedFile(params: {
|
2727
|
-
/** 需要删除的文件路径 (本地路径) */
|
2728
|
-
filePath: string
|
2729
|
-
complete?: () => void
|
2730
|
-
success?: (params: null) => void
|
2731
|
-
fail?: (params: {
|
2732
|
-
errorMsg: string
|
2733
|
-
errorCode: string | number
|
2734
|
-
innerError: {
|
2735
|
-
errorCode: string | number
|
2736
|
-
errorMsg: string
|
2737
|
-
}
|
2738
|
-
}) => void
|
2739
|
-
}): void
|
2740
|
-
}
|
2741
|
-
export function getFileSystemManager(params?: {
|
2892
|
+
pause(params: {
|
2742
2893
|
complete?: () => void
|
2743
|
-
success?: (params:
|
2744
|
-
|
2894
|
+
success?: (params: {
|
2895
|
+
/** 录音文件的临时路径 (本地路径) */
|
2896
|
+
tempFilePath: string
|
2897
|
+
}) => void
|
2898
|
+
failure?: (params: {
|
2745
2899
|
errorMsg: string
|
2746
2900
|
errorCode: string | number
|
2747
2901
|
innerError: {
|
@@ -2749,87 +2903,16 @@ declare namespace ty {
|
|
2749
2903
|
errorMsg: string
|
2750
2904
|
}
|
2751
2905
|
}) => void
|
2752
|
-
}):
|
2906
|
+
}): void
|
2753
2907
|
|
2754
2908
|
/**
|
2755
|
-
*
|
2909
|
+
* 停止录音
|
2756
2910
|
*/
|
2757
|
-
|
2758
|
-
/**
|
2759
|
-
* 中断请求任务
|
2760
|
-
*/
|
2761
|
-
abort(params: {
|
2762
|
-
complete?: () => void
|
2763
|
-
success?: (params: null) => void
|
2764
|
-
failure?: (params: {
|
2765
|
-
errorMsg: string
|
2766
|
-
errorCode: string | number
|
2767
|
-
innerError: {
|
2768
|
-
errorCode: string | number
|
2769
|
-
errorMsg: string
|
2770
|
-
}
|
2771
|
-
}) => void
|
2772
|
-
}): void
|
2773
|
-
|
2774
|
-
/**
|
2775
|
-
* 监听 HTTP Response Header 事件。会比请求完成事件更早
|
2776
|
-
*/
|
2777
|
-
onHeadersReceived(
|
2778
|
-
listener: (params: {
|
2779
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
2780
|
-
header: Record<string, string>
|
2781
|
-
/** 网络请求id */
|
2782
|
-
requestId: string
|
2783
|
-
}) => void
|
2784
|
-
): void
|
2785
|
-
|
2786
|
-
/**
|
2787
|
-
* 取消监听 HTTP Response Header 事件
|
2788
|
-
*/
|
2789
|
-
offHeadersReceived(
|
2790
|
-
listener: (params: {
|
2791
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
2792
|
-
header: Record<string, string>
|
2793
|
-
/** 网络请求id */
|
2794
|
-
requestId: string
|
2795
|
-
}) => void
|
2796
|
-
): void
|
2797
|
-
}
|
2798
|
-
export function request(params: {
|
2799
|
-
/** 开发者服务器接口地址 */
|
2800
|
-
url: string
|
2801
|
-
/** 请求的参数 */
|
2802
|
-
data?: string
|
2803
|
-
/** 设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json */
|
2804
|
-
header?: Record<string, string>
|
2805
|
-
/** 超时时间,单位为毫秒 */
|
2806
|
-
timeout?: number
|
2807
|
-
/** HTTP 请求方法 */
|
2808
|
-
method?: HTTPMethod
|
2809
|
-
/** 返回的数据格式 */
|
2810
|
-
dataType?: any
|
2811
|
-
/** 返回的数据类型 */
|
2812
|
-
responseType?: string
|
2813
|
-
/** enableHttp2 */
|
2814
|
-
enableHttp2?: boolean
|
2815
|
-
/** enableQuic */
|
2816
|
-
enableQuic?: boolean
|
2817
|
-
/** enableCache */
|
2818
|
-
enableCache?: boolean
|
2911
|
+
stop(params: {
|
2819
2912
|
complete?: () => void
|
2820
2913
|
success?: (params: {
|
2821
|
-
/**
|
2822
|
-
|
2823
|
-
/** 开发者服务器返回的 HTTP 状态码 */
|
2824
|
-
statusCode: number
|
2825
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
2826
|
-
header: Record<string, string>
|
2827
|
-
/** 开发者服务器返回的 cookies,格式为字符串数组 */
|
2828
|
-
cookies: string[]
|
2829
|
-
/** 网络请求过程中一些调试信息 */
|
2830
|
-
profile: Profile
|
2831
|
-
/** 网络请求id,用户取消、监听等操作 */
|
2832
|
-
taskId: string
|
2914
|
+
/** 录音文件的临时路径 (本地路径) */
|
2915
|
+
tempFilePath: string
|
2833
2916
|
}) => void
|
2834
2917
|
failure?: (params: {
|
2835
2918
|
errorMsg: string
|
@@ -2839,137 +2922,14 @@ declare namespace ty {
|
|
2839
2922
|
errorMsg: string
|
2840
2923
|
}
|
2841
2924
|
}) => void
|
2842
|
-
}):
|
2925
|
+
}): void
|
2843
2926
|
|
2844
2927
|
/**
|
2845
|
-
*
|
2928
|
+
* 开始持续录音
|
2846
2929
|
*/
|
2847
|
-
|
2848
|
-
/**
|
2849
|
-
|
2850
|
-
*/
|
2851
|
-
start(params: {
|
2852
|
-
/** 录音的时长,单位 ms,最大值 600000(10 分钟) */
|
2853
|
-
duration?: number
|
2854
|
-
/** 采样率 */
|
2855
|
-
sampleRate?: number
|
2856
|
-
/** 录音通道数 */
|
2857
|
-
numberOfChannels?: number
|
2858
|
-
/** 编码码率,有效值见下表格 */
|
2859
|
-
encodeBitRate?: number
|
2860
|
-
/** 音频格式 */
|
2861
|
-
format?: string
|
2862
|
-
/** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
|
2863
|
-
frameSize: number
|
2864
|
-
/** 指定录音的音频输入源 */
|
2865
|
-
audioSource?: string
|
2866
|
-
complete?: () => void
|
2867
|
-
success?: (params: {
|
2868
|
-
/** 录音文件的临时路径 (本地路径) */
|
2869
|
-
tempFilePath: string
|
2870
|
-
}) => void
|
2871
|
-
failure?: (params: {
|
2872
|
-
errorMsg: string
|
2873
|
-
errorCode: string | number
|
2874
|
-
innerError: {
|
2875
|
-
errorCode: string | number
|
2876
|
-
errorMsg: string
|
2877
|
-
}
|
2878
|
-
}) => void
|
2879
|
-
}): void
|
2880
|
-
|
2881
|
-
/**
|
2882
|
-
* 继续录音
|
2883
|
-
*/
|
2884
|
-
resume(params: {
|
2885
|
-
complete?: () => void
|
2886
|
-
success?: (params: {
|
2887
|
-
/** 录音文件的临时路径 (本地路径) */
|
2888
|
-
tempFilePath: string
|
2889
|
-
}) => void
|
2890
|
-
failure?: (params: {
|
2891
|
-
errorMsg: string
|
2892
|
-
errorCode: string | number
|
2893
|
-
innerError: {
|
2894
|
-
errorCode: string | number
|
2895
|
-
errorMsg: string
|
2896
|
-
}
|
2897
|
-
}) => void
|
2898
|
-
}): void
|
2899
|
-
|
2900
|
-
/**
|
2901
|
-
* 暂停录音
|
2902
|
-
*/
|
2903
|
-
pause(params: {
|
2904
|
-
complete?: () => void
|
2905
|
-
success?: (params: {
|
2906
|
-
/** 录音文件的临时路径 (本地路径) */
|
2907
|
-
tempFilePath: string
|
2908
|
-
}) => void
|
2909
|
-
failure?: (params: {
|
2910
|
-
errorMsg: string
|
2911
|
-
errorCode: string | number
|
2912
|
-
innerError: {
|
2913
|
-
errorCode: string | number
|
2914
|
-
errorMsg: string
|
2915
|
-
}
|
2916
|
-
}) => void
|
2917
|
-
}): void
|
2918
|
-
|
2919
|
-
/**
|
2920
|
-
* 停止录音
|
2921
|
-
*/
|
2922
|
-
stop(params: {
|
2923
|
-
complete?: () => void
|
2924
|
-
success?: (params: {
|
2925
|
-
/** 录音文件的临时路径 (本地路径) */
|
2926
|
-
tempFilePath: string
|
2927
|
-
}) => void
|
2928
|
-
failure?: (params: {
|
2929
|
-
errorMsg: string
|
2930
|
-
errorCode: string | number
|
2931
|
-
innerError: {
|
2932
|
-
errorCode: string | number
|
2933
|
-
errorMsg: string
|
2934
|
-
}
|
2935
|
-
}) => void
|
2936
|
-
}): void
|
2937
|
-
|
2938
|
-
/**
|
2939
|
-
* 开始持续录音
|
2940
|
-
*/
|
2941
|
-
startRecording(params: {
|
2942
|
-
/** 间隔时间 ms */
|
2943
|
-
period: number
|
2944
|
-
complete?: () => void
|
2945
|
-
success?: (params: null) => void
|
2946
|
-
failure?: (params: {
|
2947
|
-
errorMsg: string
|
2948
|
-
errorCode: string | number
|
2949
|
-
innerError: {
|
2950
|
-
errorCode: string | number
|
2951
|
-
errorMsg: string
|
2952
|
-
}
|
2953
|
-
}) => void
|
2954
|
-
}): void
|
2955
|
-
|
2956
|
-
/**
|
2957
|
-
* 停止持续录音
|
2958
|
-
*/
|
2959
|
-
stopRecording(params: {
|
2960
|
-
complete?: () => void
|
2961
|
-
success?: (params: null) => void
|
2962
|
-
failure?: (params: {
|
2963
|
-
errorMsg: string
|
2964
|
-
errorCode: string | number
|
2965
|
-
innerError: {
|
2966
|
-
errorCode: string | number
|
2967
|
-
errorMsg: string
|
2968
|
-
}
|
2969
|
-
}) => void
|
2970
|
-
}): void
|
2971
|
-
}
|
2972
|
-
export function getRecorderManager(params?: {
|
2930
|
+
startRecording(params: {
|
2931
|
+
/** 间隔时间 ms */
|
2932
|
+
period: number
|
2973
2933
|
complete?: () => void
|
2974
2934
|
success?: (params: null) => void
|
2975
2935
|
failure?: (params: {
|
@@ -2980,104 +2940,47 @@ declare namespace ty {
|
|
2980
2940
|
errorMsg: string
|
2981
2941
|
}
|
2982
2942
|
}) => void
|
2983
|
-
}):
|
2943
|
+
}): void
|
2984
2944
|
|
2985
2945
|
/**
|
2986
|
-
*
|
2946
|
+
* 停止持续录音
|
2987
2947
|
*/
|
2988
|
-
|
2989
|
-
|
2990
|
-
|
2991
|
-
|
2992
|
-
|
2993
|
-
|
2994
|
-
|
2995
|
-
failure?: (params: {
|
2996
|
-
errorMsg: string
|
2948
|
+
stopRecording(params: {
|
2949
|
+
complete?: () => void
|
2950
|
+
success?: (params: null) => void
|
2951
|
+
failure?: (params: {
|
2952
|
+
errorMsg: string
|
2953
|
+
errorCode: string | number
|
2954
|
+
innerError: {
|
2997
2955
|
errorCode: string | number
|
2998
|
-
|
2999
|
-
|
3000
|
-
|
3001
|
-
|
3002
|
-
|
3003
|
-
|
3004
|
-
|
3005
|
-
|
3006
|
-
|
3007
|
-
|
3008
|
-
|
3009
|
-
|
3010
|
-
|
3011
|
-
|
3012
|
-
|
3013
|
-
|
3014
|
-
|
3015
|
-
): void
|
3016
|
-
|
3017
|
-
/**
|
3018
|
-
* 取消监听 HTTP Response Header 事件
|
3019
|
-
*/
|
3020
|
-
offHeadersReceived(
|
3021
|
-
listener: (params: {
|
3022
|
-
/** 开发者服务器返回的 HTTP Response Header */
|
3023
|
-
header: Record<string, string>
|
3024
|
-
/** 网络请求id */
|
3025
|
-
requestId: string
|
3026
|
-
}) => void
|
3027
|
-
): void
|
3028
|
-
|
3029
|
-
/**
|
3030
|
-
* 监听上传进度变化事件
|
3031
|
-
*/
|
3032
|
-
onProgressUpdate(
|
3033
|
-
listener: (params: {
|
3034
|
-
/** 下载进度百分比 */
|
3035
|
-
progress: number
|
3036
|
-
/** 已经下载的数据长度,单位 Bytes */
|
3037
|
-
totalBytesSent: number
|
3038
|
-
/** 预期需要下载的数据总长度,单位 Bytes */
|
3039
|
-
totalBytesExpectedToSend: number
|
3040
|
-
/** 网络请求id */
|
3041
|
-
requestId: string
|
3042
|
-
}) => void
|
3043
|
-
): void
|
2956
|
+
errorMsg: string
|
2957
|
+
}
|
2958
|
+
}) => void
|
2959
|
+
}): void
|
2960
|
+
}
|
2961
|
+
export function getRecorderManager(params?: {
|
2962
|
+
complete?: () => void
|
2963
|
+
success?: (params: null) => void
|
2964
|
+
failure?: (params: {
|
2965
|
+
errorMsg: string
|
2966
|
+
errorCode: string | number
|
2967
|
+
innerError: {
|
2968
|
+
errorCode: string | number
|
2969
|
+
errorMsg: string
|
2970
|
+
}
|
2971
|
+
}) => void
|
2972
|
+
}): GetRecorderManagerTask
|
3044
2973
|
|
3045
|
-
|
3046
|
-
|
3047
|
-
|
3048
|
-
|
3049
|
-
|
3050
|
-
|
3051
|
-
|
3052
|
-
|
3053
|
-
totalBytesSent: number
|
3054
|
-
/** 预期需要下载的数据总长度,单位 Bytes */
|
3055
|
-
totalBytesExpectedToSend: number
|
3056
|
-
/** 网络请求id */
|
3057
|
-
requestId: string
|
3058
|
-
}) => void
|
3059
|
-
): void
|
3060
|
-
}
|
3061
|
-
export function uploadFile(params: {
|
3062
|
-
/** 开发者服务器地址 */
|
3063
|
-
url: string
|
3064
|
-
/** 要上传文件资源的路径 (本地路径) */
|
3065
|
-
filePath: string
|
3066
|
-
/** 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 */
|
3067
|
-
name: string
|
3068
|
-
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
3069
|
-
header?: Record<string, string>
|
3070
|
-
/** HTTP 请求中其他额外的 form data */
|
3071
|
-
formData?: Record<string, string>
|
3072
|
-
/** 超时时间,单位为毫秒 */
|
3073
|
-
timeout?: number
|
2974
|
+
/**
|
2975
|
+
* 获取网络请求任务对象RequestTask
|
2976
|
+
*/
|
2977
|
+
interface UploadFileTask {
|
2978
|
+
/**
|
2979
|
+
* 中断上传任务
|
2980
|
+
*/
|
2981
|
+
abort(params: {
|
3074
2982
|
complete?: () => void
|
3075
|
-
success?: (params:
|
3076
|
-
/** 开发者服务器返回的数据 */
|
3077
|
-
data: string
|
3078
|
-
/** 开发者服务器返回的 HTTP 状态码 */
|
3079
|
-
statusCode: number
|
3080
|
-
}) => void
|
2983
|
+
success?: (params: null) => void
|
3081
2984
|
failure?: (params: {
|
3082
2985
|
errorMsg: string
|
3083
2986
|
errorCode: string | number
|
@@ -3086,5 +2989,90 @@ declare namespace ty {
|
|
3086
2989
|
errorMsg: string
|
3087
2990
|
}
|
3088
2991
|
}) => void
|
3089
|
-
}):
|
2992
|
+
}): void
|
2993
|
+
|
2994
|
+
/**
|
2995
|
+
* 监听 HTTP Response Header 事件。会比请求完成事件更早
|
2996
|
+
*/
|
2997
|
+
onHeadersReceived(
|
2998
|
+
listener: (params: {
|
2999
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
3000
|
+
header: Record<string, string>
|
3001
|
+
/** 网络请求id */
|
3002
|
+
requestId: string
|
3003
|
+
}) => void
|
3004
|
+
): void
|
3005
|
+
|
3006
|
+
/**
|
3007
|
+
* 取消监听 HTTP Response Header 事件
|
3008
|
+
*/
|
3009
|
+
offHeadersReceived(
|
3010
|
+
listener: (params: {
|
3011
|
+
/** 开发者服务器返回的 HTTP Response Header */
|
3012
|
+
header: Record<string, string>
|
3013
|
+
/** 网络请求id */
|
3014
|
+
requestId: string
|
3015
|
+
}) => void
|
3016
|
+
): void
|
3017
|
+
|
3018
|
+
/**
|
3019
|
+
* 监听上传进度变化事件
|
3020
|
+
*/
|
3021
|
+
onProgressUpdate(
|
3022
|
+
listener: (params: {
|
3023
|
+
/** 下载进度百分比 */
|
3024
|
+
progress: number
|
3025
|
+
/** 已经下载的数据长度,单位 Bytes */
|
3026
|
+
totalBytesSent: number
|
3027
|
+
/** 预期需要下载的数据总长度,单位 Bytes */
|
3028
|
+
totalBytesExpectedToSend: number
|
3029
|
+
/** 网络请求id */
|
3030
|
+
requestId: string
|
3031
|
+
}) => void
|
3032
|
+
): void
|
3033
|
+
|
3034
|
+
/**
|
3035
|
+
* 取消监听上传进度变化事件
|
3036
|
+
*/
|
3037
|
+
offProgressUpdate(
|
3038
|
+
listener: (params: {
|
3039
|
+
/** 下载进度百分比 */
|
3040
|
+
progress: number
|
3041
|
+
/** 已经下载的数据长度,单位 Bytes */
|
3042
|
+
totalBytesSent: number
|
3043
|
+
/** 预期需要下载的数据总长度,单位 Bytes */
|
3044
|
+
totalBytesExpectedToSend: number
|
3045
|
+
/** 网络请求id */
|
3046
|
+
requestId: string
|
3047
|
+
}) => void
|
3048
|
+
): void
|
3090
3049
|
}
|
3050
|
+
export function uploadFile(params: {
|
3051
|
+
/** 开发者服务器地址 */
|
3052
|
+
url: string
|
3053
|
+
/** 要上传文件资源的路径 (本地路径) */
|
3054
|
+
filePath: string
|
3055
|
+
/** 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 */
|
3056
|
+
name: string
|
3057
|
+
/** HTTP 请求的 Header,Header 中不能设置 Referer */
|
3058
|
+
header?: Record<string, string>
|
3059
|
+
/** HTTP 请求中其他额外的 form data */
|
3060
|
+
formData?: Record<string, string>
|
3061
|
+
/** 超时时间,单位为毫秒 */
|
3062
|
+
timeout?: number
|
3063
|
+
complete?: () => void
|
3064
|
+
success?: (params: {
|
3065
|
+
/** 开发者服务器返回的数据 */
|
3066
|
+
data: string
|
3067
|
+
/** 开发者服务器返回的 HTTP 状态码 */
|
3068
|
+
statusCode: number
|
3069
|
+
}) => void
|
3070
|
+
failure?: (params: {
|
3071
|
+
errorMsg: string
|
3072
|
+
errorCode: string | number
|
3073
|
+
innerError: {
|
3074
|
+
errorCode: string | number
|
3075
|
+
errorMsg: string
|
3076
|
+
}
|
3077
|
+
}) => void
|
3078
|
+
}): UploadFileTask
|