{"id":20268632,"url":"https://github.com/agoraio/video-sdk-samples-unity","last_synced_at":"2025-08-17T01:33:44.337Z","repository":{"id":195812858,"uuid":"623044464","full_name":"AgoraIO/video-sdk-samples-unity","owner":"AgoraIO","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-20T18:12:05.000Z","size":197600,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-04T21:11:10.243Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-03T15:24:06.000Z","updated_at":"2024-07-27T00:25:24.000Z","dependencies_parsed_at":"2023-09-23T10:21:42.449Z","dependency_job_id":"a6bea68a-35f9-4762-b7b3-508fc84375ea","html_url":"https://github.com/AgoraIO/video-sdk-samples-unity","commit_stats":null,"previous_names":["agoraio/video-sdk-samples-unity"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AgoraIO/video-sdk-samples-unity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-unity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-unity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-unity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-unity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/video-sdk-samples-unity/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-unity/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270796217,"owners_count":24647319,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:09.262Z","updated_at":"2025-08-17T01:33:44.313Z","avatar_url":"https://github.com/AgoraIO.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agora Video SDK for Unity reference game\n\nThis app demonstrates use of [Agora's Video SDK](https://docs.agora.io/en/video-calling/get-started/get-started-sdk) for real-time audio and video communication. It is a robust and comprehensive documentation reference app for Android, designed to enhance your productivity and understanding. It's built to be flexible, easily extensible, and beginner-friendly.\n\nClone the repo, run and test the samples, and use the code in your own project. Enjoy.\n\n- [Samples](#samples)\n- [Prerequisites](#prerequisites)\n- [Run this project](#run-this-project)\n- [Contact](#contact)\n\n## Samples  \n\nThis reference app includes several samples that illustrate the functionality and features of Agora Video and Voice SDKs. Each sample is self-contained and the relevant code can be found in its own folder in the root directory. For more information about each sample, see:\n\n**Get Started**\n\n- [SDK quickstart](./Assets/get-started) - the minimum code you need to integrate low-latency, high-concurrency\n  video calling features into your app using Agora Video SDK.\n- [Secure authentication with tokens](./Assets/authentication-workflow/) - quickly set up an authentication token \n  server, retrieve\n  a token from the server, and use it to connect securely to the SD-RTN server as a specific user.\n\n**Develop**\n\n- [Call quality best practice](./Assets/ensure-call-quality/) - ensure optimal audio and video quality in your game.\n\n- [Connect through restricted networks with Cloud Proxy](./Assets/cloud-proxy/) - ensure reliable connectivity for \n  your users when they connect from an\n  environment with a restricted network.\n\n- [Secure channel encryption](./Assets/media-stream-encryption/) - integrate built-in data encryption into your app \n  using Video SDK.\n\n- [Stream media to a channel](./Assets/play-media/) - play video and audio files during online social and business interactions.\n\n- [Screen share, mute, and volume control](./Assets/product-workflow/productWorkflowManager.cs) - Implement a simple workflow in your game.\n\n- [Raw video and audio processing](./Assets//raw-audio-and-video/RawAudioVideo.cs) - Pre-process and post-process the captured audio and video data for implementation of custom playback effects.\n\n- [Custom video and audio sources](./Assets/custom-audio-and-video/CustomAudioAndVideo.cs) - Integrate a custom audio or video source into your app.\n\n- [Live streaming over multiple channels](./Assets/live-streaming-over-multiple-channels/multiChannelLiveStreamingManager.cs) - Stream media to multiple channels.\n\n\n**Integrate Features**\n\n- [Audio and voice effect](./Assets/audio-and-voice-effects) - Implement different audio and voice effect features.\n\n- [Spatial Audio](./Assets/spatial-audio/spatialAudioManager.cs) - 3D Spatial Audio enhances your real-time interaction experience with immersive sound, making it feel like sound is all around.\n\n- [Virtual Background](./Assets/virtual-background/virtualBackground.cs) - Blur the background or replace it with a solid color or an image.\n\n- [Geofencing](./Assets/geofencing/geofencing.cs) - Control and customize data routing in your \n\n\n## Prerequisites\n\nBefore getting started with this reference app, ensure you have the following set up:\n\n- [Unity Hub](https://unity.com/download)\n- [Unity Editor 2017.X LTS or higher](https://unity.com/releases/editor/archive)\n- Microsoft Visual Studio 2017 or higher\n\n## Run this project\n\nTo run the sample game, take the following steps:\n\n1. **Clone the repository**\n\n    To clone the repository to your local machine, open Terminal and navigate to the directory where you want to clone the repository. Then, use the following command:\n\n    ```bash\n    git https://github.com/AgoraIO/video-sdk-samples-unity.git\n    ```\n\n1. **Open the project**   \n\n    1. In Unity Hub, Open `video-sdk-samples-unity`, Unity Editor opens the project.\n       \n       Unity Editor warns of compile errors. Don't worry, you fix them when you import Video SDK for Unity. \n\n    1. Go `Assets\\Scenes`, and open `SampleScene.unity`. The sample scene opens.\n         \n    1. Unzip [the latest version of the Agora Video SDK](https://docs.agora.io/en/sdks?platform=unity) to a local folder.\n\n   1. In **Unity**, click **Assets** \u003e **Import Package** \u003e **Custom Package**.\n\n   1. Navigate to the Video SDK package and click **Open**.\n\n   1. In **Import Unity Package**, click **Import**.\n   \n      Unity recompiles the Video SDK samples for Unity and the warnings disappear. \n\n1. **Modify the project configuration**\n\n   The app loads connection parameters from [`./Assets/agora-manager/config.json`](./Assets/agora-manager/config.json)\n   . Ensure that the 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    - `token`: 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\n1. **Build and run the project**\n\n    In **Unity Editor**, click **Play**. A moment later you see the game running on your development device.\n1. **Run the samples in the reference app**\n\n   Choose a sample code from the dropdown that you wish to execute.\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-unity/issues).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-unity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-unity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-unity/lists"}