@tarojs/components 3.5.5 → 3.5.6-alpha.1

package/types/LivePusher.d.ts

@@ -7,115 +7,114 @@ import { StandardProps, CommonEventFunction, NetStatus } from './common'
  */
 interface LivePusherProps extends StandardProps {
   /** 推流地址。目前仅支持 rtmp 格式
-   * @supported weapp
+   * @supported weapp, qq
    */
   url?: string
 
   /** SD（标清）, HD（高清）, FHD（超清）, RTC（实时通话）
    * @default "RTC"
-   * @supported weapp
+   * @supported weapp, qq
    */
   mode?: 'SD' | 'HD' | 'FHD' | 'RTC'
 
   /** 自动推流
    * @default false
-   * @supported weapp
+   * @supported weapp, qq
    */
   autopush?: boolean
 
   /** 是否静音。即将废弃，可用 enable-mic 替代
    * @default false
    * @deprecated
-   * @supported weapp
+   * @supported weapp, qq
    */
   muted?: boolean
 
   /** 开启摄像头
    * @default true
-   * @supported weapp
+   * @supported weapp, qq
    */
   enableCamera?: boolean
 
   /** 自动聚集
    * @default true
-   * @supported weapp
+   * @supported weapp, qq
    */
   autoFocus?: boolean
 
   /** 画面方向
    * @default "vertical"
-   * @supported weapp
+   * @supported weapp, qq
    */
   orientation?: keyof LivePusherProps.Orientation
 
   /** 美颜，取值范围 0-9 ，0 表示关闭
    * @default 0
-   * @supported weapp
+   * @supported weapp, qq
    */
   beauty?: number
 
   /** 美白，取值范围 0-9 ，0 表示关闭
    * @default 0
-   * @supported weapp
+   * @supported weapp, qq
    */
   whiteness?: number
 
   /** 宽高比，可选值有 3:4, 9:16
    * @default "9:16"
-   * @supported weapp
+   * @supported weapp, qq
    */
   aspect?: '9:16' | '3:4'
 
   /** 最小码率
    * @default 200
-   * @supported weapp
+   * @supported weapp, qq
    */
   minBitrate?: number
 
   /** 最大码率
    * @default 1000
-   * @supported weapp
+   * @supported weapp, qq
    */
   maxBitrate?: number
 
   /** 高音质(48KHz)或低音质(16KHz)，值为high, low
    * @default "high"
-   * @supported weapp
+   * @supported weapp, qq
    */
   audioQuality?: string
 
   /** 进入后台时推流的等待画面
-   * @supported weapp
+   * @supported weapp, qq
    */
   waitingImage?: string
 
   /** 等待画面资源的MD5值
-   * @supported weapp
+   * @supported weapp, qq
    */
   waitingImageHash?: string
 
   /** 调整焦距
    * @default false
-   * @supported weapp
+   * @supported weapp, qq
    */
   zoom?: boolean
 
   /** 前置或后置，值为front, back
    * @default "front"
-   * @supported weapp
+   * @supported weapp, qq
    */
   devicePosition?: string
 
   /** 进入后台时是否静音
    * @default false
-   * @supported weapp
+   * @supported weapp, qq
    */
   backgroundMute?: boolean
 
   /** 设置推流画面是否镜像，产生的效果在 LivePlayer 反应到
    * @default false
-   * @supported weapp
-   * @deprecated
+   * @supported weapp, qq
    */
   mirror?: boolean
 
@@ -135,7 +134,7 @@ interface LivePusherProps extends StandardProps {
 
   /** 音频混响类型
    * @default 0
-   * @supported weapp
+   * @supported weapp, qq
    */
   audioReverbType?: keyof LivePusherProps.AudioReverbType
 
@@ -188,32 +187,22 @@ interface LivePusherProps extends StandardProps {
   filter?: keyof LivePusherProps.FilterType
 
   /** 状态变化事件，detail = {code}
-   * @supported weapp
+   * @supported weapp, qq
    */
   onStateChange?: CommonEventFunction<LivePusherProps.onStateChangeEventDetail>
 
-  /** 网络状态通知，detail = {info}
-   * @supported weapp
-   */
-  onNetstatus?: CommonEventFunction<LivePusherProps.onNetstatusEventDetail>
-
   /** 渲染错误事件，detail = {errMsg, errCode}
-   * @supported weapp
+   * @supported weapp, qq
    */
   onError?: CommonEventFunction<LivePusherProps.onErrorEventDetail>
 
-  /** 背景音开始播放时触发
-   * @supported weapp
-   */
-  onBgmStart?: CommonEventFunction
-
   /** 背景音进度变化时触发，detail = {progress, duration}
-   * @supported weapp
+   * @supported weapp, qq
    */
   onBgmProgress?: CommonEventFunction<LivePusherProps.onBgmProgressEventDetail>
 
   /** 背景音播放完成时触发
-   * @supported weapp
+   * @supported weapp, qq
    */
   onBgmComplete?: CommonEventFunction
 
@@ -221,80 +210,131 @@ interface LivePusherProps extends StandardProps {
    * @supported weapp
    */
   onAudioVolumeNotify?: CommonEventFunction
-}
 
+  /** 设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： ["push", "pop"]）
+   * @supported weapp
+   */
+  pictureInPictureMode?: string | any[]
+
+  /** 网络状态通知，detail = {info}
+   * @supported weapp, qq
+   */
+  onNetStatus?: CommonEventFunction
+
+  /** 进入小窗
+   * @supported weapp
+   */
+  onEnterPictureInPicture?: string
+
+  /** 退出小窗
+   * @supported weapp
+   */
+  onLeavePictureInPicture?: string
+
+  /** 背景音开始播放时触发
+   * @supported weapp, qq
+   */
+  onBgmStart?: CommonEventFunction
+}
 declare namespace LivePusherProps {
   /** orientation 的合法值 */
   interface Orientation {
     /** 竖直 */
     vertical
+
     /** 水平 */
     horizontal
   }
+
   /** localMirror 的合法值 */
   interface LocalMirror {
     /** 前置摄像头镜像，后置摄像头不镜像 */
     auto
+
     /** 前后置摄像头均镜像 */
     enable
+
     /** 前后置摄像头均不镜像 */
     disable
   }
+
   /** audioReverbType 的合法值 */
   interface AudioReverbType {
     /** 关闭 */
     0
+
     /** KTV */
     1
+
     /** 小房间 */
     2
+
     /** 大会堂 */
     3
+
     /** 低沉 */
     4
+
     /** 洪亮 */
     5
+
     /** 金属声 */
     6
+
     /** 磁性 */
     7
   }
+
   /** audioVolumeType 的合法值 */
   interface AudioVolumeType {
     /** 媒体音量 */
     media
+
     /** 通话音量 */
     voicecall
   }
+
   /** beautyStyleType 的合法值 */
   interface BeautyStyleType {
     /** 光滑美颜 */
     smooth
+
     /** 自然美颜 */
     nature
   }
+
   /** filterType 的合法值 */
   interface FilterType {
     /** 标准 */
     standard
+
     /** 粉嫩 */
     pink
+
     /** 怀旧 */
     nostalgia
+
     /** 蓝调 */
     blues
+
     /** 浪漫 */
     romantic
+
     /** 清凉 */
     cool
+
     /** 清新 */
     fresher
+
     /** 日系 */
     solor
+
     /** 唯美 */
     aestheticism
+
     /** 美白 */
     whitening
+
     /** 樱红 */
     cerisered
   }
@@ -309,12 +349,14 @@ declare namespace LivePusherProps {
   interface onErrorEventDetail {
     /** 错误信息 */
     errMsg: string
+
     /** 错误码 */
     errCode: string | number
   }
   interface onBgmProgressEventDetail {
     /** 进展 */
     progress
+
     /** 持续时间 */
     duration: number
   }
@@ -343,5 +385,4 @@ declare namespace LivePusherProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/live-pusher.html
  */
 declare const LivePusher: ComponentType<LivePusherProps>
-
 export { LivePusher, LivePusherProps }