{"id":37908586,"url":"https://github.com/polyv/polyv-rn-vod-sdk-demo","last_synced_at":"2026-01-16T17:17:01.907Z","repository":{"id":41797944,"uuid":"173731463","full_name":"polyv/polyv-rn-vod-sdk-demo","owner":"polyv","description":"React Native 点播demo工程","archived":false,"fork":false,"pushed_at":"2024-11-01T06:21:31.000Z","size":14208,"stargazers_count":9,"open_issues_count":20,"forks_count":6,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-01T07:20:21.131Z","etag":null,"topics":["android","ios","react-native"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/polyv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-04T11:23:01.000Z","updated_at":"2024-11-01T06:21:36.000Z","dependencies_parsed_at":"2024-11-01T07:29:58.956Z","dependency_job_id":null,"html_url":"https://github.com/polyv/polyv-rn-vod-sdk-demo","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/polyv/polyv-rn-vod-sdk-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyv%2Fpolyv-rn-vod-sdk-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyv%2Fpolyv-rn-vod-sdk-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyv%2Fpolyv-rn-vod-sdk-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyv%2Fpolyv-rn-vod-sdk-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polyv","download_url":"https://codeload.github.com/polyv/polyv-rn-vod-sdk-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyv%2Fpolyv-rn-vod-sdk-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28480094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","ios","react-native"],"created_at":"2026-01-16T17:17:01.849Z","updated_at":"2026-01-16T17:17:01.901Z","avatar_url":"https://github.com/polyv.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## RN 点播集成文档\n\n## 1. 概述\n\nPolyvRNVodDemo 支持 Android + iOS， 是专为 ReactNative 技术开发者定制的点播集成 Demo，具备功能丰富且易用的接口，提供了视频点播播放、视频下载等一系列功能。\n\n### 1.1 支持设备\n\nAndroid 4.1.0 (API 16) 以上 或 iOS 11.0 以上\n\n### 1.2 接入条件\n\n- 了解 ReactNative 技术；\n- 搭建好运行 React Native 的相关环境；\n- 准备在使用 React Native 技术开发的项目中接入点播功能；\n- 拥有 polyv 官网的直播账号且已开通直播权限。\n\n### 1.3 版本功能\n\nRN 版本是基于原生 demo + sdk 开发的，iOS 与 android 对应版本，及 SDK 版本更新日志链接如下：\n\n- iOS SDK 对应版本为 v2.21.1，[版本更新日志](https://github.com/polyv/polyv-ios-vod-sdk/releases)\n- Android SDK 对应版本为 v2.21.2，[版本更新日志](https://github.com/easefun/polyv-android-sdk-2.0-demo/releases)\n\n## 2. 快速开始\n\n### 2.1 RN端集成\n\n#### 2.1.1 安装依赖\n\n执行如下命令下载 react 相关依赖\n```js\nnpm install\n```\n\n#### 2.1.2 引入插件\n\n点播的插件和 demo 使用到的插件的目录结构如下所示：\n\n```\n├── polyv\n│   ├── demo\n│   │   ├── PolyvNavigation.js\n│   │   ├── PolyvUserConfig.js\n│   │   ├── common\n│   │   ├── downloadList\n│   │   ├── img\n│   │   ├── onlineList\n│   │   └── player\n│   └── sdk\n│       ├── PolyvVodConfigModule.js\n│       ├── PolyvVodDownloadModule.js\n│       ├── PolyvVodDownloadResultCode.js\n│       └── PolyvVodPlayerModule.js\n```\n\n在目录 sdk 下我们的 RN 点播 SDK 提供了一下三大功能模块：\n\n| 文件名    | 描述   |\n| -------- | ------ |\n| PolyvVodConfigRnModule |  初始化模块    |\n| PolyvVodPlayerModule |  播放器模块    |\n| PolyvVodDownloadModule  |  视频下载模块   |\n\n如果只是需要使用到 sdk 的功能，把 sdk 目录下的文件拉到 RN 项目中即可。demo 中的功能则需要使用到 demo 目录下的文件。\n\n#### 2.1.3 项目配置\n\n1. 项目中app.json中的字段需要与native 层的入口名对应，所以在Android与ios两端需要做入口名统一配置。配置文件名：\n\n   - Android端的MainActivity.java 文件\n\n     ```java\n      @Override\n         protected String getMainComponentName() {\n             return \"此处填入app.json里的name字段内容\";\n         }\n     ```\n\n   - IOS端的AppDelegate.m文件\n\n     ```objective-c\n     - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions\n     {\n       NSURL *jsCodeLocation;\n     \n       jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@\"index\" fallbackResource:nil];\n     \n       RCTRootView *rootView = [[RCTRootView alloc] initWithBundleURL:jsCodeLocation\n                                                           moduleName:@\"此处填入app.json里的name字段内容\"\n                                                    initialProperties:nil\n                                                        launchOptions:launchOptions];\n      .... 此处代码省略...\n       \n       return YES;\n     }\n     ```\n\n\n\n2. 在 package.json 文件中配置依赖。\n\n```json\n  \"dependencies\": {\n    \"@react-navigation/material-top-tabs\": \"^6.6.13\",\n    \"@react-navigation/native\": \"^6.1.17\",\n    \"@react-navigation/stack\": \"^6.3.29\",\n    \"axios\": \"^0.18.0\",\n    \"native-base\": \"^3.4.12\",\n    \"react\": \"18.2.0\",\n    \"react-native\": \"0.71.8\",\n    \"react-native-gesture-handler\": \"^2.16.0\",\n    \"react-native-pager-view\": \"^6.3.0\",\n    \"react-native-safe-area-context\": \"^4.9.0\",\n    \"react-native-screens\": \"^3.30.1\",\n    \"react-native-svg\": \"^14.1.0\",\n    \"react-native-tab-view\": \"^3.5.2\"\n  },\n  \"devDependencies\": {\n    \"@babel/core\": \"^7.20.0\",\n    \"@babel/preset-env\": \"^7.20.0\",\n    \"@babel/runtime\": \"^7.20.0\",\n    \"@react-native-community/eslint-config\": \"^3.2.0\",\n    \"@tsconfig/react-native\": \"^2.0.2\",\n    \"@types/jest\": \"^29.2.1\",\n    \"@types/react\": \"^18.0.24\",\n    \"@types/react-test-renderer\": \"^18.0.0\",\n    \"babel-jest\": \"^29.2.1\",\n    \"eslint\": \"^8.19.0\",\n    \"jest\": \"^29.2.1\",\n    \"metro-react-native-babel-preset\": \"0.73.9\",\n    \"prettier\": \"^2.4.1\",\n    \"react-test-renderer\": \"18.2.0\",\n    \"typescript\": \"4.8.4\"\n  },\n```\n\n#### 2.1.4 使用方法\n##### 2.1.4.1 初始化\n\n初始化的方法要放在界面渲染前初始化， 一般在 componentWillMount 调用该方法进行初始化.\n\n0.4.0起建议使用初始化方法`setToken`，该方法是一个异步有返回结果的函数。推荐使用 https 接口，从服务端获取加密串，APP 本地解密（开发者设计自己的加解密方式）得到 `useId`、`readtoken`、`writetoken`、`secretkey` ，再使用该方法配置用户信息。\n\n低于0.4.0的可以使用`init`方法初始化，他也是异步有返回结果的函数。\n\n```javascript\n /*\n   * @param {string} userid 保利威后台API接口userid\n   * @param {*} writetoken 保利威后台API接口writetoken\n   * @param {*} readtoken 保利威后台API接口readtoken\n   * @param {*} secretkey 保利威后台API接口secretkey\n   * @param {*} viewerId 用户ID\n   * @param {*} nickName 用户昵称\n   */\nPolyvVodConfig.setToken(\n        this.state.userid,\n        this.state.writetoken,\n        this.state.readtoken,\n        this.state.secretkey,\n        this.state.viewerId,\n        this.state.nickName\n    ).then(ret =\u003e{\n        if(ret.code != 0){\n            //初始化失败\n            var str = \"初始化失败  errCode=\" + ret.code + \"  errMsg=\" + ret.message;\n            console.log(str);\n            alert(str);\n        } else {\n            // 初始化成功\n            console.log(\"初始化成功\");\n        }\n    });\n\n /**\n   * @param {string} vodKey 加密串\n   * @param {*} decodeKey 加密密钥\n   * @param {*} decodeIv 加密向量\n   * @param {*} viewerId 用户ID\n   * @param {*} nickName 用户昵称\n   */\n   console.log(\"Polyv rn vod init\")\n   PolyvVodConfigRnModule.init(this.state.vodKey, this.state.decodeKey, this.state.decodeIv, this.state.viewerId, this.state.nickName)\n     .then(ret =\u003e {\n       if (ret.code != 0) { // 初始化失败\n         var str = \"初始化失败  errCode=\" + ret.code + \"  errMsg=\" + ret.message\n         console.log(str)\n         alert(str)\n       } else { // 初始化成功\n         console.log(\"初始化成功\")\n       }\n     })\n```\n\n\n\n##### 2.1.4.2 视频播放\n\n```javascript\n\n//使用方式\n\u003cPolyvVodPlayer\n          ref='playerA'\n          style={styles.video}\n          vid={\"e97dbe3e64cb3adef1a27a42fe49228e_e\"}//视频播放vid\n          isAutoStart={true}//是否自动播放\n\t\t\t\t\tfullScreen={false}\n          marquee={{\n            displayDuration:8,//单位：秒  单次跑马灯显示时长\n            maxRollInterval:1,//单位：秒  两次滚动的最大间隔时长，实际的间隔时长是取 0~maxRollInterval 的随机值\n            content:'我是跑马灯',//跑马灯内容\n            color:'#0000FF',//跑马灯颜色\n            alpha:0.5,//跑马灯透明度\n            font:20,//跑马灯字体\n          }}\n        /\u003e\n```\n\n\n\n##### 2.1.4.3 视频下载\n\n视频下载模块组件 PolyvVodDownloadModule.js 提供了如下接口：\n\n| 函数名            | 参数        | 功能说明         | 是否有返回值 |\n| :---------------- | ----------- | ---------------- | ------------ |\n| getBitrateNumbers | vid：视频id | 获取视频码率列表 | 是           |\n| startDownload     | vid：视频id\u003cbr\u003ebitrate：码率索引\u003cbr\u003etitle：下载标题 | 开始下载视频 | 是 |\n| pauseDownload | vid：视频id\u003cbr/\u003ebitrate：码率索引 | 暂停下载 | 否 |\n| pauseAllDownload | 无 | 暂停所有下载视频 | 否 |\n| resumeDownload | vid：视频id\u003cbr/\u003ebitrate：码率索引 | 恢复下载视频 | 否 |\n| startAllDownload | 无 | 开始下载所有视频，未下载视频全部放入等待队列 | 否 |\n| deleteDownload | vid：视频id\u003cbr/\u003ebitrate：码率索引 | 删除视频 | 否 |\n| deleteAllDownload | 无 | 删除所有未下载的视频 | 否 |\n| getDownloadVideoList | hasDownloaded：是否获取已下载视频 | 获取下载列表 | 是 |\n\n下载数据 downloadInfo 结构说明\n\n| 参数     | 类型   | 说明            |\n| -------- | ------ | --------------- |\n| vid      | string | 视频id          |\n| duration | string | 视频时长        |\n| filesize | number | 文件大小        |\n| bitrate  | number | 码率索引        |\n| title    | string | 文件标题        |\n| progress | number | 下载进度（0~1） |\n\n下载视频的进度更新需要添加监听器，一般装载组件的时候添加监听器，卸载的时候移除。下载视频的回调是通过 DeviceEventEmitter 的方式实现对 native 的监听\n\n对应的回掉 event 事件列表，该事件列表对应 native 层相应的通知事件\n\n| event                | 返回值结构                                                | 说明           |\n| -------------------- | --------------------------------------------------------- | -------------- |\n| startDownloadEvent   | {downloadInfo：{对应上述的downloadInfo结构}}              | 开始下载的回掉 |\n| updateProgressEvent  | {downloadInfo：{对应上述的downloadInfo结构},progress:0.2} | 下载更新回掉   |\n| downloadSuccessEvent | {bitrate:1,vid:'123'}                                     | 下载完成回掉   |\n| downloadFailedEvent  | {bitrate:1,vid:'123'}                                     | 下载失败回掉   |\n| downloadSpeedEvent   | {bitrate:1,vid:'123',downloadSpeed:123.5}                 | 下载速度回掉   |\n\nRN 端实现监听的代码演示：\n\n```javascript\n componentWillMount() {\n    this.registerReceiver();\n  }\n\n  componentWillUnmount() {\n    console.log(\"download list componentWillUnmount\");\n    DeviceEventEmitter.removeAllListeners();\n  }\n  \n  //注册下载进度回调监听\n  registerReceiver() {\n    console.log(\"registerReceiver:\" + this.props.isDownloadedPage);\n    if (this.props.isDownloadedPage) {\n      return;\n    }\n    //下载开始回调\n    DeviceEventEmitter.addListener(\"startDownloadEvent\", msg =\u003e {\n      console.log(\"startDownload\" + msg);\n      // this.setState({ downloadingInfo: msg.downloadInfo });\n    });\n\n    //下载失败回调\n    DeviceEventEmitter.addListener(\"downloadFailedEvent\", msg =\u003e {\n      console.log(\"downloadFailedEvent\" + JSON.stringify(msg));\n    });\n\n    //下载速度回调\n    DeviceEventEmitter.addListener(\"downloadSpeedEvent\", msg =\u003e {\n     \n    });\n    //进度更新回调\n    DeviceEventEmitter.addListener(\"updateProgressEvent\", msg =\u003e {\n\n    });\n\n    //下载完成回调\n    DeviceEventEmitter.addListener(\"downloadSuccessEvent\", msg =\u003e {\n      \n    });\n  }\n```\n\n###  2.2 Android 端集成\n\n#### 2.2.1 Android 端工程说明\n\nAndroid 端工程的原生插件代码分为两个部分：\n\n- 定制的 rn 模块，就是工程的主模块app，路径是PolyvVodRnDemo/android/app。\n- polyv sdk 模块，主要是 polyv 相关组件的代码文件，路径是PolyvVodRnDemo/android/polyvsdk。\n\n主模块app涉及的 java 文件有：\n- PolyvRNVodPluginManager：rn 插件开发的管理类，用来注册相关的 rn 定制组件。\n- PolyvRNVodConfigModule：初始化组件模块，用来初始化 android 端需要的一些全局用户信息，例如 iv，secreate，userid。\n- PolyvVodPlayer：播放器的 rn 组件，封装了播放器功能。\n- PolyvRNVodPlayer：播放器及其皮肤的自定义控件，用于 rn 组件进行整合及使用。\n- PolyvRNVodDownloadModule：视频下载组件。\n\n####  2.2.2 代码集成步骤\n\n1. 集成 polyvsdk 模块\n\n   1. 把Demo项目的 android/polyvsdk文件夹 拷贝到 目标工程的 android目录 下面；\n\n   2. 配置目标工程 android/settings.gradle文件 的依赖\n\n      ```java\n      rootProject.name = 'XXXXXXX'//对应目标rn工程app.json下的name\n      include ':app'\n      \n      include ':polyvsdk'  //polyvsdk模块的依赖配置  新增加的一行！\n      ```\n\n   3. 配置目标工程 android/app/build.gradle文件 的依赖\n\n      ```java\n      dependencies {\n          implementation fileTree(dir: \"libs\", include: [\"*.jar\"])\n          implementation (\"com.facebook.react:react-native:+\"){\n              exclude group:'com.android.support',module:'appcompat-v7'\n          }\n          implementation 'com.android.support:multidex:1.0.1'//64K 引用限制\n            \n          implementation project(path: ':polyvsdk')  //polyvsdk模块的依赖配置   新增加的一行！\n      }\n      ```\n\n2. 集成app代码\n\n   1. 在目标工程中的 android/app/src/main/java 目录下，增加 com 目录，形成 android/app/src/main/java/com 的目录结构（如果已有com目录，可跳过本步骤）；\n\n   2. 把 android/app/src/main/java/com/polyv文件夹 拷贝到 上面创建的 com目录 下；\n\n   3. 配置目标项目的 Application文件；\n\n      ```java\n              @Override\n              protected List\u003cReactPackage\u003e getPackages() {\n                  return Arrays.\u003cReactPackage\u003easList(\n                          new MainReactPackage()\n                          , new PolyvRNVodPluginManager()  // 新增加的一行！\n                  );\n              }\n      ```\n\n      4.MainActivity配置\n\n      ```java\n      @Override\n              protected List\u003cReactPackage\u003e getPackages() {\n                  return Arrays.\u003cReactPackage\u003easList(\n                          new MainReactPackage()\n                          , new PolyvRNVodPluginManager()//新增加的一行！\n                    \t\t\n                  );\n              }\n      ```\n\n3. 集成react-native-gesture-handler插件（如果RN端没有集成react-native-gesture-handler，可跳过本步骤）\n\n   1. 配置目标工程 android/settings.gradle文件 的依赖\n\n      ```java\n      rootProject.name = 'PolyvVodRnDemo'\n      include ':app'\n        \n      include ':polyvsdk'  //polyvsdk模块的依赖配置\n      \n      //react-native-gesture-handler模块的依赖配置  以下是新增加的部分\n      include ':react-native-gesture-handler'\n      project(':react-native-gesture-handler').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-gesture-handler/android')\n      ```\n\n   2. 配置目标工程 android/app/build.gradle文件 的依赖\n\n      ```java\n      dependencies {\n          implementation fileTree(dir: \"libs\", include: [\"*.jar\"])\n          implementation (\"com.facebook.react:react-native:+\"){\n              exclude group:'com.android.support',module:'appcompat-v7'\n          }\n          implementation 'com.android.support:multidex:1.0.1'//64K 引用限制\n          \n          implementation project(path: ':polyvsdk')\n            \n          implementation project(':react-native-gesture-handler')    //新增加的一行！\n      }\n      ```\n\n   3. 配置MainActivity\n\n      ```java\n              @Override\n              protected List\u003cReactPackage\u003e getPackages() {\n                  return Arrays.\u003cReactPackage\u003easList(\n                          new MainReactPackage()\n                          , new PolyvRNVodPluginManager()\n                    \t\t\t, new RNGestureHandlerPackage()  //新增加的一行！\n                  );\n              }\n      ```\n\n###   2.3 iOS 端集成\n\n#### 2.3.1 iOS端工程说明\n\niOS 端工程的原生插件代码全部包含在  ios/PolyvVodRnModule文件夹 中；\n\n#### 2.3.2 代码集成\n\n1. 引入原生代码\n\n   1）把Demo项目的 ios/PolyvVodRnModule文件夹 拷贝到 目标项目的 ios 目录下（如果以前已经拷贝过上述文件夹，需要在XCode先删除，然后再拷贝）；\n\n   2）在XCode中，把上述文件夹增加（Add Files）到项目中；\n\n2. 配置CocoaPods\n\n   1）如果目标项目原来没有  ios/Podfile 文件，需要拷贝 demo 项目的 ios/Podfile 文件到 目标项目的 ios 目录下；打开 Podfile 文件，把其中 ‘PolyvVodRnDemo’ 改为 ‘自身项目名’；\n\n   2）如果目标项目原来有Podfile 文件，只需要把 Polyv vod rn sdk 所需要的配置拷贝到  ios/Podfile文件 中；\n\n   3）在命令行环境进入ios 目录，添加点播SDK，执行 pod install 命令；\n\n   ```java\n     # Polyv vod rn sdk\n     pod 'XRCarouselView', '~\u003e 2.6.1'\n     pod 'YYWebImage', '~\u003e 1.0.5'\n     pod 'FDStackView', '~\u003e 1.0.1'\n     pod 'PLVMasonry', '~\u003e 1.1.2'\n   \n     # Polyv vod rn sdk 2.13.1\n   #  pod 'PolyvVodSDK', '2.13.1'\n   \n     # Polyv vod rn sdk 2.21.1\n     pod 'PLVAliHttpDNS', '~\u003e 1.10.0'\n     pod 'SSZipArchive', '~\u003e 2.1.5'\n     pod 'PolyvVodSDK', '2.21.1', :subspecs =\u003e ['Core','Player']\n   \n     pod 'PLVVodDanmu', '~\u003e 0.0.1'\n     pod 'PLVSubtitle', '~\u003e 0.1.0'\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyv%2Fpolyv-rn-vod-sdk-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolyv%2Fpolyv-rn-vod-sdk-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyv%2Fpolyv-rn-vod-sdk-demo/lists"}