Skip to content

Latest commit

 

History

History
220 lines (153 loc) · 6.41 KB

react-native-video-cache.md

File metadata and controls

220 lines (153 loc) · 6.41 KB

模板版本：v0.2.0

react-native-video-cache

Supported platforms License

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-library/react-native-video-cache Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

进入到工程目录并输入以下命令：

npm

npm install @react-native-oh-tpl/react-native-video-cache

yarn

yarn add @react-native-oh-tpl/react-native-video-cache

下面的代码展示了这个库的基本使用场景：

[!WARNING] 使用时 import 的库名不变。

import React, { useEffect, useState } from "react";
import { StyleSheet, Text, View } from "react-native";
import  { convertAsync } from "react-native-video-cache";

export default function App() {
    const url =
        "https://cdn.plyr.io/static/demo/View_From_A_Blue_Moon_Trailer-720p.mp4";
    const [asyncVersion, setAsyncVersion] = useState<string>('');
    useEffect(() => {
        convertAsync(url).then(setAsyncVersion);
    }, [])
    return (
        <View style={styles.container}>
            <Text style={styles.welcome}>☆Original URL☆</Text>
            <Text style={styles.instructions}>{url}</Text>
            <Text style={styles.welcome}>☆Async Proxy URL☆</Text>
            <Text style={styles.instructions}>{asyncVersion}</Text>
        </View>
    );
}

const styles = StyleSheet.create({
    container: {
        flex: 1,
        justifyContent: "center",
        alignItems: "center",
        backgroundColor: "#F5FCFF",
        padding: 20
    },
    welcome: {
        fontSize: 20,
        textAlign: "center",
        margin: 10,
    },
    instructions: {
        textAlign: "center",
        color: "#333333",
        marginBottom: 5,
    },
});

Link

目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

1.在工程根目录的 oh-package.json5 添加 overrides字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

2.引入原生端代码

目前有两种方法：

  1. 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）；
  2. 直接链接源码。

方法一：通过 har 包引入

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

打开 entry/oh-package.json5，添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-oh-tpl/rnoh-video-cache": "file:../../node_modules/@react-native-oh-tpl/react-native-video-cache/harmony/react_native_video_cache.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 源码位于三方库安装路径的 harmony 文件夹下。

打开 entry/oh-package.json5，添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-oh-tpl/rnoh-video-cache": "file:../../node_modules/@react-native-oh-tpl/react-native-video-cache/harmony/react_native_video_cache"
  }

打开终端，执行：

cd entry
ohpm install --no-link

3.在 ArkTs 侧引入 RNVideoCachePackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

  ...
+   import { RNVideoCachePackage } from '@react-native-oh-tpl/rnoh-video-cache/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new RNVideoCachePackage(ctx)
  ];
}

4.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@react-native-oh-library/react-native-video-cache Releases。

本文档内容基于以下版本验证通过：

  1. RNOH: 0.72.20-CAPI; SDK: HarmonyOS NEXT Developer Beta1(full sdk); IDE: DevEco Studio 5.0.3.200; ROM: 3.0.0.18;

API

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

详情请见react-native-video-cache

Name Description Type Required Platform HarmonyOS Support
convertToCache Return the local proxy cache server URL using sync. string no Androis/IOS no
convertAsync Return the local proxy cache server URL using async. string no Androis/IOS yes

其他

遗留问题

  • 由于 HarmonyOS 侧原生依赖 HarmonyOS 三方库@ohos/video-cache中HttpProxyCacheServer实例化对象方法getProxyUrl暂为异步方法，导致本库同步方法convertToCache暂无法实现，问题：issue#1

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。