Skip to content

Commit

Permalink
updated READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxxfrazer committed Jul 20, 2023
1 parent edac290 commit 8914260
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 10 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 5 additions & 0 deletions custom-video-and-audio/README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion get-started-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 5 additions & 1 deletion product-workflow/README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 8914260

Please sign in to comment.