tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/api/create-intersection-observer.md

@@ -0,0 +1,195 @@
+## uni.createIntersectionObserver(component, options) @createintersectionobserver
+
+创建并返回一个 IntersectionObserver 对象实例
+
+### createIntersectionObserver 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| component | any | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） |
+| options | **CreateIntersectionObserverOptions** | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| thresholds | Array&lt;any&gt; | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 所有阈值 |
+| initialRatio | number | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 初始的相交比例 |
+| observeAll | boolean | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 是否同时观测多个参照节点（而非一个） |
+| nativeMode | boolean | 否 | 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 需要基础库： `3.5.7`<br/><br/>是否使用原生观察器模式。<br/> |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [IntersectionObserver](#intersectionobserver-values) |
+
+#### IntersectionObserver 的方法 @intersectionobserver-values 
+
+#### relativeTo(selector: string, margins?: any): IntersectionObserver; @relativeto
+relativeTo
+使用选择器指定一个节点，作为参照区域之一
+##### relativeTo 兼容性  
+| Android | iOS | HarmonyOS |
+| :- | :- | :- |
+| x | x | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| selector | string | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） |
+| margins | any | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| IntersectionObserver |
+ 
+
+#### relativeToViewport(margins?: any): IntersectionObserver; @relativetoviewport
+relativeToViewport
+指定页面显示区域作为参照区域之一
+##### relativeToViewport 兼容性  
+| Android | iOS | HarmonyOS |
+| :- | :- | :- |
+| x | x | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| margins | any | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| IntersectionObserver |
+ 
+
+#### observe(targetSelector: string, callback: ObserveCallback): void; @observe
+observe
+指定目标节点并开始监听相交状态变化情况
+##### observe 兼容性  
+| Android | iOS | HarmonyOS |
+| :- | :- | :- |
+| x | x | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| targetSelector | string | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） |
+| callback | (result: [ObserveResult](#observeresult-values)) => void | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 
+
+##### ObserveResult 的属性值 @observeresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| intersectionRatio | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 相交比例 |
+| intersectionRect | any | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 相交区域的边界 |
+| boundingClientRect | **ObserveNodeRect** | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 目标节点布局区域的边界 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| left | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | left |
+| right | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | right |
+| top | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | top |
+| bottom | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | bottom |
+| relativeRect | **ObserveNodeRect** | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 参照区域的边界 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| left | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | left |
+| right | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | right |
+| top | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | top |
+| bottom | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | bottom |
+| time | number | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 相交检测时的时间戳 |
+
+#### disconnect(): void; @disconnect
+disconnect
+停止监听
+##### disconnect 兼容性  
+| Android | iOS | HarmonyOS |
+| :- | :- | :- |
+| x | x | x |
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/create-intersection-observer/create-intersection-observer.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/create-intersection-observer/create-intersection-observer.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/create-intersection-observer/create-intersection-observer
+
+>示例
+```vue
+<template>
+	<view class="observer-page uni-theme-root">
+		<page-head :title="data.title"></page-head>
+		<view class="uni-padding-wrap uni-common-mt">
+			<view class="uni-title uni-common-mt">
+				{{data.appear ? '小球出现' : '小球消失'}}
+			</view>
+			<scroll-view class="scroll-view" :scrollTop="data.scrollTop">
+				<view class="scroll-area">
+					<text class="notice">向下滚动让小球出现</text>
+					<view class="ball"></view>
+				</view>
+			</scroll-view>
+		</view>
+	</view>
+</template>
+
+<style>
+	.scroll-view {
+		height: 200px;
+		background-color: var(--list-background-color, #fff);
+		border: 1px solid var(--border-color, #ccc);
+		box-sizing: border-box;
+	}
+
+	.scroll-area {
+		height: 650px;
+		display: flex;
+		flex-direction: column;
+		align-items: center;
+	}
+
+	.notice {
+		margin-top: 75px;
+		margin:75px 0 200px 0;
+		color: var(--text-color, #333333);
+	}
+
+	.ball {
+		width: 100px;
+		height: 100px;
+		background: #4cd964;
+		border-radius: 100px;
+	}
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.createIntersectionObserver)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/intersection-observer.html#createintersectionobserver)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=createIntersectionObserver&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=createIntersectionObserver&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=createIntersectionObserver&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=createIntersectionObserver&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=createIntersectionObserver)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=createIntersectionObserver&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/create-interstitial-ad.md

@@ -0,0 +1,253 @@
+## uni.createInterstitialAd(option) @createinterstitialad
+
+创建插屏广告对象
+
+插屏是一种弹出在屏幕中间的、带有关闭按钮的广告。大部分插屏广告是半屏的，个别广告会全屏。这取决于广告聚合渠道的设置。
+
+- uni-ad的业务介绍：[详见](https://uniapp.dcloud.net.cn/uni-ad/intro.html)
+
+上述文档是uni-app和uni-app x的通用文档，如遇到uni-app x不一致的文档，需以uni-app x文档为准。
+
+开通插屏广告，需在 [https://uniad.dcloud.net.cn/](https://uniad.dcloud.net.cn/) 管理后台开通。
+
+开通时需要进行开发者认证和应用资质审核。
+
+2. 获取和使用广告位id
+
+开通uni-ad后，在[uni-ad后台](https://uniad.dcloud.net.cn/)给应用创建插屏广告位后，需要拿到广告位id（adpid），传入下面的api `createInterstitialAd`中。
+
+3. 配置广告模块
+
+App平台在manifest中配置添加三方广告SDK。具体配置可参考[文档](../collocation/manifest-modules.md#uni-ad)。
+
+打正式包或自定义基座后可生效。标准基座包含的是测试广告位，无法为你产生收益。
+
+### createInterstitialAd 兼容性  
+| Web | 微信小程序 | Android | iOS |
+| :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | 4.31 | 4.31 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| option | **CreateInterstitialAdOptions** | 是 | Web x（部分支持，见上） |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| adpid | string | 是 | Web x（部分支持，见上） | 广告位 id |
+| adUnitId | string | 否 | Web x / 微信小程序 4.41（部分支持，见上） | 广告单元 id<br/> |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [InterstitialAd](#interstitialad-values) |
+
+#### InterstitialAd 的方法 @interstitialad-values 
+
+#### show() : Promise\<any> @show
+show
+广告加载成功之后，调用此方法展示广告
+##### show 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<any> |
+ 
+
+#### load() : Promise\<any> @load
+load
+加载广告
+##### load 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| Promise\<any> |
+ 
+
+#### destroy() : void @destroy
+destroy
+销毁广告
+##### destroy 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+#### onLoad(callback : AdCallBackEvent) : void @onload
+onLoad
+绑定广告 load 事件的监听器
+##### onLoad 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: any) => void | 是 | Web x（部分支持，见上） | 
+
+#### offLoad(callback : AdCallBackEvent) : void @offload
+offLoad
+解除绑定 load 事件的监听器
+##### offLoad 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: any) => void | 是 | Web x（部分支持，见上） | 
+
+#### onError(callback : AdErrorCallBackEvent) : void @onerror
+onError
+绑定 error 事件的监听器
+##### onError 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | Web x（部分支持，见上） | 
+
+##### IUniAdError 的属性值 @iuniaderror-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errCode | number | 是 | Web x（部分支持，见上） | 错误码<br/>- -5001 广告位标识adpid为空，请传入有效的adpid<br/>- -5002 无效的广告位标识adpid，请使用正确的adpid<br/>- -5003 广告位未开通广告，请在广告平台申请并确保已审核通过<br/>- -5004 无广告模块，打包时请配置要使用的广告模块<br/>- -5005 广告加载失败，请稍后重试<br/>- -5006 广告已经展示过了，请重新加载<br/>- -5007 广告不可用或已过期，请重新请求<br/>- -5008 广告不可用或已过期，请重新请求<br/>- -5009 广告类型不符，请检查后再试<br/>- -5011 打包或开通的渠道，不支持此类型广告<br/>- -5013 广告播放失败，请重新加载 |
+| errSubject | string | 是 | Web x（部分支持，见上） | 统一错误主题（模块）名称 |
+| data | any | 否 | Web x（部分支持，见上） | 错误信息中包含的数据 |
+| cause | Error | 否 |   | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 | Web x（部分支持，见上） |  |
+
+#### offError(callback : AdErrorCallBackEvent) : void @offerror
+offError
+解除绑定 error 事件的监听器
+##### offError 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | Web x（部分支持，见上） | 
+
+##### IUniAdError 的属性值 @iuniaderror-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errCode | number | 是 | Web x（部分支持，见上） | 错误码<br/>- -5001 广告位标识adpid为空，请传入有效的adpid<br/>- -5002 无效的广告位标识adpid，请使用正确的adpid<br/>- -5003 广告位未开通广告，请在广告平台申请并确保已审核通过<br/>- -5004 无广告模块，打包时请配置要使用的广告模块<br/>- -5005 广告加载失败，请稍后重试<br/>- -5006 广告已经展示过了，请重新加载<br/>- -5007 广告不可用或已过期，请重新请求<br/>- -5008 广告不可用或已过期，请重新请求<br/>- -5009 广告类型不符，请检查后再试<br/>- -5011 打包或开通的渠道，不支持此类型广告<br/>- -5013 广告播放失败，请重新加载 |
+| errSubject | string | 是 | Web x（部分支持，见上） | 统一错误主题（模块）名称 |
+| data | any | 否 | Web x（部分支持，见上） | 错误信息中包含的数据 |
+| cause | Error | 否 |   | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 | Web x（部分支持，见上） |  |
+
+#### onClose(callback : AdCallBackEvent) : void @onclose
+onClose
+绑定 close 事件的监听器
+##### onClose 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: any) => void | 是 | Web x（部分支持，见上） | 
+
+#### offClose(callback : AdCallBackEvent) : void @offclose
+offClose
+解除绑定 close 事件的监听器
+##### offClose 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: any) => void | 是 | Web x（部分支持，见上） | 
+
+#### onAdClicked(callback : AdCallBackEvent) : void; @onadclicked
+onAdClicked
+绑定广告可点击屏幕区域事件的监听器
+##### onAdClicked 兼容性  
+| Web | Android | iOS |
+| :- | :- | :- |
+| x | 4.31 | 4.31 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: any) => void | 是 | Web x（部分支持，见上） |
+
+## Tips
+
++ uni-app x 标准基座插屏广告测试广告位id为`1111111113`。正式开发需配置自己的广告位id，并且打包自定义基座后生效。
++ 插屏广告目前仅支持API形式，暂不支持组件形式。
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/create-interstitial-ad/create-interstitial-ad.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/create-interstitial-ad/create-interstitial-ad.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/create-interstitial-ad/create-interstitial-ad
+```uvue
+<template>
+  <page-head title="插屏广告"></page-head>
+  <button :type="btnType" style="margin: 10px;" :disabled="btnDisable" @click="showAd()">{{btnText}}</button>
+  <view v-for="(item,index) in errorDetails">{{item}}</view>
+</template>
+
+
+
+<style>
+
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ad.createInterstitialAd)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uni-ad/ad-interstitial.html#api%E8%AF%AD%E6%B3%95)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ad/InterstitialAd.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=createInterstitialAd&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=createInterstitialAd&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=createInterstitialAd&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=createInterstitialAd&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=createInterstitialAd)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=createInterstitialAd&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/create-live-player-context.md

@@ -0,0 +1,185 @@
+::: sourceCode
+## uni.createLivePlayerContext(livePlayerId, component?) @createliveplayercontext
+
+创建并返回 live-player 组件上下文 LivePlayerContext 对象
+
+参考文档：
+[live-player组件文档](../component/live-player.md)
+
+### createLivePlayerContext 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.81 | 4.81 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| livePlayerId | string | 是 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） |
+| component | ComponentPublicInstance | 否 |   |
+
+### 返回值 
+
+| 类型 | 描述 | 必备 |
+| :- | :- | :- |
+| [LivePlayerContext](#liveplayercontext-values) | live-player 组件上下文对象 | 否 |
+
+#### LivePlayerContext 的方法 @liveplayercontext-values 
+
+#### play(options?: LivePlayerOptions) : void @play
+play
+播放
+##### play 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### pause(options?: LivePlayerOptions) : void @pause
+pause
+暂停
+##### pause 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### stop(options?: LivePlayerOptions) : void @stop
+stop
+停止
+##### stop 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### resume(options?: LivePlayerOptions) : void @resume
+resume
+恢复
+##### resume 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### mute(options?: LivePlayerOptions): void @mute
+mute
+静音
+##### mute 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### requestFullScreen(options?: LivePlayerOptions): void @requestfullscreen
+requestFullScreen
+全屏
+##### requestFullScreen 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### exitFullScreen(options?: LivePlayerOptions): void @exitfullscreen
+exitFullScreen
+退出全屏
+##### exitFullScreen 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| x | x | 4.81 | 4.81 | x |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **LivePlayerOptions** | 否 | Web x / 微信小程序 x / HarmonyOS x（部分支持，见上） | 方法调用参数 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (res: UTSJSONObject) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x / Android 4.81 / iOS 4.81 / HarmonyOS x（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.createLivePlayerContext)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/media/live-player-context.html#createLivePlayerContext)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/live/LivePlayerContext.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=createLivePlayerContext&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=createLivePlayerContext&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=createLivePlayerContext&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=createLivePlayerContext&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=createLivePlayerContext)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=createLivePlayerContext&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+示例代码另见[live-player组件文档](../component/live-player.md)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |