obs studio node

透過節點綁定的 libobs

該庫旨在提供對 obs-studio 內部庫的綁定，相應地命名為 libobs，以便從節點運行時使用它。目前僅支援 Windows 和 MacOS。

大樓

先決條件

您需要安裝以下內容：

• git
• Node.js
• 紗
• CMake

視窗

在 Windows 上建置需要額外的軟體：

• Visual Studio 2019 或 2022
• Windows SDK（可由 Visual Studio 2022 安裝程式安裝）

範例建構

我們使用盡可能廣泛且通用的靈活 cmake 腳本，以避免需要不斷管理 cmake 腳本以供自訂使用，同時也提供合理的預設值。它遵循相當標準的 cmake 佈局，您可以根據需要執行它。

例子：

 yarn install
git submodule update --init --recursive
mkdir build
cd build
cmake .. -G"Visual Studio 17 2022" -A x64 -DCMAKE_PREFIX_PATH=%CD%/libobs-src/cmake/
cmake --build . --target install --config RelWithDebInfo

這將下載任何所需的依賴項，建立模組，然後將其放入與您在給定 package.json 中指定的 npm 或 yarn 相容的檔案中。

自訂 OBS 構建

預設情況下，如果未指定，我們會下載 libobs 的預先建置版本。但是，這個預建版本可能不是您想要使用的版本，或者您可能正在測試新的 obs 功能。

您可以指定您自己的自訂存檔。不過，在建置之前需要對 obs-studio 的預設配置進行一些更改：

• ENABLE_SCRIPTING必須設定為false
• ENABLE_UI必須設定為false
• 不應指定QTDIR ，因為它未被使用。

如果您不知道如何從原始程式碼建立 obs-studio，您可以在此處找到說明。

程式檢查

從 http://cppcheck.sourceforge.net/ 安裝 cppcheck 並將 cppcheck 資料夾新增至 PATH 若要從命令列執行檢查：

 cd build 
cmake --build . --target CPPCHECK

也可以從 Visula Studio 建置目標。報告輸出格式設定為相容，並可從建置結果面板導覽至檔案：行。

檔案obs-studio-client/cppcheck_suppressions_list.txt和obs-studio-server/cppcheck_suppressions_list.txt中抑制了一些警告。

鏗鏘分析器

系統中必須安裝Ninja和LLVM 。警告：depot_tool 已損壞 ninja。
要進行構建，請開啟cmd.exe 。

 mkdir build_clang
cd build_clang

"c:Program Files (x86)Microsoft Visual Studio 14.0VCbinamd64vcvars64.bat"
 
set CCC_CC=clang-cl
set CCC_CXX=clang-cl
set CC=ccc-analyzer.bat
set CXX=c++-analyzer.bat
#set CCC_ANALYZER_VERBOSE=1

#make ninja project 
cmake  -G "Ninja" -DCLANG_ANALYZE_CONFIG=1 -DCMAKE_INSTALL_PREFIX:PATH=""  -DCMAKE_LINKER=lld-link -DCMAKE_BUILD_TYPE="Debug"   -DCMAKE_SYSTEM_NAME="Generic" -DCMAKE_MAKE_PROGRAM=ninja.exe ..

#try to build and "fix" errors 
ninja.exe 

#clean build to scan 
ninja.exe clean 

scan-build --keep-empty -internal-stats -stats -v -v -v -o check ninja.exe

"fixing"錯誤的步驟很重要，因為程式碼庫，尤其是第三方程式碼還沒有準備好使用 clang 建置。編譯失敗的檔案將不會被掃描以查找錯誤。

測試

obs studio 節點的測試是用 Typescript 編寫的，並使用 Mocha 作為測試框架，使用 electro-mocha 套件使 Mocha 在 Electron 中運行，並使用 Chai 作為斷言框架。

您需要建置 obs-studio-node 才能執行測試。您可以以任何您想要的方式建置它，只需確保使用CMAKE_INSTALL_PREFIX將 obs-studio-node 安裝在您選擇的資料夾中。測試使用此變數來了解 obs-studio-node 模組的位置。由於我們使用自己的 Electron 分支，因此您還需要建立一個名為ELECTRON_PATH環境變量，該變數在執行yarn install後指向 Electron 二進位檔案在 node_modules 資料夾中的位置。以下是建構 obs-studio-node 的三種不同方法：

終端命令

在 obs-studio-node 根資料夾中：

1. yarn install
2. git submodule update --init --recursive --force
3. mkdir build
4. cmake -Bbuild -H. -G"Visual Studio 16 2019" -A x64 -DCMAKE_INSTALL_PREFIX="path_of_your_choosing"
5. cmake --build build --target install

使用 package.json 腳本的終端

在 obs-studio-node 根資料夾中：

1. mkdir build
2. yarn local:config
3. yarn local:build
4. 可選：要清理建置資料夾，請再次重複步驟 2 到 3 執行yarn local:clean

圖形化介面

1. yarn install
2. 在 obs-studio-node 根目錄中建立建置資料夾
3. 打開 CMake 圖形使用者介面
4. 將 obs-studio-node 專案路徑放入Where is the source code:框中
5. 將建置資料夾的路徑放入Where to build the binaries:方塊中
6. 按一下Configure
7. 將 CMAKE_INSTALL_PREFIX 變更為您選擇的資料夾路徑
8. 點擊Generate
9. 按Open Project以開啟 Visual Studio 並在其中建置專案

運行測試

一些測試與 Twitch 交互，我們使用用戶池服務來獲取用戶，但如果我們無法從中獲取用戶，我們將使用環境變數提供的流密鑰。使用您選擇的 Twitch 帳戶的流密鑰建立一個名為 SLOBS_BE_STREAMKEY 的環境變數。

• 若要執行所有測試，請執行yarn run test
• 若要只執行一個測試，請執行yarn run test --grep describe_name_value ，其中describe_name_value是傳遞給每個測試檔案中的describe所呼叫的測試的名稱。範例： yarn run test --grep nodeobs_api或yarn run test -g "Start streaming"