Skip to content

Commit d37e7b1

Browse files
updated intro
1 parent 8b31fab commit d37e7b1

File tree

1 file changed

+16
-31
lines changed

1 file changed

+16
-31
lines changed

DOCS/Get_Started.md

Lines changed: 16 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,38 @@
11
# Get Started with the Agora Middleware Service
22

3-
The Agora Middleware Service is a Go-based backend solution designed to simplify adoption of Agora's RESTful APIs. It serves two primary purposes:
3+
The Agora Middleware Service is a Go-based backend solution that simplifies integrating Agora's cloud services into your applications. It provides a set of RESTful APIs for token generation, cloud recording management, and real-time transcription. 
4+
The Agora Middleware Service serves two primary purposes:
45

56
1. For front-end developers: It provides a ready-to-use backend that handles Agora API interactions, allowing you to focus on building your application's user interface and features.
67

78
2. For backend developers: It offers a quick deployment option to support front-end teams working with Agora SDKs, reducing the time and effort needed to set up a custom backend.
89

9-
Key features include:
10+
Key features of the middleware service include:
1011

1112
- Token generation for RTC, RTM, and Chat services
12-
- Cloud recording management
13+
- Cloud recording management (start, stop, update layout, etc.)
1314
- Real-time transcription control
1415
- RTMP push and pull services
16+
- Configurable storage options for recordings and transcriptions
17+
- Easy-to-use RESTful API endpoints
1518

16-
This guide will walk you through setting up and using the Agora Middleware Service, helping you leverage its capabilities to enhance your development workflow.
19+
Let's dive into setting up and using this powerful tool!
1720

1821
## Table of Contents
1922

20-
1. [Introduction](#introduction)
21-
2. [Prerequisites](#prerequisites)
22-
3. [Installation](#installation)
23-
4. [Configuration](#configuration)
24-
5. [Running the Service](#running-the-service)
25-
6. [API Overview](#api-overview)
23+
1. [Prerequisites](#prerequisites)
24+
1. [Installation](#installation)
25+
1. [Configuration](#configuration)
26+
1. [Running the Service](#running-the-service)
27+
1. [API Overview](#api-overview)
2628
- [Token Generation](#token-generation)
2729
- [Cloud Recording](#cloud-recording)
2830
- [Real-Time Transcription](#real-time-transcription)
2931
- [RTMP Service](#rtmp-service)
30-
7. [Testing the APIs](#testing-the-apis)
31-
8. [Best Practices](#best-practices)
32-
9. [Troubleshooting](#troubleshooting)
33-
10. [Support](#support)
34-
35-
## Introduction
36-
37-
The Agora Middleware Service is a Go-based backend solution that simplifies the process of integrating Agora's cloud services into your applications. It provides a set of RESTful APIs for token generation, cloud recording management, and real-time transcription. By using this middleware, you can offload complex server-side operations and focus on building great user experiences in your applications.
38-
39-
Key features of the middleware service include:
40-
41-
- Token generation for RTC, RTM, and Chat services
42-
- Cloud recording management (start, stop, update layout, etc.)
43-
- Real-time transcription control
44-
- RTMP push and pull services
45-
- Configurable storage options for recordings and transcriptions
46-
- Easy-to-use RESTful API endpoints
47-
48-
Let's dive into setting up and using this powerful tool!
32+
1. [Testing the APIs](#testing-the-apis)
33+
1. [Best Practices](#best-practices)
34+
1. [Troubleshooting](#troubleshooting)
35+
1. [Support](#support)
4936

5037
## Prerequisites
5138

@@ -277,8 +264,6 @@ Key endpoints:
277264
- Stop RTT: `POST /rtt/stop/:taskId`
278265
- Query RTT Status: `GET /rtt/status/:taskId`
279266

280-
Example start RTT request body:
281-
282267
```mermaid
283268
flowchart LR
284269
subgraph Client

0 commit comments

Comments
 (0)