Skip to content

Commit

Permalink
pulled from staging
Browse files Browse the repository at this point in the history
  • Loading branch information
saudsami committed Dec 20, 2023
2 parents baa11c5 + 0f1e99d commit b7ba4da
Show file tree
Hide file tree
Showing 143 changed files with 2,885 additions and 1,126 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/.docs-update-issue.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/milestone-management.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/milestone-management.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "[Internal] Milestone management"
description: Checklist for milestone tasks
title: "[Internal] Milestone management"
labels: 'Enhancement'
assignees: atovpeko

body:
- type: markdown
attributes:
value: "❗️ This Issue template is for Agora use only ❗️"

- type: textarea
attributes:
label: Details
validations:
required: true

- type: checkboxes
id: tasks
attributes:
label: "Take the following project management steps to fulfill this milestone:"
options:
- label: "Run the full scope of the proposed EN doc updates by the PO"
required: false
- label: "Merge all PRs and close relevant tickets when the work is done"
required: false
- label: "Create and share a Vercel instance for review and stakeholder signoff"
required: false
- label: "Implement comments from stakeholders until fully resolved"
required: false
- label: "Publish updates to https://docs.agora.io/en/"
required: false
- label: "Inform the stakeholders"
required: false
- label: "Close the milestone"
required: false
12 changes: 9 additions & 3 deletions .github/ISSUE_TEMPLATE/new-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ body:
label: Platform
description: Select the platform for the documentation update.
options:
- All or multiple (please specify)
- Android
- iOS
- Web
Expand All @@ -24,12 +25,19 @@ body:
validations:
required: true

- type: textarea
attributes:
label: Platform details
validations:
required: false

- type: dropdown
id: product
attributes:
label: Product
description: Select the product for the documentation update.
options:
- All or multiple (please specify)
- Video Calling
- Interactive Live Streaming
- Voice Calling
Expand All @@ -43,10 +51,8 @@ body:
required: true

- type: textarea
id: other_product
attributes:
label: Other Product
description: Enter the name of the product if you selected "Other" in the previous dropdown.
label: Product details
validations:
required: false

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: "[Internal] Rewrite a document according to the new architecture"
description: Describe this issue template's purpose here.
title: "Rewrite the '<Doc Title>' doc in POC3 style"
labels: 'Enhancement'
assignees: saudsami

body:
- type: markdown
attributes:
value: "❗️ This Issue template is for Agora use only ❗️"

- type: textarea
id: business_case
attributes:
label: Business case
value: |
The POC3 reference app simplifies the integration process of Video SDK. Clients can simply clone the code repository to experience and test product features. Add code for the implementation of **Document title** to the `video-sdk-samples-<platform>` code repository. Update the document to POC3 style and include the updated code. Use conditional blocks, where required, to create variants for Interactive live streaming, Broadcast Streaming, and Voice calling
validations:
required: true

- type: textarea
id: subject_matter_expert
attributes:
label: Subject Matter Expert
value: |
- Technical: Saud
- Language: Anastasia
- PM: Max (only if essential)
validations:
required: true

- type: textarea
id: scope
attributes:
label: Scope
placeholder: |
The products and documents to be updated:
* The code repository for your platform.
* The README file in the sample code folder.
* The Video calling document for the feature: <document-link>
validations:
required: true

