API

Video

nsh 导出 Video:基于平台播放器构建的视频播放器(iOS 和 Mac Catalyst 上是 AVPlayer,Android 上是 MediaPlayer)。播放由属性控制,所以暂停只需改一个 signal。

import { Video, type VideoProps } from "nsh";

教程见网页视图与视频,属性见 <Video>。

#Video

const Video: (props: VideoProps) => YNode;

interface VideoProps extends Omit<ViewProps, "children">, VideoHostProps {
  src: string;
}
import { mount, signal, Text, Video, View, type YNode } from "nsh";

function Player() {
  const paused = signal(true);
  const time = signal("");
  let video!: YNode;
  return (
    <View style={{ flex: 1, padding: 16, gap: 12 }}>
      <Video
        ref={video}
        src="https://example.com/clip.mp4"
        paused={paused()}
        muted
        repeat
        resizeMode="cover"
        style={{ height: 220, borderRadius: 8, overflow: "hidden", backgroundColor: "#000" }}
        onProgress={(e) => time.set(`${e.currentTime.toFixed(1)} / ${e.duration.toFixed(1)} s`)}
      />
      <View style={{ flexDirection: "row", gap: 16 }}>
        <Text onPress={() => paused.update((p) => !p)}>{paused() ? "Play" : "Pause"}</Text>
        <Text onPress={() => video.seek(0)}>Restart</Text>
        <Text>{time()}</Text>
      </View>
    </View>
  );
}

mount(Player);

#属性

Video 接受视图属性(样式、class、布局、无障碍、ref;不接受子元素),另外还有:

属性类型默认值说明
srcstring(必填)视频的 URL。
pausedbooleanfalse暂停播放。
mutedbooleanfalse静音。
volumenumber10..1。
ratenumber1播放速度。
repeatbooleanfalse播放到结尾后从头重新播放。
controlsbooleanfalse显示平台自带的播放控件。
resizeMode"cover" | "contain" | "stretch" | "center"视频如何适应其区域。
progressUpdateIntervalnumber250onProgress 事件之间的毫秒数。
audioSession"default" | "playback" | "mixWithOthers""default"声音与设备上其他音频的关系:见声音与其他应用。

#声音与其他应用

视频的声音遵循应用的音频设置,默认是平台对视频的处理:在 iOS 上,设备处于静音模式时不发声。播放人声的应用(如有声书、语言课程)设置 audioSession:

audioSession静音模式下播放期间其他应用的声音
"default"由应用的音频设置决定由应用的音频设置决定
"playback"照常发声暂停,视频暂停、播完或移除后恢复
"mixWithOthers"照常发声继续播放

设置在视频播放期间生效。在 iOS 上,第一个这样的视频开始播放时,会把 AVAudioSession 设为 playback 类别、spokenAudio 模式("mixWithOthers" 时与其他应用混音);没有这样的视频在播放后,会话恢复原来的设置,被暂停的应用可以继续播放;"default" 保持应用(或嵌入 NSH 的应用)自己设置的会话。在 Android 上,播放器的声音标记为语音,"playback" 的视频在播放期间持有音频焦点:其他应用拿走焦点时(来电、导航提示)它暂停,焦点回来后继续播放。在 Android 上修改 audioSession 会重新打开视频源。桌面平台和 Web 像播放其他视频一样播放声音。

<Video src="asset:/greeting.m4a" audioSession="playback" />

#事件

事件数据时机
onLoadStart视频开始加载。
onLoad{ duration: number; size: Size }可以播放:时长(秒)和尺寸。
onProgress{ currentTime: number; duration: number }播放期间,每 progressUpdateInterval 毫秒一次。单位为秒。
onBuffer{ isBuffering: boolean }播放在等待数据,或恢复播放。
onEnd播放到达结尾。
onError{ message: string }视频无法加载或播放。

#ref 方法

方法说明
seek(seconds)跳转到 seconds。
const aspect = signal(16 / 9);

<Video src={url} onLoad={(e) => aspect.set(e.size.width / e.size.height)} style={{ width: "100%", aspectRatio: aspect() }} />;

#权限

如果应用在 nsh.json 中声明了 capabilities,远程视频源需要像 fetch 一样在 network 中允许;被拒绝的视频源不显示任何内容。见沙箱与权限。