For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/components/media/video.md.

video

视频播放组件,支持本地和网络视频资源的播放控制。

扫码预览

扫码预览 video

Props

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