Skip to content

Commit

Permalink
Endoc 212 rtt updates (#1073)
Browse files Browse the repository at this point in the history
* Releasing - POC3 (#1509) (#1510)

* Last change.

* Latest changes.

* Update on review.

* call quality guide.

* Update prerequisites

* Filter out the docs without an example.

* Updates on review.

* Update API ref.

* Update API ref.

* Update docs to match the examples supplied so far.

* Add the custom audio, but not published as PR is not accepted yet.

* Last update.

* POC3 iOS get-stared changes.

* POC3 iOS call-quality changes.

* Updated doc structure

* Update

* Updates

* call quality updates

* Updates

* POC3 iOS authentication changes.

* POC3 macOS get-started, call-quality, authentication changes.

* Start merging all the PRs for POC3

* Start merging all the PRs for POC3

* Merge the other projects.

* Updates

* Merge the other projects.

* iOS macOS updates to match the latest code.

* Updates

* Update to GetStarted.

* Authentification workflow.

* Call quality updates.

* call quality doc updates

* Review updates

* Update

* doc structure

* Updates

* reversed changes committed to the wrong branch

* unity poc3

* update get started for vsdk poc3 web

* update vsdk secure auth docs

* get started

* Authentication guide.

* update call quality doc

* Call quality

* Windows POC3 Code Doc

* Updated for call quality

* Get started.

* Call quality.

* Call quality.

* implement Secure Authentication Server POC3 To DOC

* cloud proxy + additional updates

* media encryption unity

* android media player updates (#411)

* Update shared/video-sdk/get-started/get-started-sdk/project-implementation/unity.mdx



* Update shared/video-sdk/get-started/get-started-sdk/project-implementation/unity.mdx



* cloud-proxy updates

* Review updates

* review updates

* Updates

* review update

* update cloud proxy doc

* media-player

* audioAndVoiceEffects

* Update project-implement/unity.mdx

* product-workflow

* updated logic in swift join channel to show each of the three methods, all included in the sample project

* removed all spaces after triple ticks, which shouldn't be there

* added small description comment to callback handlers, added one for voice calling. unified ios and macos examples in get started root

* removed android and flutter separated implementations. added shared files for each code snippets

* removed separate ios and macos implementation, bundled them with android and flutter.

* removed older swift implementations

* android and flutter using poc3 mdx file for ensure-channel-quality

* Geofencing unity

* audio and voice effects updates

* updates

* Product workflow updates

* updated ensure channel quality to include ios and macos.

* cal quality updates

* added cloud proxy and encrypt media streams poc3 templates

* added geofencing poc3 example for ios and macos

* added reactjs to the geofencing example, but it will currently not render in the poc3 specific document due to platform wrappers

* Api ref updates + additional updates

* virtual background

* updates

* resolved build issues

* POC3 docs in new doc structure

* updated ios to have testing hardware options

* update platform added incorrectly fixed

* updated cloud proxy for ios and macos

* removed duplicated lines

* update ios screensharing code to use the replaykit extension

* update encrypt media, play media and custom audio video to use poc3.mdx for at least ios

* updated virtual background coumentation, including test your implementation section

* moved platform specific code to enable-audio-publishing code asset file

* added device compatibility check for virtual background

* Raw Video Audio Processing iOS POC3 new structure

* Fix auto-numbering, remove empty blocks from other platforms, remove platform specific code from poc3, remove unused variables, added api ref links

* added examples of modifying the pixelbuffer and audio buffer

* added api references for each ios and macos code blocks in cloud-proxy, encrypt-media-streams and ensure-channel-quality

* multi-channel live streaming

* updates

* added spatial audio for ios and macos poc3 style-y

* added api reference links for custom-video-and-audio, geofencing and play-media (ios/macos)

* 622 changes.

* added code blocks for joining and leaving secondary channel, added code for monitoring relay state, changed delegates to not be delegate2, updated extra delegate methods, fixed api reference urls, added secondConnection and destUid to variables, added media relay code block.

* updated all ios links to use engine api ref constant if required. added api ref links to product-workflow (#687)

* refactor web get started

* added screensharing example code in poc3 for macos

* update macos screenshare api reference links to open in new tab

* update web cloud proxy doc (#434)

* Release notes - first draft

* Link to beta docs

* Added a bug fix

* update get started for vsdk poc3 web

* update vsdk secure auth docs

* update call quality doc

* Get started.

* Call quality.

* Call quality.

* fix

* revert unrelated changes

* revert unrelated changes

* Removed the fixed issue

* Updated RN

* update cloud proxy doc

* refactor web get started

---------





* New poc3 structure for unity (#705)

* updates

* new structure for unity

* added screensharing example code in poc3 for macos

* update macos screenshare api reference links to open in new tab

* update web cloud proxy doc (#434)

* Release notes - first draft

* Link to beta docs

* Added a bug fix

* update get started for vsdk poc3 web

* update vsdk secure auth docs

* update call quality doc

* Get started.

* Call quality.

* Call quality.

* fix

* revert unrelated changes

* revert unrelated changes

* Removed the fixed issue

* Updated RN

* update cloud proxy doc

* refactor web get started

---------





* updates

* new structure for unity

* updates

* Update assets/code/video-sdk/audio-voice-effects/apply-voice-effects.mdx

---------








* added display media section to play-media story

* Update shared/video-sdk/develop/play-media/project-implementation/poc3.mdx



* Update shared/video-sdk/develop/play-media/project-implementation/poc3.mdx



* fix geofencing and spatial audio layouts

* updates

* align ios, macos, and unity in product-workflow doc

* get started

* updates

* updates

* updates

* updates

* updated terminal to sh on code block

* added POST request example for all, and removed GET for iOS/macOS (#732)

* added api ref links to get started guide for ios macos. added permission handler code for ios/macos (#730)

* update

* add auth workflow poc3

* add cloud proxy

* add more apps

* android updates for quickstart, authentication and call quality (#736)

* get-started and authentication updates

* authentication updates

* Update

* updates

* call quality updates

* Update

* Poc3 android code insertion (#745)

* get-started and authentication updates

* authentication updates

* Update

* updates

* call quality updates

* Update

* product workflow updates

* cloud proxy updates

* media encryption updates

* updates

* Geofencing updates

* media player updates

* multiple channels I

* Multiple channels update II

* Custom audio and video

* Raw video and audio

* Raw video and audio

* Audio and voice effects

* Virtual background

* AI noise suppression

* get-started update

* Update

* get-started numbering fix

* geofencing + cloud proxy (#735)

* geofencing + cloud proxy

* review updates

* code indentation

---------



* update play-media to include macos (#749)

* Audio and voice effects + product workflow for reactjs (#746)

* audio and voice effects

* product workflow

* svg updates

* updates

* audio and voice effects

* product workflow

* svg updates

* updates

* audio voice effects update

* updates

---------



* updates (#741)

* Update

* audio-voice-effects iOS + macOS (#753)

* added voice effect code blocks

* added api ref links to audio-and-voice-effects code blocks

* added ains code for ios and macos (#754)

* multichannel streaming and custom media (#755)

* multichannel streaming and custom media

* removed .DS_Store files

---------



* Call quality reactjs poc3 (#756)

* call quality

* review updates

* updates

* updates

* fixed the index file

---------



* add call quality doc

* Authentication workflow + ai denoiser for reactjs (#761)

* Authentication workflow

* ai-denoiser

* denoiser

* authentication updates

---------



* milestone39 review updates and improvements (#762)

* updates

* review updates

* review updates

* Added android spatial audio code

* Updates

* updates

* spatial audio + media encryption (#763)

* add product workflow doc

* add spatial audio docs

* add denoiser docs

* add custom av docs

* updates

* updated macos for raw video and custom audio-video (#767)

* custom-audio-video macos updates

* Voice calling updates/milestone39 rewrite video sdk docs (#764)

* get-started updates

* get-started setup and prereqs update

* voice-calling updates

* Update

* Call quality max suggestions (#760)

* updates

* updates

* Update

---------



* Multiple Channels Updates macOS (#768)

* updated macos for raw video and custom audio-video

* updated multiple channels docs for macos and ios

* Project Test Sections (#759)

* updated project-test section for some documents to use the reference apps, covering android/ios/macos

* test section improvements

* Call-quality updates

* stream-media and multiple-channels updates

* product-workflow updates

* updates

* updates

* virtual background updates

* Updates

---------




* Update

* poc3.mdx header updates (#772)

* Update

* update

* Update

* Updates after final checking (#769)

* updates

* updates

* updates

* updates

---------



* Docs organization changes (#771)

* Rearrange docs

* Rearrange docs

* Review updates/milestone39-poc3 (#779)

* review-updates

* update

* review updates

* Move api ref web (#775)

* refactor get started references

* refactor references for auth workflow

* refactor cloud proxy references

* refactor play media references

* refactor encrypt references

* refactor call quality refs

* refactor product workflow refs

* refactor custom audio video refs

* refactor geofencing

* virtual background in poc3

* geofencing update

* review updates

* updates

---------




* Release notes for ReactJS (#778)

* Release notes

* Release notes

* Multi-channel updates + Custom media source + Raw audio and video (#774)

* updates

* updates

* updates

* updates

* updates

* Updates

* updates

---------



* update

* Update

* Live stream over multiple channela doc (#780)

* refactor get started references

* refactor references for auth workflow

* refactor cloud proxy references

* refactor play media references

* refactor encrypt references

* refactor call quality refs

* refactor product workflow refs

* refactor custom audio video refs

* refactor geofencing

* virtual background in poc3

* geofencing update

* add live streaming over multiple channel

* review updates

---------



* Encryption Handler iOS (#783)

* add ios event handler to encryption, and remove duplicated code in some poc3 files

* remove ds store

* removed-repeated step

---------



* updates for voice calling (#787)

* updates for voice calling unity

* added back voice-calling custom-audio doc

---------



* Add error codes doc/milestone39 (#788)

* Updates

* Update

* Updates

* error-codes update

* updates

* fix ios declared variables and probe test in call quality doc (#794)

* get-started update

* non-poc3 platforms update

* updates

* review updates

* Added web demo links (#801)

* Voice changes for poc3 web (#804)

* voice-sdk-web-poc3

* review updates

---------



* update token example code link to latest release

---------

Co-authored-by: billy-the-fish <[email protected]>
Co-authored-by: Dasun Nirmitha <[email protected]>
Co-authored-by: saudsami <[email protected]>
Co-authored-by: Saud <[email protected]>
Co-authored-by: Hussain Khalid <[email protected]>
Co-authored-by: Kishan Dhakan <[email protected]>
Co-authored-by: pankajg123 <[email protected]>
Co-authored-by: Max Cobb <[email protected]>
Co-authored-by: Max Cobb <[email protected]>
Co-authored-by: Kishan Dhakan <[email protected]>
Co-authored-by: atovpeko <[email protected]>
Co-authored-by: atovpeko <[email protected]>

* release notes

* release date

* Endoc 121 and 123 (#1008)

* email update

* ENDOC-121 updates

* update (#1009)

* release note

* removed mentions of cocos

* release notes

* release notes updated

* added eu data center

* remove duplication

* updates

* march updates

* fixed Media Gateway variable

* ENDOC-138

* ENDOC-136

* Fastboard API change

* ENDOC-114

* storage formula updated

* enable signaling + remove p2p & invites

* structure fix

* Updates

---------

Co-authored-by: Shahriar P. Shuvo <[email protected]>
Co-authored-by: billy-the-fish <[email protected]>
Co-authored-by: Dasun Nirmitha <[email protected]>
Co-authored-by: Hussain Khalid <[email protected]>
Co-authored-by: Kishan Dhakan <[email protected]>
Co-authored-by: pankajg123 <[email protected]>
Co-authored-by: Max Cobb <[email protected]>
Co-authored-by: Max Cobb <[email protected]>
Co-authored-by: Kishan Dhakan <[email protected]>
Co-authored-by: atovpeko <[email protected]>
Co-authored-by: atovpeko <[email protected]>
  • Loading branch information
12 people authored Apr 25, 2024
1 parent 2fc3648 commit 5550ab1
Show file tree
Hide file tree
Showing 79 changed files with 671 additions and 659 deletions.
2 changes: 1 addition & 1 deletion assets/code/video-sdk/get-started-sdk/handle-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -404,4 +404,4 @@ func rtcEngine(_ engine: AgoraRtcEngineKit, didOfflineOfUid uid: UInt, reason: A
- <Link to="{{Global.API_REF_CPP_ROOT}}/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onuseroffline">onUserOffline</Link>
- <Link to="{{Global.API_REF_CPP_ROOT}}/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onleavechannel">onLeaveChannel</Link>

</PlatformWrapper>
</PlatformWrapper>
Binary file added assets/images/chat/post_delivery_callback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/chat/pre_delivery_callback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/images/video-sdk/real-time-transcription-server.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions cloud-recording/reference/rest-api/acquire.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,30 @@ description: >
Before starting a cloud recording, you need to call the `acquire` method get a resource ID.
---


> Each resource ID can only be used for one recording session.
- Method:POST
- Endpoint: /v1/apps/\<appid\>/cloud_recording/acquire

> The request frequency limit is 10 requests per second for each [Agora account](../manage-agora-account#create-an-agora-account). Contact [Agora technical support](mailto:[email protected]) if you want to raise the limit.
If this method call succeeds, you get a `resourceId` from the HTTP response body. The resource ID is valid for five minutes, so you need to [start recording](start) with this resource ID with it before it expires.

If this method call succeeds, you get a resource ID (`resourceId`) from the HTTP response body. The resource ID is valid for five minutes, so you need to [start recording](start) with this resource ID with it before it expires.
<Admonition type="info" title="Information">
* Each resource ID can only be used for one recording session.
* The request frequency limit is 10 requests per second for each [Agora account](../manage-agora-account#create-an-agora-account). Contact [Agora technical support](mailto:[email protected]) if you want to raise the limit.
</Admonition>

## HTTP request

The following parameter is required in the URL.

| Parameter | Type | Description |
| :-------- | :----- | :----------------------------------------------------------- |
| `appid` | String | Your [App ID](../manage-agora-account#get-the-app-id)<ul><li>In web page recording mode: Use the App ID for which the cloud recording service has been enabled.</li><li>In other modes: Use the same App ID as the channel to be recorded. Ensure that the cloud recording service has been enabled for this App ID.</li></ul> |
| `appid` | String | Your [App ID](../manage-agora-account#get-the-app-id).<ul><li>In web page recording mode: Use the App ID for which the cloud recording service has been enabled.</li><li>In other modes: Use the same App ID as the channel to be recorded. Ensure that the cloud recording service has been enabled for this App ID.</li></ul> |

The following parameters are required in the request body.

| Parameter | Type | Description |
| :-------------- | :----- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cname` | String | <ul><li>In web page recording mode, use `cname` to distinguish between recording sessions. `cname` should not exceed 128 bytes. You can use a set of `appid`, `cname`, and `uid` to identify one session. As a best practice, if you want to record a web page in more than one session, you can use different user IDs to identify each session while using the same `cname` to relate to all sessions for that web page.</li><li>In other recording modes, use `cname` to set the name of the channel to be recorded.</li></ul> |
| `uid` | String | A string that contains the user ID of the recording client, for example `"527841"`. The user ID needs to meet the following requirements: <li>It is a 32-bit unsigned integer within the range between 1 and (2<sup>32</sup>-1).</li><li><b><em>It is unique and does not duplicate any existing user ID in the channel. </em></b></li><li>It is an integer; Cloud Recording does not support user account (which is a string), so all user IDs in the channel must be integers.</li> |
| Parameter | Type | Description |
| :-------------- | :----- |:------------------------------------|
| `cname` | String | <ul><li>In web page recording mode, use `cname` to distinguish between recording sessions. `cname` should not exceed 128 bytes. You can use a set of `appid`, `cname`, and `uid` to identify one session. As a best practice, if you want to record a web page in more than one session, you can use different user IDs to identify each session while using the same `cname` to relate to all sessions for that web page.</li><li>In other recording modes, use `cname` to set the name of the channel to be recorded.</li></ul> |
| `uid` | String | A string that contains the user ID of the recording client, for example `"527841"`. The user ID needs to meet the following requirements: <li>It is a 32-bit unsigned integer within the range between 1 and (2<sup>32</sup>-1).</li><li><b><em>It is unique and does not duplicate any existing user ID in the channel. </em></b></li><li>It is an integer; Cloud Recording does not support user account (which is a string), so all user IDs in the channel must be integers.</li> |
| `clientRequest` | JSON | A specific client request that includes the following parameters: <ul><li>`region`: (Optional) String, which is used to specify the region for connection. If you specify a region, the cloud recording server connects only to the Agora servers within that region. The following region settings are supported: `"CN"` (Mainland China), `"AP"` (Asia, excluding Mainland China), `"EU"` (Europe), or `"NA"` (North America).</li><li> `resourceExpiredHour:` (Optional) Number. Sets the time limit (in hours) for Cloud Recording RESTful API calls. Time starts counting when you successfully start a cloud recording and get an `sid` (the recording ID).<ul><li> If you exceed the time limit, you can no longer call `query`, `update`, `updateLayout`, or `stop`. </li><li>The recording will not stop after exceeding the time limit. The maximum recording length is the value you set through the `maxRecordingHour` parameter of the `start` method.</li><li>The value range of `resourceExpiredHour` is [1, 720], and the default value is `72`.</li></ul></li> <li>`scene`: (Optional) Number. Sets the recording options. <ul><li>`0`:Audio and video recording (Default) or [Postpone Audio Mixing](../../develop/individual-nontranscoding#implement-an-postpone-audio-mixing):<ul> <li>Audio and video recording: The recording service uploads the recording files to the third-party cloud storage you specify in real time after the recording ends.</li><li>Postpone Audio Mixing: The recording service merges and transcodes the recording files of all user IDs in the specified channel within 24 hours after the recording ends to generate an MP3/M4A/AAC file, and then uploads the file to the third-party cloud storage you specify. This scene is only applicable to the individual audio non-transcoding recording mode.</li> </ul> </li> <li>`1`: Web page recording.</li><li>`2`: Postpone transcoding. After setting this scene, the recording service transcodes the recording file to generate an MP4 file within 24 hours after recording, and uploads the MP4 file to the third-party cloud storage you specify. This scenario only applies to individual recording mode. Also set the `appsCollection` parameter in the `start` method.</li></ul> </li> </ul> |

### Request example
Expand Down
2 changes: 1 addition & 1 deletion flexible-classroom/overview/pricing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This page explains how <Vg k="COMPANY" /> calculates your monthly bill for <Vg k

If you have already signed a contract with <Vg k="COMPANY" />, the billing terms and conditions within that contract take precedence.

The pricing on this page applies to one-to-one, small, large, and cloud classrooms only. For online proctoring pricing, contact sales@agora.io.
The pricing on this page applies to one-to-one, small, large, and cloud classrooms only. For online proctoring pricing, contact support@agora.io.

## <Vg k="FC" /> pricing

Expand Down
8 changes: 4 additions & 4 deletions flexible-classroom/overview/product-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following figure shows the overall product architecture of <Vg k="FC"/>:
| Classroom type | Example | Applicable scene | Supported platform |
|---|---|---|---|
| 1-to-1 interactive teaching | One teacher provides exclusive online tutoring to one student. | Suitable for 1-to-1 personalized VIP tutoring. | <ul><li>Web</li> <li>Electron</li> <li>Android</li> <li>iOS</li></ul> |
| Small interactive online classroom | One teacher with multiple students watching and listening in real time. During the class, the teacher can invite students to *come on stage* to speak and interact with them using real-time audio and video. The class size limit is 200; contact sales@agora.io to extend it. | Suitable for teaching scenarios that emphasize peer learning, interactivity, and participation. The class size generally does not exceed 20 people. | <ul><li>Web</li> <li>Electron</li> <li>Android</li> <li>iOS</li></ul> |
| Large interactive live classroom | One teacher with multiple students watching and listening in real time. During the class, students can *raise their hands* to request to speak and interact with the teacher using real-time audio and video. The class size limit is 5,000; contact sales@agora.io to extend it. | Often used in open classes or diversion classes, where teachers deliver the lectures and assistant teachers help answer questions. |<ul><li>Web</li> <li>Electron</li> <li>Android</li> <li>iOS</li></ul> |
| Cloud classroom | The new UI style and interactive experience that are closer to education users' habits. One teacher interacting with multiple students using real-time audio and video. The class size limit is 50; contact sales@agora.io to extend it. | Suitable for small classroom teaching scenarios with strong interaction. The class size does not exceed 50 people. Having no more than 10-20 attendees is recommended. | Web |
| Online proctoring | Online proctoring refers to online monitoring of candidates' behavior through webcams, microphones, and screen sharing during online exams. The recommended online proctoring scenario is for one examiner to proctor 25 to 50 candidates at the same time. For more information, contact sales@agora.io. | <ul><li>School exams</li><li>Certification exams</li><li>Recruitment</li></ul> | <ul><li>Web</li><li>iOS</li></ul>|
| Small interactive online classroom | One teacher with multiple students watching and listening in real time. During the class, the teacher can invite students to *come on stage* to speak and interact with them using real-time audio and video. The class size limit is 200; contact support@agora.io to extend it. | Suitable for teaching scenarios that emphasize peer learning, interactivity, and participation. The class size generally does not exceed 20 people. | <ul><li>Web</li> <li>Electron</li> <li>Android</li> <li>iOS</li></ul> |
| Large interactive live classroom | One teacher with multiple students watching and listening in real time. During the class, students can *raise their hands* to request to speak and interact with the teacher using real-time audio and video. The class size limit is 5,000; contact support@agora.io to extend it. | Often used in open classes or diversion classes, where teachers deliver the lectures and assistant teachers help answer questions. |<ul><li>Web</li> <li>Electron</li> <li>Android</li> <li>iOS</li></ul> |
| Cloud classroom | The new UI style and interactive experience that are closer to education users' habits. One teacher interacting with multiple students using real-time audio and video. The class size limit is 50; contact support@agora.io to extend it. | Suitable for small classroom teaching scenarios with strong interaction. The class size does not exceed 50 people. Having no more than 10-20 attendees is recommended. | Web |
| Online proctoring | Online proctoring refers to online monitoring of candidates' behavior through webcams, microphones, and screen sharing during online exams. The recommended online proctoring scenario is for one examiner to proctor 25 to 50 candidates at the same time. For more information, contact support@agora.io. | <ul><li>School exams</li><li>Certification exams</li><li>Recruitment</li></ul> | <ul><li>Web</li><li>iOS</li></ul>|
Loading

0 comments on commit 5550ab1

Please sign in to comment.