React Native Video 组件中 play() 方法的使用注意事项

在使用 React Native Video 组件时，开发者可能会遇到一个常见的类型错误：当尝试调用 videoRef.current.play() 方法时，TypeScript 会报错提示 Property 'play' does not exist on type 'VideoRef'。这个问题源于文档与实现之间的不一致性。

问题根源

在 React Native Video 6.0.0-beta.4 版本中，视频播放器的引用类型 VideoRef 实际上并不包含 play() 方法。这是一个文档与实际 API 实现不符的典型案例。正确的播放方法应该是 resume() 而非 play()。

正确使用方法

开发者应该使用以下方式控制视频播放：

const videoRef = useRef<VideoRef>(null);

const controlVideo = async () => {
  if(!videoRef.current) {
    return;
  }
  
  // 正确的播放视频方法
  videoRef.current.resume();
};

版本兼容性说明

这个问题主要出现在 React Native Video 的 6.x 版本中。开发者需要注意：

1. 在 6.x 版本中，使用 resume() 方法来播放视频
2. 文档中的 play() 方法是一个错误，将在后续版本中修正
3. 如果从旧版本升级，需要注意 API 的变化

最佳实践建议

为了避免类似问题，开发者可以：

1. 定期检查官方文档的更新
2. 在升级版本时仔细阅读变更日志
3. 使用 TypeScript 的类型检查来发现潜在的 API 变更
4. 在团队内部维护一份 API 使用文档，记录实际验证过的可用方法

这个问题提醒我们，在使用开源库时，文档与实际实现可能存在差异，特别是在预发布版本中。开发者应该保持警惕，并通过实际测试来验证 API 的可用性。