#video
视频播放组件,支持本地和网络视频资源的播放控制。
#扫码预览
#Props
| 属性名 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| as | "Audio" | "Video" | 'Video' | 否 | 媒体的类型 |
| attached | boolean | - | 否 | 是否按需加载播放器实例,用于性能优化,常用于列表场景,其他情况无需设置 |
| autoPlay | boolean | false | 否 | 流数据变化后自动播放。 |
| autoPrepare | boolean | true | 否 | 在资源准备完成后自动预渲染播放器(显示首帧) |
| domain | string | undefined | 否 | 使用 vid 播放视频需要同时传入 token 和 domain。头条支持仅传入 vid。查看更多. |
| fullscreenMode | "landscape" | "portrait" | 'landscape' | 否 | 全屏模式下是否旋转 |
| initTime | number | false | 否 | 在资源准备完成后自动预渲染播放器(显示首帧) |
| loop | boolean | false | 否 | 循环播放。视频开始播放后,循环状态变化不会改变视频的当前播放/暂停状态。 |
| mute | boolean | false | 否 | 是否静音实时播放器。 |
| objectfit | "scaleToFill" | "aspectFit" | "aspectFill" | 'aspectFit' | 否 | 指定视频裁剪/缩放模式。 |
| onAppear | () => void | undefined @eventProperty | 否 | 播放器可见。应该指定 scene 和 videoengineId。 |
| onDisappear | () => void | undefined @eventProperty | 否 | 播放器不可见。应该指定 scene 和 videoengineId。 |
| onEnded | () => void | undefined @eventProperty | 否 | 播放器播放结束。 |
| onError | (e: { errorCode: number; errorMsg: string }) => void | undefined @eventProperty | 否 | 播放器接收到错误信息。 |
| onFirstFrame | () => void | undefined @eventProperty | 否 | 视频开始渲染首帧时触发 |
| onPause | () => void | undefined @eventProperty | 否 | 播放器暂停。 |
| onPlay | () => void | undefined @eventProperty | 否 | 播放器开始播放。 |
| onPrepared | () => void | undefined @eventProperty | 否 | 播放器准备好播放。 |
| onRedirected | () => void | undefined @eventProperty | 否 | 如果访问 gecko 资源,加载是异步的 |
| onSeek | (willPlay: boolean) => void | undefined @eventProperty | 否 | 播放器搜索。 |
| onSrcChanged | () => void | undefined @eventProperty | 否 | 源文件发生变化 |
| onStop | () => void | undefined @eventProperty | 否 | 播放器停止。 |
| onTimeUpdate | (e: { detail: { current: number; total: number } }) => void | undefined @eventProperty | 否 | 播放器进度更新 |
| pauseOnHide | boolean | false | 否 | 指定当 LynxView 退出背景或移出屏幕后是否暂停视频,以防止声音泄漏 |
| playbackSpeed | number | 1.0 | 否 | 指定播放速度 |
| playerType | string & {} | "light" | "default" | 'default' | 否 | 自定义播放器后端。宿主可注入其自己的播放器。playerType === 'light' 不支持 preloadKey。 |
| playUrl | string | undefined | 否 | 指定视频播放源,一旦设置 play-url,播放器将尝试异步加载资源。在绑定重定向之前,所有播放控制逻辑将无效。 |
| poster | string | undefined | 否 | 海报。播放后将被取消显示。 |
| preloadKey | string | undefined | 否 | 指定视频预加载的键(不支持 playerType === 'light')。如果未填写,则为 iOS 的 URL 的 md5 和 Android 的 hashcode。视频预加载方案 |
| ref | ForwardedRef<VideoEngineRef> | - | 否 | - |
| resolution | "auto" | 'auto' | 否 | 指定播放分辨率。 |
| scene | string | 'videoengine' | 否 | 用于标记曝光时间点。请确保在整个页面中唯一。 |
| style | CSSProperties | undefined | 否 | 包装器的样式,特别用于设置圆角 |
| token | string | undefined | 否 | 使用 vid 播放视频需要同时传入 token 和 domain。头条支持仅传入 vid。 |
| videoEngineId | string | 'videoengine' | 否 | 用于选择 x-video-engine。请确保在整个页面中唯一。 |
| videoId | string | undefined | 否 | 使用 vid 指定视频播放源。大多数主机会使用 vid 来播放。你需要同时传入 token 和 domain。头条支持仅传入 vid。 |
| videoModel | string | undefined | 否 | 指定视频播放源,使用公司推荐的视频模型数据结构播放资源,表现为 JSON 字符串。 |
| volume | number | 1.0 | 否 | 指定音量,范围:[0.0, 1.0] |