lenn/srs
1
0
Fork 0
mirror of https://github.com/ossrs/srs.git synced 2025-11-23 19:34:05 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
5a404c089baa93b906d2452ef47e2ba8a9e6211c
srs/.vscode/README.md
winlin 5a404c089b VSCode: Support debug and run utest in VSC.
2025-05-28 18:38:56 -04:00

2.7 KiB
Raw Blame History

Debug with VSCode

Support run and debug with VSCode.

macOS: SRS Server

Install the following extensions:

  • CMake Tools
  • CodeLLDB
  • C/C++ Extension Pack

Open the folder like $HOME/git/srs in VSCode, after you clone srs to $HOME/git/srs directory.

Run commmand to configure the project by pressing Command+Shift+P, then type CMake: Configure then select Clang as the toolchain. Or run the command manually in terminal:

cmake -S $HOME/git/srs/trunk/ide/srs_clion -B $HOME/git/srs/trunk/ide/vscode-build

Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed.

Note: Make sure you have xcode installed, and run xcode-select --install to setup the toolchains.

Note: The settings.json is used to configure the cmake. It will use $HOME/git/srs/trunk/ide/srs_clion/CMakeLists.txt and $HOME/git/srs/trunk/ide/vscode-build as the source file and build directory.

Click the Run > Run Without Debugging or Run > Start Debugging from menu to start or debug the server. It will invoke the build task defined in tasks.json, or you can run it manually:

cmake --build $HOME/git/srs/trunk/ide/vscode-build

Note: The launch.json is used for running and debugging. The build will output the binary to $HOME/git/srs/trunk/ide/vscode-build/srs.

macOS: SRS UTest

Install the following extensions:

  • C++ TestMate

Open the folder like $HOME/git/srs in VSCode, after you clone srs to $HOME/git/srs directory.

Run commmand to configure the project by pressing Command+Shift+P, then type CMake: Configure then select Clang as the toolchain. Or run the command manually in terminal:

cmake -S $HOME/git/srs/trunk/ide/srs_clion -B $HOME/git/srs/trunk/ide/vscode-build

Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed.

Afterwards, build the utest by pressing Command+Shift+P, then type CMake: Build to run the build command. It will invoke the build task defined in tasks.json, or you can run it manually:

cmake --build $HOME/git/srs/trunk/ide/vscode-build

Then you will discover all the unit testcases from the View > Testing panel. You can open utest source file like trunk/src/utest/srs_utest.cpp, then click the Run Test or Debug Test on each testcase such as FastSampleInt64Test.

macOS: Proxy

Install the following extensions:

  • Go

Open the folder like ~/git/srs in VSCode.

Click the View > Run and select Launch srs-proxy to start the proxy server.

Click the Run > Run Without Debugging button to start the server.

Note: The launch.json is used for running and debugging.