obs studio node

libobs melalui pengikatan simpul

Pustaka ini bermaksud untuk menyediakan pengikatan ke pustaka internal obs-studio, yang diberi nama libobs, untuk tujuan menggunakannya dari runtime node. Saat ini, hanya Windows dan MacOS yang didukung.

Bangunan

Prasyarat

Anda harus menginstal yang berikut ini:

• Git
• Node.js
• Benang
• CMembuat

jendela

Membangun di windows memerlukan perangkat lunak tambahan:

• Visual Studio 2019 atau 2022
• Windows SDK (dapat diinstal oleh Penginstal Visual Studio 2022)

Contoh Membangun

Kami menggunakan skrip cmake yang fleksibel agar seluas dan seumum mungkin untuk mencegah kebutuhan untuk terus-menerus mengelola skrip cmake untuk penggunaan khusus, sekaligus menyediakan default yang masuk akal. Ini mengikuti tata letak cmake yang cukup standar dan Anda dapat menjalankannya sesuka Anda.

Contoh:

 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

Ini akan mengunduh semua dependensi yang diperlukan, membangun modul, dan kemudian menempatkannya di arsip yang kompatibel dengan npm atau benang yang dapat Anda tentukan dalam package.json tertentu.

Pembuatan OBS Khusus

Secara default, kami mengunduh libobs versi bawaan jika tidak ada yang ditentukan. Namun, versi bawaan ini mungkin bukan yang ingin Anda gunakan atau mungkin Anda sedang menguji fitur obs baru.

Anda dapat menentukan arsip khusus Anda sendiri. Namun, beberapa perubahan perlu dilakukan pada konfigurasi default obs-studio sebelum membangun:

• ENABLE_SCRIPTING harus disetel ke false
• ENABLE_UI harus disetel ke false
• QTDIR tidak boleh ditentukan karena tidak digunakan.

Jika Anda tidak tahu cara membuat obs-studio dari sumber, Anda dapat menemukan petunjuknya di sini.

cppcheck

Instal cppcheck dari http://cppcheck.sourceforge.net/ dan tambahkan folder cppcheck ke PATH Untuk menjalankan pemeriksaan dari baris perintah:

 cd build 
cmake --build . --target CPPCHECK

Target juga dapat dibangun dari Visula Studio. Format keluaran laporan ditetapkan sebagai kompatibel dan navigasi ke file:baris mungkin dari panel hasil pembuatan.

Beberapa peringatan disembunyikan di file obs-studio-client/cppcheck_suppressions_list.txt dan obs-studio-server/cppcheck_suppressions_list.txt .

Penganalisis Dentang

Ninja dan LLVM harus diinstal di sistem. Peringatan: depot_tool telah merusak ninja.
Untuk membuat build terbuka 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

Langkah dengan "fixing" kesalahan penting karena basis kode dan terutama kode pihak ketiga belum siap untuk dibuat dengan dentang. Dan file yang gagal dikompilasi tidak akan dipindai untuk menemukan kesalahan.

Tes

Pengujian untuk node obs studio ditulis dalam TypeScript dan menggunakan Mocha sebagai kerangka pengujian, dengan paket elektron-mocha untuk membuat Mocha berjalan di Electron, dan Chai sebagai kerangka pernyataan.

Anda perlu membangun obs-studio-node untuk menjalankan pengujian. Anda dapat membuatnya sesuka Anda, pastikan untuk menggunakan CMAKE_INSTALL_PREFIX untuk menginstal obs-studio-node di folder pilihan Anda. Pengujian menggunakan variabel ini untuk mengetahui di mana modul obs-studio-node berada. Karena kita menggunakan fork Electron kita sendiri, Anda juga perlu membuat variabel lingkungan bernama ELECTRON_PATH yang menunjuk ke lokasi biner Electron di folder node_modules setelah Anda menjalankan yarn install . Berikut adalah tiga cara berbeda untuk membangun obs-studio-node:

Perintah terminal

Di folder root 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

Terminal menggunakan skrip package.json

Di folder root obs-studio-node:

1. mkdir build
2. yarn local:config
3. yarn local:build
4. Opsional: Untuk membersihkan folder build, ulangi langkah 2 hingga 3 lagi lakukan yarn local:clean

CMembuat GUI

1. yarn install
2. Buat folder build di root obs-studio-node
3. Buka CMake GUI
4. Letakkan jalur proyek obs-studio-node di kotak Where is the source code:
5. Letakkan path ke folder build di kotak Where to build the binaries:
6. Klik Configure
7. Ubah CMAKE_INSTALL_PREFIX ke jalur folder pilihan Anda
8. Klik Generate
9. Klik Open Project untuk membuka Visual Studio dan membangun proyek di sana

Menjalankan tes

Beberapa pengujian berinteraksi dengan Twitch dan kami menggunakan layanan kumpulan pengguna untuk mendapatkan pengguna, tetapi jika kami tidak dapat mengambil pengguna dari layanan tersebut, kami menggunakan kunci aliran yang disediakan oleh variabel lingkungan. Buat variabel lingkungan bernama SLOBS_BE_STREAMKEY dengan kunci streaming akun Twitch pilihan Anda.

• Untuk menjalankan semua pengujian, lakukan yarn run test
• Untuk menjalankan hanya menjalankan satu pengujian, lakukan yarn run test --grep describe_name_value dengan describe_name_value adalah nama pengujian yang diteruskan ke panggilan deskripsikan di setiap file pengujian. Contoh: yarn run test --grep nodeobs_api atau yarn run test -g "Start streaming"