streamdeck

دفق سطح السفينة SDK

مرحبًا بك في Dream Deck SDK - المصمم لإنشاء مكونات إضافية لسهولة Deck Deck ، يوفر Dream Deck SDK كل ما تحتاجه للاتصال والتواصل مع تطبيق Dream Deck ، مما يتيح لك التركيز على الأشياء الممتعة.

يتطلب إنشاء المكونات الإضافية Dream Deck باستخدام node.js node.js v20. عند تثبيت Node.js ، أوصينا باستخدام مدير الإصدار مثل NVM (MACOS) أو NVM-Windows (Windows).

بداية سريعة

يوفر Dream Deck CLI أوامر لإنشاء واختبار وتجميع المكونات الإضافية الخاصة بك ، وهي أسهل طريقة للبدء في بناء Dream Deck. يمكنك أيضًا معرفة المزيد عن البدء في وثائقنا.

1. مع تثبيت Node.js ، قم بتثبيت CLI.

npm install -g @elgato/cli@latest

2. بمجرد التثبيت ، قم بتشغيل الأمر create لتهيئة معالج الإنشاء.

streamdeck create

بنية الملف

بعد إنشاء مكون إضافي مع streamdeck create ، سيتم تزويدك ببيئة محلية لبناء مكون إضافي.

 /
├── *.sdPlugin/
│   ├── bin/
│   ├── imgs/
│   ├── logs/
│   ├── ui/
│   │   └── increment-counter.html
│   └── manifest.json
├── src/
│   ├── actions/
│   │   └── increment-counter.ts
│   └── plugin.ts
├── package.json
├── rollup.config.mjs
└── tsconfig.json

يوفر package.json نصين لإنشاء المكون الإضافي.

• npm run build - يبني البرنامج المساعد.
• npm run watch - يشاهد بشكل مستمر للتغييرات ، والتحويلات الساخنة المكون الإضافي بعد الإنشاء.

؟ ️ الإجراءات

الإجراءات هي نجم العرض وتمكين المستخدمين من التفاعل مع البرنامج المساعد الخاص بك. يتم تمثيل الإجراءات كطبقات ترث من SingletonAction ، مما يتيح المكون الإضافي الخاص بك لتلقي الأحداث من Dream Deck ، على سبيل المثال أسفل المفتاح ، Dial ، إلخ.

فيما يلي مثال على إجراء يستمع لحدث keyDown ، ثم يحدد عنوان الإجراء المصدر.

 import { action , KeyDownEvent , SingletonAction } from "@elgato/streamdeck" ;

@ action ( { UUID : "com.elgato.hello-world.say-hello" } )
export class SayHelloAction extends SingletonAction {
    /**
     * Listen for the key down event that occurs when a user presses
     * a Stream Deck button, and change the title of the action.
     */
    async onKeyDown ( ev : KeyDownEvent ) {
        await ev . action . setTitle ( "Hello world" ) ;
    }
} 

؟ تصحيح الأخطاء

يمكن تصحيح المكونات الإضافية باستخدام أي مصحح node.js ، على سبيل المثال رمز Visual Studio ، Chrome ، وما إلى ذلك ، وسيتم تمكين تصحيح الأخطاء بشكل افتراضي عند إنشاؤه باستخدام أمر CLI streamdeck create CLE.

يمكنك تكوين تصحيح الأخطاء ضمن تكوين العقد.

 {
    // ...
    "Nodejs" : {
        "Version" : "20" ,
        "Debug" : "enabled"
    } ,
}

هناك أربعة خيارات متاحة عند تكوين خاصية Debug ضمن البيان:

• "enabled" -سيتم تشغيل المكون الإضافي مع --inspect يسمح للتصحيح بالاتصال.
• "break" -سيتم إطلاق المكون الإضافي مع --inspect-brk وسينتظر توصيل الأخطاء قبل الجري.
• string - مجموعة من وسيطات CLI التي توفرها المكون الإضافي.
• undefined - تصحيح الأخطاء معاق.

عند تشغيل المكون الإضافي إما وضع التصحيح "enabled" أو "break" ، سيتم تخصيص منفذ متاح عشوائي لمستمع التصحيح في كل مرة يتم فيها تشغيل البرنامج المساعد. إذا كنت ترغب في الاستماع إلى منفذ معين ، فيمكن تعيين قيمة Debug على سلسلة من وسيط CLI ، على سبيل المثال للاستماع إلى المنفذ 12345 ، ستكون قيمة Debug --inspect=127.0.0.1:12345 .

مزيد من القراءة

• إجراء تغييراتك الأولى.
• تعرف على إجراءات المفتاح والاتصال.
• فهم بيانات تعريف البرنامج المساعد الخاص بك ضمن ملف JSON البيان
• قم بتجميع البرنامج المساعد الخاص بك للتوزيع.
• استكشف عينات المكون الإضافي لتدفق Dream Deck