-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'beta-as-copy-of-staging-latest' of https://github.com/A…
…goraIO/Docs-Source into beta-as-copy-of-staging-latest
- Loading branch information
Showing
22 changed files
with
359 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 3, | ||
"label": "Develop", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 2, | ||
"label": "Get started", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: 'Media Gateway quickstart' | ||
sidebar_position: 1 | ||
type: docs | ||
description: > | ||
Stream directly with RTMP/SRT protocol to Agora RTC channels. | ||
--- | ||
|
||
import MEDIAGateway from '@docs/shared/media-gateway/get-started/_quickstart.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<MEDIAGateway /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 1, | ||
"label": "Overview", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Core concepts' | ||
sidebar_position: 2 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
Ideas that are central to developing with Agora. | ||
--- | ||
|
||
import CoreConcepts from '@docs/shared/common/_core-concepts.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<CoreConcepts product="Video Calling" PATH="video-calling" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: 'Product overview' | ||
sidebar_position: 1 | ||
platform_selector: false | ||
description: > | ||
Stream directly with RTMP/SRT protocol to Agora RTC channels.. | ||
--- | ||
|
||
<ProductOverview | ||
title="Media Gateway" | ||
img="/images/media-gateway/overview-page-image.png" | ||
quickStartLink="/media-gateway/get-started/quickstart" | ||
apiReferenceLink="/api-reference?platform=rest" | ||
samplesLink="" | ||
productFeatures={[ | ||
{ | ||
title: "High reliability", | ||
content: "Enhance service reliability with a globally distributed cluster deployment, ensuring high-quality and seamless user experience in every region.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Low latency", | ||
content: "Experience seamless, real-time communication as the source stream directly enters the channel at the gateway, minimizing latency between the host and the audience. ", | ||
link: "" | ||
}, | ||
{ | ||
title: "Transcoding support", | ||
content: "Employ advanced transcoding capabilities on media streams for bandwidth optimization, enhanced delivery speed, cross-device compatibility, and wider distribution.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Stable and easy to use", | ||
content: "Simple and easy to use API helps you integrate the feature quickly.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Safety compliance", | ||
content: "Safe and secure real-time transmission of audio and video data without caching or collecting users' personal information.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Multi-format, multi-protocol media streaming support", | ||
content: "Works with several audio and video codecs, streaming protocols and media formats.", | ||
link: "" | ||
}, | ||
]} | ||
|
||
> | ||
|
||
<Vpd k="NAME" /> allows users to directly push media streams into Agora’s Real-Time Voice and Video channels using the | ||
RTMP/SRT protocol. To facilitate distribution, Media Gateway also allows users to perform advanced transcoding | ||
processing on media streams. | ||
|
||
</ProductOverview> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 4, | ||
"label": "Reference", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: 'Integration best practice' | ||
sidebar_position: 1 | ||
type: docs | ||
description: > | ||
Best practice for using Media Gateway and its RESTful API. | ||
--- | ||
|
||
import BestPractice from '@docs/shared/media-gateway/reference/_best-practice.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<BestPractice /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Glossary' | ||
sidebar_position: 5 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
A list of terms used in Agora documentation. | ||
--- | ||
|
||
import Glossary from '@docs/shared/common/_glossary.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<Glossary PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Agora account management' | ||
sidebar_position: 2 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
Create, manage and update your Agora account. | ||
--- | ||
|
||
import ManageAccount from '@docs/shared/common/_manage-agora-account.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<ManageAccount PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Release notes' | ||
sidebar_position: 4 | ||
type: docs | ||
description: > | ||
Shows Media Gateway's past releases. | ||
template: 'platform' | ||
--- | ||
|
||
import ReleaseNotes from '@docs/shared/media-gateway/reference/_release-notes.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<ReleaseNotes /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Security' | ||
sidebar_position: 3 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
How Agora handles security. | ||
--- | ||
|
||
import Security from '@docs/shared/common/_security.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<Security PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 2, | ||
"label": "Get started", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Quickstart' | ||
sidebar_position: 1 | ||
type: docs | ||
description: > | ||
Transcribe audio content of a host's media stream into written words in real time. | ||
--- | ||
|
||
import RealTimeTranscription from '@docs/shared/video-sdk/develop/_real-time-transcription.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<RealTimeTranscription PRODUCT="Video Calling" company="Agora" PATH="video-calling" client="app" /> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 1, | ||
"label": "Overview", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: 'Core concepts' | ||
sidebar_position: 2 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
Ideas that are central to developing with Agora. | ||
--- | ||
|
||
import CoreConcepts from '@docs/shared/common/_core-concepts.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<CoreConcepts product="Video Calling" PATH="video-calling" /> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: 'Product overview' | ||
sidebar_position: 1 | ||
platform_selector: false | ||
description: > | ||
Create a better user experience with the most accurate live transcription and subtitling. | ||
--- | ||
|
||
|
||
<ProductOverview | ||
title="Real-Time Transcription" | ||
img="/images/real-time-transcription/real-time-transcription.png" | ||
apiQuickStartLink="/real-time-transcription/get-started" | ||
apiReferenceLink="/api-reference" | ||
samplesLink="https://github.com/AgoraIO/agora-rtt-server" | ||
productFeatures={[ | ||
{ | ||
title: "Live transcription for RTC", | ||
content: "Integrated with Agora’s voice and video service, live transcription and captions improve accessibility for your audience. Perfect for meetings, live streaming, lectures, interviews, live shopping, and more.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Channel-based cloud transcription", | ||
content: "Cloud transcription service converts audio to text based on channel and distributes the text to all participants in this channel to show live closed captions (CC). Transcripts are saved to the cloud.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Transcribing and labeling simultaneous speakers", | ||
content: "Easily label who said what—even with up to 3 simultaneous speakers. Separate transcription for each host ensures accurate voice transcription with multiple hosts.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Captioning for cloud recordings", | ||
content: "Play back audio or video recordings with closed captions (CC) and review important discussion items in the transcript.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Multi-language support", | ||
content: "Real-time transcription supports all major languages and dialects, and each channel can support audio to text transcription for up to two languages simultaneously.", | ||
link: "" | ||
}, | ||
{ | ||
title: "Enterprise-grade security and compliance", | ||
content: "Agora is ISO and SOC 2 certified and meets compliance standards for regional privacy laws and industry regulations, including GDPR, CCPA, and HIPAA.", | ||
link: "" | ||
}, | ||
]} | ||
|
||
> | ||
|
||
Agora <Vg k="RTT" /> enables you to instantly transcribe speech to text for live audio and video. Channel-based live transcription allows you to distribute live captions to all participants in channel while only paying for the duration of a channel—not the number of users. | ||
|
||
|
||
|
||
</ProductOverview> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 4, | ||
"label": "Reference", | ||
"collapsible": true, | ||
"link": null | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Glossary' | ||
sidebar_position: 10 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
A list of terms used in Agora documentation. | ||
--- | ||
|
||
import Glossary from '@docs/shared/common/_glossary.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<Glossary PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |
14 changes: 14 additions & 0 deletions
14
real-time-transcription/reference/manage-agora-account.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Agora account management' | ||
sidebar_position: 9 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
Create, manage and update your Agora account. | ||
--- | ||
|
||
import ManageAccount from '@docs/shared/common/_manage-agora-account.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<ManageAccount PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: 'Pricing' | ||
sidebar_position: 1 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
Introduces the billing policy for Real-Time Transcription. | ||
--- | ||
|
||
export const toc = [{}]; | ||
|
||
This page introduces the billing policy for the <Vg k="RTT" /> add-on provided by Agora. | ||
|
||
Your billing details may differ if you have signed a contract with Agora. | ||
|
||
## Overview | ||
|
||
Agora calculates the billing of all projects under your Agora account on a monthly basis. Billing begins once you | ||
enable <Vg k="RTT" />. | ||
|
||
|
||
## Transcription fee | ||
|
||
The Agora streaming server charges you when transcribe the subscribed streams. Agora's free-of-charge policy for the | ||
first 10,000 minutes does not apply to the transcription fee. | ||
|
||
|
||
## Unit price for transcription | ||
|
||
[Real-Time Transcription](../enable-features/real-time-transcription) takes the audio content of a host's media stream | ||
and transcribes it into written words in real time. Agora charges for the time that <Vg k="RTT" /> is enabled in a channel, | ||
which includes transcription for the active host. Transcription is available for up to 3 hosts speaking at the same time. | ||
If several hosts speak simultaneously, Agora also charges for the time of speaking of each additional host using | ||
the same pricing. Also note that when you enable <Vg k="RTT" />, <Vg k="AGORA_BACKEND" /> creates a cloud audience member who subscribes to the audio in the channel. | ||
The usage for this audience member is added to your bill. | ||
|
||
|Usage, minutes per month |Pricing, US$/1,000 minutes| | ||
|--------------------|--------------------------| | ||
|Above 0 | 16.99 | | ||
|
||
Contact [email protected] to get a discount. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: 'Security' | ||
sidebar_position: 11 | ||
type: docs | ||
platform_selector: false | ||
description: > | ||
How Agora handles security. | ||
--- | ||
|
||
import Security from '@docs/shared/common/_security.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<Security PRODUCT="Media Push" company="Agora" client="app" PATH="media-push" /> |