windows

API Example Windows

English | 中文

Overview

This repository contains sample projects using the Agora RTC C++ SDK for Windows.

Project structure

The project uses a single program to combine a variety of functionalities. Each function is loaded as a window for you to play with.

Function	Location
Live streaming	LiveBroadcasting.h/cpp
Audio effect	CAgoraEffectDlg.h/cpp
Audio mixing	CAgoraAudioMixingDlg.h/cpp
Set audio profile	CAgoraAudioProfile.h/cpp
Set audio volume	CAgoraAudioVolumeDlg.h/cpp
Video enhancement	CAgoraBeautyDlg.h/cpp
Audio enhancement	CAgoraBeautyAudio.h/cpp
Channel media relay	CAgoraCrossChannelDlg.h/cpp
Custom audio capture	CAgoraCaptureAudioDlg.h/cpp
Custom media encryption	CAgoraCustomEncryptDlg.h/cpp
Custom Video capture (push)	CAgoraCaptureVideoDlg.h/cpp
SDK media encryption	CAgoraMediaEncryptDlg.h/cpp
Custom Video capture (mediaIO)	CAgoraMediaIOVideoCaptureDlg.h/cpp
Media player (Agora Media Player Kit)	CAgoraMediaPlayer.h/cpp
Join multiple channels	CAgoraMultiChannelDlg.h/cpp
Publish camera and screen capture video via multiprocessing	CAgoraMultiVideoSourceDlg.h/cpp
Raw audio source	CAgoraOriginalAudioDlg.h/cpp
Raw video source	CAgoraOriginalVideoDlg.h/cpp
Pre-call test	CAgoraPreCallTestDlg.h/cpp
Regional connection	CAgoraRegionConnDlg.h/cpp
In call report	CAgoraReportInCallDlg.h/cpp
RTMP streaming	AgoraRtmpStreaming.h/cpp
Screen capture	AgoraScreenCapture.h/cpp
Video metatdata	CAgoraMetaDataDlg.h/cpp
Video profile	CAgoraVideoProfileDlg.h/cpp

How to run the sample project

Prerequisites

• The default Visual Studio version for this project is 2017. If you are using other versions of Visual Studio, you may need additional adjustments.
• Windows 7 or higher. If you use Windows XP, you also need to install plugins for Windows XP compatibility when compiling the Release version.

Steps to run

1. Navigate to the windows folder and run following command to install project dependencies:

   $ installThirdParty.bat

   Note: If you encounter ps1 script errors, you may need to update your powershell.

2. Open the APIExample.sln file with Visual Studio.

3. Edit the stdafx.h file. Enter your App ID and token.

   #define APP_ID     "<enter your agora app id>"
   
   
   #define APP_TOKEN  ""

   See Set up Authentication to learn how to get an App ID and access token. You can get a temporary access token to quickly try out this sample project.

   The Channel name you used to generate the token must be the same as the channel name you use to join a channel.

   To ensure communication security, Agora uses access tokens (dynamic keys) to authenticate users joining a channel.

   Temporary access tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating access tokens. See Generate a Token for details.

4. Select x86 as the platform version. Build and run the solution in your Windows device.

You are all set! Feel free to play with this sample project and explore features of the Agora RTC SDK.

Feedback

If you have any problems or suggestions regarding the sample projects, feel free to file an issue.

Reference

• RTC C++ SDK Product Overview
• RTC C++ SDK API Reference

Related resources

• Check our FAQ to see if your issue has been recorded.
• Dive into Agora SDK Samples to see more tutorials
• Take a look at Agora Use Case for more complicated real use case
• Repositories managed by developer communities can be found at Agora Community
• If you encounter problems during integration, feel free to ask questions in Stack Overflow

License

The sample projects are under the MIT license. See the LICENSE file for details.