From 40b3702a18aae22b90d1f7bf5859cdd427719c43 Mon Sep 17 00:00:00 2001 From: "kangyouwei111@gmail.com" Date: Fri, 31 May 2024 16:09:58 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#I9TNRW]=20=E6=96=B0?= =?UTF-8?q?=E5=A2=9Ereact-native-audio=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- zh-cn/react-native-audio.md | 294 ++++++++++++++++++++++++++++++++++++ 1 file changed, 294 insertions(+) create mode 100644 zh-cn/react-native-audio.md diff --git a/zh-cn/react-native-audio.md b/zh-cn/react-native-audio.md new file mode 100644 index 00000000..f008238d --- /dev/null +++ b/zh-cn/react-native-audio.md @@ -0,0 +1,294 @@ +> 模板版本：v0.2.1 + +

+

react-native-audio

+

+

+ + Supported platforms + + + License + + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-audio/) + + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-audio Releases](https://github.com/react-native-oh-library/react-native-audio/releases)，并下载适用版本的 tgz 包。 + +进入到工程目录并输入以下命令： + +> [!TIP] # 处替换为 tgz 包的路径 + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-audio@file:# +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-audio@file:# +``` + + + +下面的代码展示了这个库的基本使用场景： + +>[!WARNING] 使用时 import 的库名不变。 + +```js +import { AudioRecorder, AudioUtils } from "react-native-audio"; + +// request microphone premission +AudioRecorder.requestAuthorization().then((isAuthorised)=>{ + console.log(`isAuthorised: ${isAuthorised}`) +}) + +// you check premission any time +AudioRecorder.checkAuthorizationStatus().then((hasPermission)=>{ + console.log(`hasPermission: ${hasPermission}`) +}) + +// Initialize recording parameters +const path = `${AudioUtils.FilesDirectoryPath}/demo.m4a` +AudioRecorder.prepareRecordingAtPath(path,{ + SampleRate: 48000, + Channels: 2, + AudioQuality:'High',//only ios + AudioEncoding: 'aac', + AudioEncodingBitRate: 100000, + AudioSource: 1, + OutputFormat: 'm4a', + MeteringEnabled:false,//only ios + MeasurementMode:false,//only ios + IncludeBase64:false +}) + +// start recording +AudioRecorder.start(); + +// pause recording +AudioRecorder.pause(); + +// resume recording +AudioRecorder.resume(); + +// stop recording +AudioRecorder.stop(); + +// add function onProgress +AudioRecorder.onProgress = (data) => { + console.log(data.currentTime) +} + +// add function onFinished +AudioRecorder.onFinished = (data) => { + console.log(data.base64);//base64 + console.log(data.duration);//audio duration + console.log(data.status);//OK/REEOR + console.log(data.audioFileSize);//audioFileSize + console.log(data.audioFileURL);//audio file url +} +``` + +## Link + +目前鸿蒙暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的鸿蒙工程 `harmony` + +### 在工程根目录的 oh-package.json 添加 overrides字段 + +```json +{ + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 引入原生端代码 + +目前有两种方法： + +1. 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）； +2. 直接链接源码。 + +方法一：通过 har 包引入 + +> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`，添加以下依赖 + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-audio": "file:../../node_modules/@react-native-oh-tpl/react-native-audio/harmony/audio.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 源码位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`，添加以下依赖 + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-audio": "file:../../node_modules/@react-native-oh-tpl/react-native-audio/harmony/audio" + } +``` + +打开终端，执行： + +```bash +cd entry +ohpm install --no-link +``` + +### 配置 CMakeLists 和引入 AudioPackge + +打开 `entry/src/main/cpp/CMakeLists.txt`，添加： + +```diff +project(rnapp) +cmake_minimum_required(VERSION 3.4.1) +set(CMAKE_SKIP_BUILD_RPATH TRUE) +set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}") +set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules") ++ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules") +set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp") +set(LOG_VERBOSITY_LEVEL 1) +set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments") +set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie") +set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use +add_compile_definitions(WITH_HITRACE_SYSTRACE) + +add_subdirectory("${RNOH_CPP_DIR}" ./rn) + +# RNOH_BEGIN: manual_package_linking_1 +add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package) ++ add_subdirectory("${OH_MODULES}/@react-native-oh-tpl/react-native-audio/src/main/cpp" ./audio) +# RNOH_END: manual_package_linking_1 + +file(GLOB GENERATED_CPP_FILES "./generated/*.cpp") + +add_library(rnoh_app SHARED + ${GENERATED_CPP_FILES} + "./PackageProvider.cpp" + "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp" +) +target_link_libraries(rnoh_app PUBLIC rnoh) + +# RNOH_BEGIN: manual_package_linking_2 +target_link_libraries(rnoh_app PUBLIC rnoh_sample_package) ++ target_link_libraries(rnoh_app PUBLIC rnoh_audio) +# RNOH_END: manual_package_linking_2 +``` + +打开 `entry/src/main/cpp/PackageProvider.cpp`，添加： + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "AudioPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +``` + +### 在 ArkTs 侧引入 AudioPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加： + +```diff +... ++ import {AudioPackage} from '@react-native-oh-tpl/react-native-audio/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new AudioPackage(ctx) + ]; +} +``` + +### 运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +本文档内容基于以下版本验证通过： + +react-native-harmony：0.72.20; SDK：HarmonyOS NEXT Developer Beta1; IDE：DevEco Studio 5.0.3.200; ROM：3.0.0.18; + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[react-native-audio Releases](https://github.com/react-native-oh-library/react-native-audio/releases) + +### 权限要求 + +Encodings supported on iOS: lpcm, ima4, aac, MAC3, MAC6, ulaw, alaw, mp1, mp2, alac, amr Encodings supported on Android: aac, aac_eld, amr_nb, amr_wb, he_aac, vorbis +Encodings supported on Harmony: aac. + +AudioQuality、MeteringEnabled、MeasurementMode is only for ios; IncludeBase64 is for ios and Android, not support on Harmony. + +## API + +> [!tip] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| requestAuthorization | Request microphone permission | function | yes | phone | yes | +| checkAuthorizationStatus | Check authorization status | function | yes | phone | yes | +| prepareRecordingAtPath | Initialize recording instance parameters | function | yes | phone | yes | +| startRecording | start recording | function | yes | phone | yes | +| pauseRecording | Pause recording | function | yes | phone | yes | +| resumeRecording | Resume recording | function | yes | phone | yes | +| stopRecording | stop recording | function | yes | phone | yes | + +## 遗留问题 + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/jsierles/react-native-audio/blob/master/LICENSE) ，请自由地享受和参与开源。 \ No newline at end of file -- Gitee