From 89142600d4057d2e3819de1774df40cf3bcb9adb Mon Sep 17 00:00:00 2001 From: Max Cobb Date: Thu, 20 Jul 2023 15:15:17 +0100 Subject: [PATCH] updated READMEs --- README.md | 20 ++++++++++++-------- custom-video-and-audio/README.md | 5 +++++ get-started-sdk/README.md | 2 +- product-workflow/README.md | 6 +++++- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a94967e..848d655 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ -# Video SDK for iOS code examples +# Video SDK reference app (iOS) -Use the contents in this repo to compare the following ways of presenting runnable code examples in an open source -repository. In all examples, the code corresponds to a page in the Agora developer documentation. +> This repository is a work-in-progress. -Each folder contains the runnable code explained in the documentation. +This app demonstrates using Agora's Video SDK for real-time communication in a SwiftUI app. + +To understand the contents better, you can go to [Agora's Documentation](https://docs.agora.io), which explains each example in more detail. + +Included Examples: -Advantages are that we supply runnable code where the UI is abstracted so we concentrate more clearly on Agora - SDK. This means the docs become much shorter and simpler. Possible disadvantage is that we have to write the - code for the project. TBH, we already have the code, we are just putting it in a better format for learning. - [SDK quickstart](get-started-sdk) -- [Call quality](ensure-channel-quality) - [Secure authentication with tokens](authentication-workflow) +- [Connect through restricted networks with Cloud Proxy](cloud-proxy) +- [Secure channel encryption](media-stream-encryption) +- [Call quality best practice](ensure-channel-quality) +- [Screen share, volume control and mute](product-workflow) +- [Custom video and audio sources](custom-video-and-audio) diff --git a/custom-video-and-audio/README.md b/custom-video-and-audio/README.md index e69de29..e6b2ddd 100644 --- a/custom-video-and-audio/README.md +++ b/custom-video-and-audio/README.md @@ -0,0 +1,5 @@ +# Custom video and audio sources + +## Full Documentation + +[Custom video and audio sources](https://docs.agora.io/en/interactive-live-streaming/develop/custom-video-and-audio?platform=ios) diff --git a/get-started-sdk/README.md b/get-started-sdk/README.md index f79a4a2..98fb731 100644 --- a/get-started-sdk/README.md +++ b/get-started-sdk/README.md @@ -10,7 +10,7 @@ This page shows the minimum code you need to integrate high-quality, low-latency ### Agora Logic -Most of the business logic for the Agora quickstart guide can be found in [AgoraManager](../AgoraManager/AgoraManager.swift). Here you will find code snippets for [initialising the engine](../AgoraManager/AgoraManager.swift#L23-L28), monitoring when someone [joins the channel](../AgoraManager/AgoraManager.swift#L84-L86) or [leaves the channel](../AgoraManager/AgoraManager.swift#L97-L99). +Most of the business logic for the Agora quickstart guide can be found in [AgoraManager](../AgoraManager/AgoraManager.swift). Here you will find code snippets for [initialising the engine](../AgoraManager/AgoraManager.swift#L25-L30), monitoring when someone [joins the channel](../AgoraManager/AgoraManager.swift#L56-L58) or [leaves the channel](../AgoraManager/AgoraManager.swift#L97-L101). Joining and leaving the channel can be found in [GettingStartedView](GettingStartedView.swift), in the onAppear and onDisappear views. diff --git a/product-workflow/README.md b/product-workflow/README.md index 37fb80e..1ed79d3 100644 --- a/product-workflow/README.md +++ b/product-workflow/README.md @@ -1 +1,5 @@ -# Screen Share and Volume +# Screen share, volume control and mute + +## Full Documentation + +[Screen share, volume control and mute](https://docs.agora.io/en/interactive-live-streaming/develop/product-workflow?platform=ios)