- type: textarea
id: platforms
attributes:
label: Platforms
placeholder: |
- [Android](https://github.com/AgoraIO/video-sdk-samples-android) - Saud
- [iOS](https://github.com/AgoraIO/video-sdk-samples-ios) - Dasun
- [Web](https://github.com/AgoraIO/video-sdk-samples-js) - Kishan
> ... (and similarly for all other platforms)
validations:
required: false

- type: textarea
id: acceptance_criteria
attributes:
label: Acceptance criteria
placeholder: |
* The code uses best practices, runs without errors, and demonstrates the product feature.
* The documentation is technically correct, easy to use, follows the template structure, and follows the Google Developer Style Guide.
validations:
required: true

- type: textarea
id: additional_valuable_information
attributes:
label: Additional valuable information
placeholder: |
* Branch from and merge to the milestone branch.
* Use the same branch name in the code and docs repositories
validations:
required: false
13 changes: 13 additions & 0 deletions agora-chat/develop/ip_allowlist.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'TCP/TLS IP allowlist'
sidebar_position: 7
type: docs
description: >
Describes the TCP/TLS IP allowlist function
---

import IpAllowlist from '@docs/shared/chat-sdk/reference/_ip_allowlist.mdx';

export const toc = [{}];

<IpAllowlist PRODUCT="Chat" COMPANY="Agora" SDK="Chat SDK" CLIENT="app" />
6 changes: 3 additions & 3 deletions agora-chat/develop/ip_whitelist.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: 'IP whitelist'
title: 'RESTful API IP whitelist'
sidebar_position: 6
type: docs
description: >
Describes the IP whitelist function
Describes the RESTful API IP whitelist function
---

import IpWhitelist from '@docs/shared/chat-sdk/reference/_ip_whitelist.mdx';

export const toc = [{}];

<IpWhitelist PRODUCT="Chat" COMPANY="Agora" SDK="Chat SDK" CLIENT="app" />
<IpWhitelist PRODUCT="Chat" COMPANY="Agora" SDK="Chat SDK" CLIENT="app" />
13 changes: 13 additions & 0 deletions agora-chat/develop/proxy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Cross-border dedicated proxy'
sidebar_position: 7
type: docs
description: >
Describes the cross-border dedicated proxy function
---

import CrossBorderProxy from '@docs/shared/chat-sdk/develop/_cross_border_proxy.mdx';

export const toc = [{}];

<CrossBorderProxy PRODUCT="Chat" COMPANY="Agora" SDK="Chat SDK" CLIENT="app" />
Binary file added assets/images/chat/callback_addr_list.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/callback_secret.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.
23 changes: 23 additions & 0 deletions cloud-recording/develop/manage-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,29 @@ For example, in the filename `bak0_sid713476478245_cnameagora.m3u8`, `bak0` indi

After the cloud recording service enables the high availability mechanism, the names of the recorded TS/WebM files and the MP4 files are also prepended with `bak<n>`.

If you want to merge the original M3U8 file and the new M3U8 file generated after enabling the high availability mechanism into an MP4 file, you can use the <Link target="_blank" to="{{Global.CREC_TRANS_SCRIPT}}">transcoding script</Link> for file merging as follows (only applicable to merged recording files):

1. Please ensure that the server executing the transcoding script uses one of the following systems:
- Ubuntu 14.04+ x64
- CentOS 7.0+ x64
- Debian 8.0+

1. Enter the `transcoder` and `ffmpeg` paths in the terminal.

1. Execute the following command:

```sh
./ha_transcoder.exe -inputPath "<YourinputPath>" -ignoreNotExist -concatM3u8 -concatStrategy 0
```

| Parameter | Description | Is it required? |
|:---------------|:------------|:----------------|
| `-concatM3u8` | Merge the original M3U8 file and the new M3U8 file generated after enabling the high availability mechanism into one MP4 file. If this parameter is not set, the original M3U8 file and the new M3U8 file will be converted into MP4 files respectively. | no |
| `-concatStrategy` | Merge strategy, this parameter must be consistent with `-concatM3u8`. Can be set to: <ul><li> 0: (Default) If there is an overlap between two M3U8 files, the overlapping part of the original M3U8 file will be cut off; if there is a time interval between the two M3U8 files, the black frame of the corresponding time interval will be added.</li><li> 1: Merge two M3U8 files regardless of the overlap or time interval.</li></ul> | no |
| `-ignoreNotExist` | Missing TS files are ignored and black frames are used instead. If this parameter is not set, the absence of any TS file will cause the conversion to fail. | no |
| `-inputPath` | Input path, used to specify the absolute storage path of the files to be merged. | yes |
| `-outputPath` | Output path, used to specify the absolute storage path of the merged files. Defaults to the same as the input path. | no |

## File size
In an individual recording, the size of a recorded file depends on the audio and video bitrates of the media source and the duration of the recording. For example, if the audio bitrate is 48 Kbps, the video bitrate is 500 Kbps, and the recording lasts for 30 minutes (1800 seconds), the size of the recorded file is approximately (48 Kbps + 500 Kbps) * 1800 s = 986.4 Mbit, or 123.3 MB.

Expand Down
12 changes: 12 additions & 0 deletions extensions-marketplace/develop/integrate/dubbing-voice-changer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Dubbing AI Voice Changer"
sidebar_position: 3
type: docs
description: >
Dubbing AI Voice Changer extension is an encapsulation of the core API of real-time AI voice conversion.
---
export const toc = [{}];

import DubbingVoiceChanger from '@docs/shared/extensions-marketplace/dubbing-voice-changer/index.mdx';

<DubbingVoiceChanger />
Loading

0 comments on commit b7ba4da

Please sign in to comment.