{"id":20268680,"url":"https://github.com/agoraio/video-sdk-samples-macos","last_synced_at":"2025-06-30T14:03:23.879Z","repository":{"id":195812794,"uuid":"657383044","full_name":"AgoraIO/video-sdk-samples-macos","owner":"AgoraIO","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-12T13:12:48.000Z","size":1807,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-01-14T05:25:50.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-23T00:17:43.000Z","updated_at":"2023-09-19T14:42:32.000Z","dependencies_parsed_at":"2023-09-19T18:26:32.349Z","dependency_job_id":null,"html_url":"https://github.com/AgoraIO/video-sdk-samples-macos","commit_stats":null,"previous_names":["agoraio/video-sdk-samples-macos"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-macos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-macos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-macos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-macos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/video-sdk-samples-macos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241753144,"owners_count":20014252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T12:19:20.265Z","updated_at":"2025-03-03T23:03:42.130Z","avatar_url":"https://github.com/AgoraIO.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Video SDK reference app (macOS)\n\nThis app demonstrates using Agora's Video SDK for real-time communication in a SwiftUI app.\n\nThis example app is a robust and comprehensive documentation reference app for macOS, designed to enhance your productivity and understanding. It's built to be flexible, easily extensible, and beginner-friendly.\n\nTo understand the contents better, you can go to [Agora's Documentation](https://docs.To understand the contents better, you can go to [Agora's Documentation](https://docs.agora.io), which explains each example in more detail.\n\n- [Samples](#samples-)\n- [Prerequisites](#prerequisites)\n- [Run this project](#run-this-project)\n- [Screenshots](#screenshots)\n- [Contact](#contact)\n\n## Samples\n\nYou'll find numerous examples illustrating the functionality and features of this reference app in the root directory. Each example is self-contained in its own directory, providing an easy way to understand how to use the app. For more information about each example, see the README file within its directory.\n\n### Get Started\n- [SDK quickstart](./get-started-sdk/)\n- [Secure authentication with tokens](./authentication-workflow/)\n\n### Core Functionality\n\n- [Connect through restricted networks with Cloud Proxy](./cloud-proxy/)\n- [Stream media to a channel](./play-media/)\n- [Secure channel encryption](./media-stream-encryption/)\n- [Live streaming over multiple channels](./live-streaming-over-multiple-channels/)\n- [Call quality best practice](./ensure-channel-quality/)\n- [Screen share, volume control and mute](./product-workflow/)\n- [Custom video and audio sources](./custom-video-and-audio/)\n- [Raw video and audio processing](./stream-raw-audio-and-video/)\n\u003c!-- - [Integrate and extension]() --\u003e\n\n### Integrate Features\n\n- [Geofencing](./geofencing/)\n- [Virtual background](./virtual-background/)\n\n## Prerequisites\n\nBefore getting started with this example app, please ensure you have the following software installed on your machine:\n\n- Xcode 13.0 or later.\n- Swift 5.5 or later.\n- A device running macOS 10.11 or later.\n\n## Run the App\n\n1. **Clone the repository**\n\n   1. To clone the repository to your local machine, open Terminal and navigate to the directory where you want to \n   clone the repository. Then, use the following command:\n\n        ```sh\n        git clone https://github.com/AgoraIO/video-sdk-samples-macos.git\n        ```\n\n   1. If you are using a device using the ARM architecture such as the MacBook Air M1, install [jq](https://jqlang.github.io/jq/download/) and add it to your `PATH`. \n\n\n2. **Open the project**\n\n    Navigate to [Example-App](Example-App), and open [Docs-Examples.xcodeproj](Example-App/Docs-Examples.xcodeproj).\n    \n    \u003e All dependencies are installed with Swift Package Manager,  and are fetched automatically by Xcode.\n\n3. **Update Signing**\n\n    As with any Xcode project, head to the target, \"Signing \u0026 Capabilities\", and add your team, and modify the bundle identifier to make it unique.\n\n4.  **Modify the project configuration**\n\n      The app loads connection parameters from the [`config.json`](./agora-manager/config.json) file. Ensure that the \n      file is populated with the required parameter values before running the application.\n   \n       - `uid`: The user ID associated with the application.\n         - `appId`: (Required) The unique ID for the application obtained from [Agora Console](https://console.agora.io). \n         - `channelName`: The default name of the channel to join.\n         - `rtcToken`:An token generated for `channelName`. You generate a temporary token using the [Agora token builder](https://agora-token-generator-demo.vercel.app/).\n         - `serverUrl`: The URL for the token generator. See [Secure authentication with tokens](authentication-workflow) for information on how to set up a token server.\n         - `tokenExpiryTime`: The time in seconds after which a token expires.\n   \n      If a valid `serverUrl` is provided, all samples use the token server to obtain a token except the **SDK quickstart** project that uses the `rtcToken`. If a `serverUrl` is not specified, all samples except **Secure authentication with tokens** use the `rtcToken` from `config.json`.\n\n5. **Build and run the project**\n\n   To build and run the project, use the build button (Cmd+R) in Xcode. Select your preferred device/simulator as the scheme.\n\n\n## Screenshots\n\n| Landing page | Call quality best practice | Custom video and audio sources | Screen share, volume control and mute |\n|:-:|:-:|:-:|:-:|\n| ![Landing page of the application](Example-App/Docs-Examples/Documentation.docc/Resources/media/landing-page.png) | ![Two streams and quality details in the top left of each stream](Example-App/Docs-Examples/Documentation.docc/Resources/media/ensure-channel-quality.png) | ![Custom camera using the ultra wide iPhone capture](Example-App/Docs-Examples/Documentation.docc/Resources/media/custom-video-and-audio.png) | ![Local and remote olume control + screen sharing option](Example-App/Docs-Examples/Documentation.docc/Resources/media/product-workflow.png) |\n\n## Contact\n\nIf you have any questions, issues, or suggestions, please file an issue in our [GitHub Issue Tracker](https://github.com/AgoraIO/video-sdk-samples-macos/issues).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-macos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-macos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-macos/lists"}