Skip to content

Commit 602de56

Browse files
zackshiMinTate
zackshi
authored andcommitted
feat: 修改 Electron 工程的 readme.md 文件
1 parent 853dfb5 commit 602de56

File tree

2 files changed

+88
-33
lines changed

2 files changed

+88
-33
lines changed

Electron/README-zh_CN.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## 实时音视频(TRTC)Electron 版 SDK
2+
3+
_[English](README.md) | 简体中文_
4+
5+
实时音视频(TRTC)Electron 版 SDK 包含实时音视频和直播能力。腾讯实时音视频(Tencent Real-Time Communication,TRTC)将腾讯20多年来在网络与音视频技术上的深度积累,以多人音视频通话和低延时互动直播两大场景化方案,通过腾讯云服务向开发者开放,致力于帮助开发者快速搭建低成本、低延时、高品质的音视频互动解决方案。
6+
实时音视频(TRTC)产品请参见:[实时音视频(TRTC)](https://cloud.tencent.com/product/trtc)
7+
8+
## 目录结构
9+
本目录包含 Electron 版 TRTC SDK 的 Demo App 源代码,主要包括以下2个 Demo App: TRTC-API-Examples 和 TRTCSimpleDemo。
10+
11+
-  TRTC-API-Examples: 演示 [TRTC Electron API](https://web.sdk.qcloud.com/trtc/electron/doc/zh-cn/trtc_electron_sdk/index.html) 的常见使用场景,方便客户了解 API 接口功能并快速接入到现有工程中,支持应用内编码、执行。
12+
- TRTCSimpleDemo:最简单的示例代码,主要演示 TRTC 的接口如何调用,以及最基本的音视频功能。
13+
14+
```
15+
├─ TRTC-API-Examples
16+
├── src
17+
│ ├── app
18+
│ │ ├── main // 主进程运行代码
19+
│ │ ├── render // 渲染进程主窗口运行代码
20+
├── assets
21+
│ ├── app-icon
22+
│ ├── code // 示例代码
23+
│ │ ├── basic // 基础功能示例代码
24+
│ │ ├── advanced // 高级功能示例代码
25+
│ ├── debug // 包含 GenerateTestUserSig,用于本地生成测试用的 UserSig
26+
├── main.js // electron 主进程入口文件
27+
├── preload.js // electron 窗口预加载脚本
28+
├── package.json // 工程配置
29+
├── package-lock.json
30+
|
31+
├─ TRTCSimpleDemo // TRTC精简版Demo,包含通话模式和直播模式示例代码
32+
│ ├── main.electron.js // Electron 主文件
33+
│ ├── package.json // 工程配置
34+
│ ├── vue.config.js // vue-cli 工程文件
35+
│ ├── src // 源代码目录
36+
│ │ ├── pages
37+
│ │ │ ├── trtc // 演示 TRTC 以通话模式运行的示例代码,该模式下无角色的概念
38+
│ │ │ ├── live // 演示 TRTC 以直播模式运行的示例代码,该模式下有角色的概念
39+
│ │ ├── debug // 包含 GenerateTestUserSig,用于本地生成测试用的 UserSig
40+
```
41+
42+
## Demo 下载
43+
44+
Electron 版 TRTC Demo 基于 TRTCSDK 设计和实现,Demo 包含实时音视频通话、低延迟直播、屏幕分享、美颜在内的多项功能,请前往[SDK 下载页面](https://cloud.tencent.com/document/product/647/32689#TRTC),下载 Electron 版 TRTC Demo 文件。
45+
46+
## 相关文档链接
47+
48+
- [SDK 的 API 文档](https://web.sdk.qcloud.com/trtc/electron/doc/zh-cn/trtc_electron_sdk/index.html)
49+
- [SDK 的官方体验 App](https://cloud.tencent.com/document/product/647/17021)
50+

Electron/README.md

+38-33
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
1-
## 实时音视频(TRTC)版SDK
2-
实时音视频(TRTC)版SDK包含实时音视频(TRTC)和直播播放的能力。腾讯实时音视频(Tencent Real-Time Communication,TRTC)将腾讯21年来在网络与音视频技术上的深度积累,以多人音视频通话和低延时互动直播两大场景化方案,通过腾讯云服务向开发者开放,致力于帮助开发者快速搭建低成本、低延时、高品质的音视频互动解决方案。
3-
实时音视频(TRTC)产品请参见:[实时音视频(TRTC)](https://cloud.tencent.com/product/trtc)
1+
## TRTC Electron SDK
2+
_English | [简体中文](README-zh_CN.md)_
43

5-
## 目录结构
6-
本目录包含 Electron 版 TRTC 的所有 Demo 源代码,被分成 TRTCSimpleDemo 和 TRTCScenesDemo 两个子目录:
4+
The TRTC Electron SDK provides real-time communication and live streaming capabilities. Leveraging Tencent's over 20 years of experience in network and audio/video technologies, Tencent Real-Time Communication (TRTC) offers solutions for group audio/video calls and low-latency interactive live streaming. With TRTC, you can quickly develop cost-effective, low-latency, and high-quality interactive audio/video services.
5+
For more information about TRTC, see [TRTC](https://intl.cloud.tencent.com/products/trtc).
76

8-
- TRTCSimpleDemo:最简单的示例代码,主要演示 TRTC 的接口如何调用,以及最基本的音视频功能。
9-
- TRTCScenesDemo:较复杂的场景案例,结合了 TRTC 和 IM 两个 SDK ,所实现的交互也更接近真实产品。
10-
- TRTCEducation Demo:实时互动课堂Demo,集成了语音、视频、屏幕分享等上课方式,还封装了老师开始问答、学生举手、老师邀请学生上台回答、结束回答等相关能力。
7+
## Directory Structure
8+
This directory contains the source code of two demo applications of the TRTC Electron SDK: `TRTC-API-Examples` and `TRTCSimpleDemo`.
9+
10+
- TRTC-API-Examples: Demonstrates the common use cases of [TRTC APIs for Electron](https://web.sdk.qcloud.com/trtc/electron/doc/en-us/trtc_electron_sdk/index.html) to help you understand API features and quickly connect them to your existing project. It supports in-app encoding and execution.
11+
- TRTCSimpleDemo: The simplest sample code to demonstrate how to call TRTC APIs and use the most basic audio/video features.
1112

1213
```
13-
├─ TRTCScenceDemo // TRTC场景化Demo,包含实时互动课堂示例代码
14-
| ├─ TRTCEducation // 实时互动课堂示例代码
15-
| | |--app // 源代码文件
16-
| | | |--index.tsx // 页面入口文件
17-
| | | |--Routes.tsx // 路由配置文件
18-
| | | |--containers // 进入教室、教室UI代码
19-
| | | |--components // 教师端UI、学生端UI、聊天室、用户列表组件代码
20-
| | | |--debug // sdkAppId和密钥配置文件
21-
| | |--package.json // 工程配置
22-
| | |--configs // webpack配置文件
14+
├─ TRTC-API-Examples
15+
├── src
16+
│ ├── app
17+
│ │ ├── main // Main process running code
18+
│ │ ├── render // Main window running code of the renderer process
19+
├── assets
20+
│ ├── app-icon
21+
│ ├── code // Sample code
22+
│ │ ├── basic // Sample code for basic features
23+
│ │ ├── advanced // Sample code for advanced features
24+
│ ├── debug // Contains `GenerateTestUserSig` to generate a testing `UserSig` locally
25+
├── main.js // Electron main process entry file
26+
├── preload.js // Electron window preload script
27+
├── package.json // Project configuration
28+
├── package-lock.json
2329
|
24-
├─ TRTCSimpleDemo // TRTC精简版Demo,包含通话模式和直播模式示例代码
25-
| |--main.electron.js // Electron 主文件
26-
| |--package.json // 工程配置
27-
| |--vue.config.js // vue-cli 工程文件
28-
| |--src // 源代码目录
29-
| | |--pages
30-
| | | |--trtc // 演示 TRTC 以通话模式运行的示例代码,该模式下无角色的概念
31-
| | | |--live // 演示 TRTC 以直播模式运行的示例代码,该模式下有角色的概念
32-
| | |--debug // 包含 GenerateTestUserSig,用于本地生成测试用的 UserSig
30+
├─ TRTCSimpleDemo // TRTC Lite Edition demo containing the sample code of call and live streaming modes.
31+
│ ├── main.electron.js // Main Electron file
32+
│ ├── package.json // Project configuration
33+
│ ├── vue.config.js // Vue CLI project file
34+
│ ├── src // Source code directory
35+
│ │ ├── pages
36+
│ │ │ ├── trtc // The Demo for call mode in TRTC. In this mode, there is no concept of role
37+
│ │ │ ├── live // The Demo for live streaming mode in TRTC. In this mode, there is a concept of role
38+
│ │ ├── debug // Contains `GenerateTestUserSig` to generate a testing `UserSig` locally
3339
```
3440

35-
## Demo 下载
41+
## Demo Download
3642

37-
Electron TRTC Demo 基于 TRTCSDK 设计和实现,Demo 包含实时音视频通话、低延迟直播、屏幕分享、美颜在内的多项功能,请前往[SDK 下载页面](https://cloud.tencent.com/document/product/647/32689#TRTC),下载 Electron 版 TRTC Demo 文件。
43+
TRTC demo for Electron is designed and implemented based on the TRTC SDK and contains various features, including real-time communication, low-latency live streaming, screen sharing, and beauty filters. You can download the demo files in [Free Demo](https://intl.cloud.tencent.com/document/product/647/35076).
3844

39-
## 相关文档链接
45+
## Documentation
4046

41-
- [SDK 的版本更新历史](https://github.com/tencentyun/TRTCSDK/releases)
42-
- [SDK 的 API 文档](https://web.sdk.qcloud.com/trtc/electron/doc/zh-cn/trtc_electron_sdk/index.html)
43-
- [SDK 的官方体验 App](https://cloud.tencent.com/document/product/647/17021)
47+
- [TRTC SDK API documentation](https://web.sdk.qcloud.com/trtc/electron/doc/en-us/trtc_electron_sdk/index.html)
48+
- [TRTC SDK demo app](https://intl.cloud.tencent.com/document/product/647/35076)
4449

0 commit comments

Comments
 (0)