UNPKG

1.75 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps, CommonEventFunction } from './common'
3interface ChannelVideoProps extends StandardProps {
4 /** 仅视频号视频与小程序同主体时生效。若内嵌非同主体视频,请使用 feed-token。
5 * @supported weapp
6 */
7 feedId: string
8 /** 视频号 id,以“sph”开头的id,可在视频号助手获取。视频号必须与当前小程序相同主体。
9 * @supported weapp
10 */
11 finderUserName: string
12 /** 是否循环播放
13 * @supported weapp
14 * @default false
15 */
16 loop?: boolean
17 /** 是否静音播放
18 * @supported weapp
19 * @default false
20 */
21 muted?: boolean
22 /** 当视频大小与 video 容器大小不一致时,视频的表现形式
23 * @supported weapp
24 * @default "contain"
25 */
26 objectFit?: 'fill' | 'contain' | 'cover'
27 /** 是否自动播放
28 * @supported weapp
29 * @default false
30 */
31 autoplay?: boolean
32 /** 仅内嵌小程序非同主体视频号视频时使用,获取方式参考[本指引](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/channels-activity.html#feed-token)。
33 * @supported weapp
34 */
35 feedToken?: string
36 /** 视频播放出错时触发
37 * @supported weapp
38 */
39 onError?: CommonEventFunction
40}
41/**
42 * 小程序内嵌视频号视频组件,支持在小程序中播放视频号视频,并无弹窗跳转至视频号。注意:使用该组件打开的视频号视频需要与小程序相同主体或关联主体。
43 * @classification media
44 * @supported weapp
45 * @see https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html
46 */
47declare const ChannelVideo: ComponentType<ChannelVideoProps>
48export { ChannelVideo, ChannelVideoProps }