xverse-components-tv
v1.0.24
Published
xverse components tv
Readme
API
| 参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 | | ---------------------------- | ------------------ | ----------------------------- | ------- | ------------ | --------------------------------------------------------------------- | ----- | --- | | componentId | string | | - | true | - | | bomId | string | TV3D 资产(模型) | - | true | - | | url | string | TV 的源地址 | - | false | 支持视频和图片,如果是图片,则当作贴图展示 | | posterUrl | string | 视频封面 | - | false | TV 的源是视频时,需要配置封面 | | autoPlay | boolean | 初始播放状态 | - | false | true 为播放,false 为暂停,默认为暂停 | | loop | boolean | 循环播放 | true | false | - | | isOnlyShowFirstFrame | boolean | 是否只展示首帧图片 | - | false | 如果开启,tv 配置源地址为视频的时候也会只展示图片,图片源为视频的首帧 | | isClickToPlayFull | boolean | 是否响应点击全屏播放 | - | false | 点击就全屏播放,优先级高于点击暂停或播放的逻辑 | | notExternal | | fullScreenCloseButtonStyle | CSSProperties | 关闭全屏按钮样式 | - | false | - | | canPause | boolean | 支持点击播放/暂停 | - | false | - | | canPlayWhenPaused | boolean | 暂停时支持点击播放 | - | false | 仅支持暂停时,点击播放;播放时,点击不响应 | | disposeWhenComponentsDispose | boolean | 组件销毁时是否销毁场景中的 TV | - | false | - | | fitMode | 'Fill' | 'Contain' | 'Cover' | 视频填充模式 | Cover | false | - | | interactiveTimeQueue | IInteraction[] | 交互视频配置 | - | false | 配置时间为秒级别,即 1000 的整数倍 | | muted | boolean | 是否静音 | - | false | - | | isSeparateControlVolume | boolean | 是否单独控制 | - | false | 如果声音开启了单独控制,可以在要控制该音频的组件里选中该组件 | | needCustomControl | boolean | 是否使用自定义控件 | - | false | - | | videoContainerStyle | CSSProperties | video 容器样式设置 | - | false | video 父容器宽高等样式设置 | | resolution | ITVResolution | TV 的分辨率大小 | - | false | - | | isGreenScreen | boolean | 是否是绿幕视频 | - | false | - | | greenScreenConfig | IGreenScreenConfig | 绿幕视频配置 | - | false | - | | onShowFullScreen | () => void | 点击全屏展示的回调 | - | false | - | | onCloseFullScreen | () => void | 关闭全屏展示的回调 | - | false | - | | onClick | () => void | 点击 tv 的回调 | - | false | - | | onEnd | () => void | 视频播放结束的回调 | - | false | - | | onCanPlay | () => void | 视频可播放触发的回调 | - | false | - | | onFirstTimeUpdate | () => void | 视频第一帧触发的回调 | - | false | - |
