Event Master Devices - Event Master series processor وحدة التحكم عن بُعد JSON RPC

B.2 Event Master series processor وحدة التحكم عن بُعد JSON RPC

بشكل عام

JSON (تدوين كائن JavaScript) هو تنسيق خفيف الوزن يُستخدم لتبادل البيانات. يستند إلى مجموعة فرعية من لغة JavaScript: الطريقة التي يتم بها إنشاء الكائنات في JavaScript.

مقدمة إلى JSON

تم إنشاء JSON على هيكلين:

مجموعة من أزواج الأسماء/القيمة: بلغات مختلفة، يتم تحقيق ذلك ككائن أو سجل أو هيكل أو قاموس أو جدول تجزئة أو قائمة ذات مفاتيح أو مصفوفة ترابطية.
قائمة مرتبة من القيم: في معظم اللغات، يتم تحقيق ذلك كمصفوفة أو متجه أو قائمة أو تسلسل.

فيما يلي مثال على بيانات JSON:

{
     "firstName": "John",
     "lastName": "Smith",
     "address": {
         "streetAddress": "21 2nd Street",
         "city": "New York",
         "state": "NY",
         "postalCode": 10021
     },
     "phoneNumbers": [
         "212 555-1234",
         "646 555-4567"
     ]
 }

كيف يتفاعل JSON مع معالجات Event Master

يقوم JSON باستخدام JSON RPC (مستند إلى REST) للتفاعل مع معالجات Event Master مثل E2 وS3–4K وEX. JSON-RPC هو بروتوكول استدعاء إجراء بعيد تم ترميزه في JSON.

يعمل JSON-RPC من خلال إرسال طلب إلى خادم يقوم بتنفيذ هذا البروتوكول. العميل في هذه الحالة هو عادةً برنامج ينوي استدعاء طريقة واحدة لنظام بعيد. يمكن تمرير معلّمات الإدخال المتعددة إلى الطريقة البعيدة كمصفوفة أو كائن، بينما يمكن للطريقة نفسها إرجاع بيانات مخرجات متعددة أيضًا.

يتم تحديد JSON RPCs لأداء المهام على معالج Event Master. يحتاج المستخدم إلى إرسال طلب JSON من خلال تطبيقه أو تطبيقات مفتوحة المصدر.

يجب أن ترسل هذه التطبيقات طلبًا على IP حيث يتم تشغيل معالج Event Master والمنفذ الثابت 9999 (خادم الويب الخاص بمعالج Event Master يعمل على المنفذ 9999).

استخدم JSON من تطبيق الويب

لاستخدام واجهات برمجة تطبيقات JSON من تطبيق الويب، حدد رمز الإعدادات على شريط تنقل القائمة، وحدد واجهة برمجة تطبيقات JSONRPC من لوحة معلومات تطبيق الويب.

واجهات برمجة تطبيقات JSON

فيما يلي بعض واجهات برمجة تطبيقات JSON المحددة للتحكم في معالج Event Master. إذا كان لديك إعداد Event Master رئيسي / فرعي، فيجب إرسال JSON إلى الوحدة الرئيسية. بالنسبة لكافة الطلبات، يوضح هذا القسم المعلّمة التي تم تمريرها أو استخدامها في استدعاءات RPC. إذا كان كائن المعلّمات فارغًا، فهذا يعني أن واجهة برمجة التطبيقات لا تتطلب معلّمة.

ملاحظة: الطلبات حساسة لحالة الأحرف.

allTrans

التعريف:
- يقوم بتنفيذ الأمر "allTrans".
الطلب:
- المعلّمات {} - لا يتطلب أي معلّمة.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{}, "method":"allTrans", "id":"1234", "jsonrpc":"2.0"}

cut (قطع)

التعريف:
- يقوم بتنفيذ الأمر "Cut".
الطلب:
- المعلّمات {} - لا يتطلب أي معلّمة.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{}, "method":"cut", "id":"1234", "jsonrpc":"2.0"}

resetFrameSettings

التعريف:
- كشف جميع أنواع إعادة التعيين على معالج Event Master بخيارات مختلفة.
الطلب:
- المعلّمات: {"reset":x},
  "x" يمكن أن تكون 0 – 5
  - 0: إعادة ضبط سهلة.
  - 1: إعادة ضبط المصنع.
  - 2: إعادة ضبط المصنع (حفظ IP).
  - 3: إعادة ضبط المصنع (حفظ IP/EDID).
  - 4: إعادة ضبط المصنع (حفظ VPID).
  - 5: انقطاع التيار الكهربائي.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{"reset": 0}, "method":"resetFrameSettings", "id":"1234", "jsonrpc":"2.0"}

powerStatus

التعريف:
- هذا يستعلم عن حالة قابس الطاقة لمعالج Event Master. (يمكن أن يكون هناك فتحة أو فتحتي طاقة في معالج Event Master).
الطلب:
- المعلّمات {} - لا يتطلب أي معلّمة.
الاستجابة:
- الاستجابة: {FrameId1 :{ PwrStatus1, PwrStatus2},{FrameId2 :{ PwrStatus1, PwrStatus2}
  يعطي PwrStatus1 حالة الطاقة للفتحة الأولى في معالج Event Master مع معرّف الإطار FrameId1، وFrameId2.
  يعطي PwrStatus2 حالة الطاقة للفتحة الثانية في معالج Event Master مع معرّف الإطار FrameId1، وFrameId2.
  - 0: وحدة الإمداد بالطاقة غير موجودة.
  - 1: وحدة الإمداد بالطاقة موجودة، لكن لا يوجد كبل طاقة.
  - 2: وحدة الإمداد بالطاقة موجودة، والكبل متصل، لكن لا يوجد تيار مباشر.
  - 3: وحدة الإمداد بالطاقة موجودة، وكل شيء على ما يرام.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{}, "method":"powerStatus", "id":"1234", "jsonrpc":"2.0"}

listPresets

التعريف:
- يستعلم هذا عن قائمة التعيينات المسبقة على وجهة معينة أو على النظام.
الطلب:
- المعلّمات: {"ScreenDest":x , "AuxDest":x},
  "x" يمكن أن تكون:
  - –2: لا تقم بتضمين أي وجهات من هذا النوع. (له الأولوية على معرّف معين، إذا تم تمريره كمعلّمة.)
  - –1: عدم الاهتمام (كافة التعيينات المسبقة). (له الأولوية على معرّف معين، إذا تم تمريره كمعلّمة.)
  - 0–999: تريد أن ترى التعيينات المسبقة مع الوجهة هذا المعرّف المحدد فيها أو مجموعة من المعرّفات. مثال. "ScreenDestination":[{"id": 2}, {"id": 3}]
الاستجابة:
- الاستجابة: مجموعة من: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":
  3.00}, {"id": 1, "Name": "Preset4.00", "LockMode": 0, "presetSno": 4.00}]
  - تحتوي الاستجابة على مجموعة من التعيينات المسبقة. تحتوي الاستجابة أعلاه على المعرّف والاسم والرقم المسلسل المحدد مسبقًا لوضع القفل لجميع التعيينات المسبقة.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{"ScreenDest": 0}, "method":"listPresets", "id":"1234", "jsonrpc":"2.0"}

listDestinationsForPreset

التعريف:
- يسرد محتوى تعيين مسبق.
الطلب:
- المعلّمات: {"id":x },
  "x" يمكن أن تكون:
  - –1: ضع قائمة بجميع الإعدادات المسبقة.
  - 0–999: سرد هذا التعيين المسبق المحدد فقط.
الاستجابة:
- الاستجابة: مجموعة من: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno":
  3.00, "ScreenDest":[{"id": 0}, {"id": 3}],"AuxDest":[{"id": 0},
  {"id": 1}]}]
  - تحتوي الاستجابة على مجموعة من التعيينات المسبقة.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- { "params":{"id": 0}, "method":"listDestinationsForPreset", "id":"1234",
  "jsonrpc":"2.0"}

savePreset

التعريف:
- ينشئ تعيينًا مسبقًا على معالج Event Master.
الطلب:
- المعلّمات: {"presetName": "NewPreset", "ScreenDestination":[{"id": 2}, {"id": 3}],
  "AuxDestination":[{"id": 1}, {"id": 2}]}
  - "presetName" —اسم التعيين المسبق المطلوب حفظه.
  - ScreenDestinations—معرّف ScreenDest للإعداد المسبق المطلوب إنشاؤه.
  - AuxDestinations—معرّف AuxDest للإعداد المسبق المطلوب إنشاؤه.
  - ScreenDestination وAuxDestinations هما معلّمات اختيارية. إذا لم يقدمها المستخدم، فسيتم حفظ التعيين المسبق للوجهات المحددة.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"presetName": "NewPreset"}, "method":"savePreset", "id":"1234",
  "jsonrpc":"2.0"}
- {"params": {"presetName": "NewPreset", "ScreenDestination":
  {"id": 0},"AuxDestination":{"id": 0}}, "method":"savePreset", "id":"1234",
  "jsonrpc":"2.0"}
النقاط الرئيسية المتعلقة بالتعيين المسبق، والتي هي نفسها لإعادة التسمية والتنشيط والحذف:
- "id"—معرّف التعيين المسبق.
- "presetSno"—الرقم المسلسل المحدد مسبقًا. يمكن للمستخدم توفير رقم النقطة العائمة إذا لزم الأمر. مثال. "presetSno": 1.01 ،"presetSno": 1.00 ،"presetSno": 1 ،"presetSno": 1.1 ،"presetSno": 1.10.
  يُرجى ملاحظة أن 1.1 و1.10 أو 1.00 و1 متماثلان.
- "presetName" —اسم التعيين المسبق.

renamePreset

التعريف:
- إعادة تسمية تعيين مسبق على معالج Event Master. يمكن للمستخدم إعادة تسمية تعيين مسبق بالمعرّف أو الرقم المسلسل المحدد مسبقًا أو اسم التعيين المسبق.
- أرسِل أيًا من المعلّمات لإعادة تسمية التعيين المسبق.
طلب المعلّمات:
- المعلّمات: {"id": x, "newPresetName": "NewPresetName"}
- المعلّمات: {"presetSno": x.y, "newPresetName": "NewPresetName"}
- المعلّمات: {"presetName": "OldPresetName", "newPresetName": "NewPresetName"}
  - "newPresetName"—اسم تعيين مسبق جديد لتعيينه.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 0, "newPresetName": " newPresetName "},
  "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"presetName": "NewPreset", "newPresetName": "NewPresetName"},
  "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"presetSno": 1.00, "newPresetName": " newPresetName "},
  "method":"renamePreset", "id":"1234", "jsonrpc":"2.0"}

activatePreset

التعريف:
- استدعاء تعيين مسبق على معالج Event Master. يمكن للمستخدم استدعاء تعيين مسبق بالمعرّف أو الرقم المسلسل المحدد مسبقًا أو اسم التعيين المسبق.
- أرسِل أيًا من المعلّمات لاستدعاء التعيين المسبق.
طلب المعلّمات:
- المعلّمات: {"id": x, "type": x}
- المعلّمات: {"presetSno": x.y, "type": x}
- المعلّمات: {"presetName": "PresetName"}
  - "النوع"—0 للاستدعاء في المعاينة (افتراضي)، 1 للاستدعاء في البرنامج.
    هذه ليست معلّمة إلزامية ولكن يجب تقديمها عندما يريد المستخدم استدعاء تعيين مسبق في البرنامج.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 0, "type": 0}, "method":"activatePreset",
  "id":"1234", "jsonrpc":"2.0"} //Recall in preview with id 0.
- {"params": {"presetName": "abc" }, "method":"activatePreset",
  "id":"1234", "jsonrpc":"2.0"} //Recall in preview with preset name "abc".
- {"params": {"presetSno": 1.00, "type": 1}, "method":"activatePreset",
  "id":"1234", "jsonrpc":"2.0"} //Recall in program with presetSno 1.

recallNextPreset

التعريف:
- استدعاء التعيين المسبق التالي على معالج Event Master.
  لا توجد معلّمة مطلوبة.
- تأكد من أن المستخدم قد استدعى على الأقل تعيينًا مسبقًا واحدًا. يستدعي تطبيق الويب التعيين المسبق التالي من آخر تعيين مسبق تم استدعاؤه.
الطلب:
- المعلّمات: {}
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
- يظهر خطأ إذا لم يكن هناك آخر تعيين مسبق تم استدعاؤه أو إذا لم يكن هناك تعيين مسبق تالٍ في القائمة.
مثال:
- {"params": {}, "method":"recallNextPreset", "id":"1234", "jsonrpc":"2.0"}

deletePreset

التعريف:
- احذف تعيينًا مسبقًا على معالج Event Master.
  يمكن للمستخدم حذف تعيين مسبق بالمعرّف أو الرقم المسلسل المحدد مسبقًا أو اسم التعيين المسبق.
- أرسِل أيًا من المعلّمات لحذف التعيين المسبق.
الطلب:
- المعلّمات: {"id": x}
- المعلّمات: {"presetSno": x.y}
- المعلّمات: {"presetName": "PresetName"}
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 1}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"presetSno": 1.00}, "method":"deletePreset", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"presetName": "Preset 5.00"}, "method":"deletePreset",
  "id":"1234", "jsonrpc":"2.0"}

listDestinations

التعريف:
- تسرد واجهة برمجة التطبيقات هذه كافة الوجهات بخصائص مثل الطبقات والمخرجات والمعرّف والحجم والاسم.
الطلب:
- المعلّمات: {"type": x}
  - 0—عرض كل الوجهات.
    0 هي القيمة الافتراضية لمعلّمة النوع.
  - 1—وجهات الشاشة فقط.
  - 2—الوجهات المساعدة فقط.
الاستجابة:
- الاستجابة: مجموعة من: {"ScreenDestination":[{"id": 0, "Name": "Dest1", "HSize": 3840,
  "VSize": 1080, "Layers": 1,"DestOutMapColl":[{"id": 0"DestOutMap":[{"id":
  0, "Name": "Out1", "HPos": 0, "VPos": 0, "HSize": 1920, "VSize":1080,
  "Freeze": 0},{"id": 1, "Name": "Out2", "HPos": 1920, "VPos": 0,
  "HSize": 1920, "VSize":1080, "Freeze": 1}]}]}],"AuxDestination":
  [{"id": 0, "AuxStreamMode": 4}, {"id": 1, "AuxStreamMode": 4}]}"
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"type": 0}, "method":"listDestinations", "id":"1234", "jsonrpc":"2.0"}

listSources

التعريف:
- تسرد واجهة برمجة التطبيقات هذه كافة مصادر الإدخال بالخصائص.
الطلب:
- المعلّمات: {"type": x}
  - 0—عرض كافة مصادر الإدخال.
    0 هي القيمة الافتراضية لمعلّمة النوع.
  - 1—مصادر الخلفية فقط.
الاستجابة:
- الاستجابة: مجموعة من: {"id": 0, "Name": "InSource1", "HSize": 3840, "VSize": 1080,
  "SrcType": 0, "InputCfgIndex": -1, "StillIndex": 0, "DestIndex": -1,
  "UserKeyIndex": -1, "Mode3D": 0, "Freeze": 1, "Capacity": 2,
  "InputCfgVideoStatus": 4}
  SrcType: 0 = Input، 1 = StillStore
  InputCfgVideoStatus: حالة إدخال الفيديو
  - 0 = غير صالح؛ هناك مزامنة، لكن لا يمكن الحصول عليها / قفلها
  - 1 = صالح؛ الفيديو على ما يرام
  - 2 = تنسيق غير متطابق؛ عدم تطابق التنسيق بين cfg للإدخال والموصِل (الموصلات)
  - 3 = خارج النطاق؛ سعة الموصِل منخفضة للغاية للحصول على التنسيق
  - 4 = لا توجد مزامنة؛ لا يوجد فيديو
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"type": 0}, "method":"listSources", "id":"1234", "jsonrpc":"2.0"}

listContent

التعريف:
- تعرض واجهة برمجة التطبيقات هذه محتوى وجهة شاشة.
الطلب:
- المعلّمات: {"id": x}
  - "المعرّف"—فهرس وجهة الشاشة.
الاستجابة:
- الاستجابة: { "id": 0, "Name": "ScreenDest1""BGLyr":[{"id": 0, "LastBGSourceIndex":
  0, "BGShowMatte":0, "BGColor":[{"id":0, "Red":0, "Green":0, "Blue":0}]},
  {"id": 1, "LastBGSourceIndex": 0, "BGShowMatte":0, "BGColor":[{"id":0,
  "Red":0, "Green":0, "Blue":0}]}],(0 = PGM Background, 1 = PVW Background)
  "Layers":[{"id": 0, "LastSrcIdx": 0, "HPos": 0, "VPos": 0, "HSize": 400,
  "VSize": 300, "PvwMode": 0, "PgmMode": 0, "Freeze": 0, "FlexZOrder":
  0,"LayerTrans":[{"id": 0, "TransTime": 30, "TransPos": 0}, {"id": 1,
  "TransTime": 30, "TransPos": 0}] , "3D": "Yes", "Freeze": 0, "Capacity":
  2}]}]}
  - المعرّف—فهرس وجهة الشاشة.
  - الاسم—اسم ScreenDestination (وجهة الشاشة).
  - BGLyr—فهرس طبقة الخلفية، فهرس آخر مصدر للخلفية.
    "المعرّف":0 يؤثر على الخلفية في البرنامج. "المعرّف":1 يؤثر على الخلفية في المعاينة.
  - LastBGSoureIndex—هذا هو –1 إذا لم يتم إسقاط أي خلفية، وإلا فإن هذا هو فهرس الخلفية الأخيرة التي تم إسقاطها على وجهة الشاشة.
  - BGShowMatte—هذا إذا كانت BG غير لامعة أم لا.
  - BGColor—هذا لون الخلفية.
  - Layers (الطبقات)—يسرد الطبقات على وجهة الشاشة بخصائصها.
  - Transition (الانتقال)—تحتوي خاصية وجهة الشاشة هذه على وقت الانتقال (من وقت للانتقال من المعاينة إلى البرنامج).
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 0}, "method":"listContent", "id":"1234", "jsonrpc":"2.0"}

activateCue

التعريف:
- توفر واجهة برمجة التطبيقات هذه خيار تشغيل/إيقاف مؤقت/إيقاف تشغيل إشارة.
- يمكن للمستخدم استدعاء إشارة بالمعرّف أو الرقم المسلسل أو الاسم.
الطلب:
- المعلّمات: {"id": 1, "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}
  - المعرّف – مؤشر الإشارة
  - النوع - (الافتراضي هو التشغيل). x" يمكن أن تكون : 0 — التشغيل. 0 هي القيمة الافتراضية لمعلّمة النوع. 1 — إيقاف مؤقت، 2 – إيقاف
- المعلّمات: {"cueName": "Cue1", "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}
- المعلّمات: {"cueSerialNo": 1.00, "type": x}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"}
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 1}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Play – no parame or type 0
- {"params": {"type": 1}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Pause – type 1
- {"params": {"type": 2}, "method":"activateCue", "id":"1234", "jsonrpc":"2.0"} //Stop – type 2

activateDestGroup

التعريف:
- استدعاء DestGroup على معالج Event Master. يمكن للمستخدم استدعاء DestGroup بالمعرّف أو رقم DestGroup المسلسل أو اسم DestGroup.
- أرسِل أيًا من المعلّمات لاستدعاء DestGroup.
الطلب:
- المعلّمات: {"id": x}
- المعلّمات: {"destGrpSno": x.y}
- المعلّمات: {"destGrName": "GroupName"}
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 0}, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"destGrpName": "abc" }, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}
- {"params": {"destGrpSno": 1.00}, "method":"activateDestGroup", "id":"1234", "jsonrpc":"2.0"}

listCues

التعريف:
- تسرد واجهة برمجة التطبيقات هذه كافة الإشارات.
الطلب:
- المعلّمات: {}, "method":"listCues", "id":"1234", "jsonrpc":"2.0"}
الاستجابة:
- الاستجابة: مجموعة من كائنات الإشارات.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {}, "method":"listCues", "id":"1234", "jsonrpc":"2.0"}

3dControl

التعريف:
- توفر واجهة برمجة التطبيقات هذه خيارًا لتعديل عناصر التحكم ثلاثية الأبعاد.
الطلب:
- المعلّمات: {"id" : id, "type": x, "syncSource": y, "syncInvert": z}
  - المعرّف – فهرس تكوين الإدخال.
  - النوع - "x" يمكن أن يكون: 0 - Type Off. 0 هي القيمة الافتراضية لمعلّمة النوع. 1 – نوع Sequentia.
  - syncSource – "y" يمكن أن يكون: 1 – Din المصغر 1، 2 – Din المصغر 2، 3 – Din المصغر 3، 4 – Din المصغر 4. القيمة الافتراضية هي 1.
  - syncInvert – "z" يمكن أن يكون: 0 - Type Off. 0 هي القيمة الافتراضية لـ syncInvert. 1 - نوع العكس.
  - لإعادة التعيين، لا تقدّم أي معلّمة باستثناء "id" (المعرّف).
الاستجابة:
- الاستجابة: {"id": 0, "Name": "InSource1", "HSize": 3840, "VSize": 1080,
  "Src-Type": 0, "InputCfgIndex": -1, "StillIndex": 0, "DestIndex": -1,
  "UserKeyIndex": -1, "Mode3D": 0, "Freeze": 1, "Capacity": 2,
  "InputCfgVideoStatus": 4}
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 1, "type": 0, "syncSource": 1, "syncInvert": 0},
  "method":"3dControl", "id":"1234", "jsonrpc":"2.0"}

changeContent

التعريف:
- تعمل واجهة برمجة التطبيقات هذه على تغيير محتوى وجهة الشاشة من خلال وضع الخلفية والطبقات فيها.
الطلب:
- المعلّمات: {"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,
  "BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,
  "LastBGSourceIndex":0,"BGShowMatte":0,"BGColor":
  [{"id":0,"Red":0,"Green":0,"Blue":0}]}],"Layers":
  [{"id":0,"LastSrcIdx":0,"Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},
  "Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}, "Mask":
  { "Left":0.01, "Right":10.1, "Top":0.0,"Bottom":0.0},"PvwMode":1,"PgmMode":0,
  "Freeze":0,"PgmZOrder":0,"PvwZOrder":0}]}
  - المعرّف—فهرس وجهة الشاشة.
  - BGLyr—فهرس طبقة الخلفية، فهرس آخر مصدر للخلفية.
    "المعرّف":0 يؤثر على الخلفية في البرنامج. "المعرّف":1 يؤثر على الخلفية في المعاينة.
  - Layers (الطبقات)—معلومات الطبقة.
  - Window (النافذة)—حجم نافذة الطبقة.
  - Source (المصدر)—معلومات المصدر وحجمه.
  - Mask (القناع)—اقتصاص الجزء المرئي من الطبقة.
  - PvwMode (وضع Pvw)—قم بتعيين 1 إذا كنت تريد عرض المحتوى في المعاينة. (إعداد افتراضي)
  - PgmMode (وضع Pgm)—قم بتعيين 1 إذا كنت تريد عرض المحتوى في البرنامج.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,
  "BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,
  "LastBGSourceIndex":0,"BGShowMatte":0,"BGColor":[{"id":0,"Red":0,
  "Green":0,"Blue":0}]}],"Layers":[{"id":0,"LastSrcIdx":0,
  "Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},
  "Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080},
  "Mask":{ "Left":0.01, "Right":10.1, "Top":0.0,"Bottom":0.0},
  "PvwMode":1,"PgmMode":0,"Freeze":0,"PgmZOrder":0,"PvwZOrder":0}]},
  "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}.
- {"params":{"id":0, "TestPattern" :5 }, "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}

freezeDestSource

التعريف:
- تعمل واجهة برمجة التطبيقات هذه على تجمد/إلغاء إيقاف المصادر.
الطلب:
- المعلّمات: {"type": x, "id": y, "screengroup": z ,"mode": 0/1}
  النوع—نوع المصدر.
  - 0—مصدر الإدخال.
  - 1—مصدر الخلفية.
  - 2—وجهة الشاشة.
  - 3—الوجهة المساعدة.
- id (المعرّف)—مؤشر المصدر.
- Screengroup (مجموعة الشاشات)—للاستخدام مستقبلاً. يتم التعيين دائمًا على 0.
- الوضع —0: إلغاء التجميد، 1: التجميد.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"type": 0, "id": 0, "screengroup": 0 ,"mode": 1},
  "method":"freezeDestSource", "id":"1234", "jsonrpc":"2.0"}

listStill

التعريف:
- تسرد واجهة برمجة التطبيقات هذه كافة اللقطات الثابتة بخصائص مثل المعرّف والاسم وحجم H/V ووضع القفل وحالة اللقطة الثابتة وحالة Png وحجم الملف.
الطلب:
- المعلّمات: {}
الاستجابة:
- الاستجابة: مجموعة من: [{"id":0,"Name":"StillStore1",
  "LockMode":0,"HSize":{"Min":0,"Max":99999,"$t":1920},"VSize":{"Min":0,
  "Max":99999,"$t":1080},"StillState":{"Min":0,"Max":4,"$t":3},"PngState":
  {"Min":0,"Max":2,"$t":0},"FileSize":{"Min":0,"Max":100000,"$t":9331.2}}]
  - المعرّف—مؤشر متجر اللقطة الثابتة.
  - الاسم—اسم متجر اللقطة الثابتة.
  - وضع القفل—للاستخدام مستقبلاً. يتم التعيين دائمًا على 0.
  - حجم H/V—الحجم الأفقي والرأسي، الحد الأدنى، الحد الأقصى والقيمة الحالية. تظهر القيمة الحالية.
  - حالة اللقطة الثابتة—يخبر هذا المستخدم ما إذا كان يتم التقاط اللقطة الثابتة حاليًا أم لا، أو إذا تم حذفها.
  - حالة Png—إن "PNG" للقطات الثابتة مخصصة للصور المصغرة التي نلتقطها للقطات الثابتة.
  - حجم الملف—حجم الملف الذي تم إنشاؤه بالكيلو بايت.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {}, "method":"listStill", "id":"1234", "jsonrpc":"2.0"}

deleteStill

التعريف:
- تحذف واجهة برمجة التطبيقات هذه لقطة ثابتة.
الطلب:
- المعلّمات: {"id": x}
  - المعرّف—مؤشر اللقطة الثابتة.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{"id": 0}, "method":"deleteStill", "id":"1234", "jsonrpc":"2.0"}

takeStill

التعريف:
- تقوم واجهة برمجة التطبيقات هذه بإنشاء/استبدال لقطة ثابتة.
الطلب:
- المعلّمات: { "type": x, "id": y, "file": z}
  - النوع—0 لمصدر الإدخال، 1 لمصدر BG.
  - المعرّف—مؤشر المصدر. إذا تم توفير معرّف المصدر الخاص بالوجهة، فلن يتم إنشاء أي استمرار ويظهر خطأ.
  - ملف— معرّف ملف لقطة ثابتة. إذا تخطيتَ "ملف": 5، يؤدي هذا إلى إنشاء StillStore6.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{"type":0 , "id": 1, "file": 5}, "method":"takeStill", "id":"1234",
  "jsonrpc":"2.0"}
  - يؤدي هذا إلى إنشاء لقطة ثابتة من معرّف مصدر الإدخال 1 كـ StillStore6.

getFrameSettings

التعريف:
- تعرض واجهة برمجة التطبيقات هذه معلومات النظام، بما في ذلك كافة معلومات الإطارات.
الطلب:
- المعلّمات: {}
الاستجابة:
- {"System":{"id":0,"Name":"System1","FrameCollection":{"id":0,"Frame":
  {"id":"00:0c:29:0e:86:d4","Name":"E2","Contact":"","Version":"4.2.30738",
  "OSVersion":"NA","FrameType":0,"FrameTypeName":"E2","Enet":{"DhcpMode":0,
  "DhcpModeName":"Static","IP":"10.98.0.165","StaticIP":"192.168.000.175",
  "MacAddress":"00:0c:29:0e:86:d4","StaticMask":"255.255.255.000",
  "StaticGateway":"192.168.000.001"},"SysCard":{"SlotState":2,
  "CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":80,
  "CardTypeLabel":"System","CardID":0},"Slot":[{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":70,"CardTypeLabel":"Expansion",
  "CardID":"thisissometextforid0"}},{"Card":{"CardStatusID":2,"CardStatusLabel":
  "Ready","CardTypeID":70,"CardTypeLabel":"Expansion","CardID":
  "thisissometextforid1"}},{"Card":{"CardStatusID":0,"CardStatusLabel":
  "Not Installed","CardTypeID":255,"CardTypeLabel":"Unknown","CardID":
  "Undefined"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":1,"CardTypeLabel":"SDI Input","CardID":"thisissometextforid211"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":3,"CardID":
  "thisissometextforid2"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":0,"CardTypeLabel":"DVI Input","CardID":"thisissometextforid4"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,
  "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid5"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,
  "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid7"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,
  "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid8"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":2,
  "CardTypeLabel":"HDMI/DP Input","CardID":"thisissometextforid9"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":22,
  "CardTypeLabel":"HDMI Output","CardID":"CardID3"}},{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":22,"CardTypeLabel":"HDMI Output",
  "CardID":"CardID4"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":21,"CardTypeLabel":"SDI Output","CardID":"CardID415"}},
  {"Card":{"CardStatusID":2,"CardStatusLabel":"Ready","CardTypeID":40,
  "CardTypeLabel":"MVR","CardID":"CardID15"}},{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",
  "CardID":"thisissometextforid501"}},{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",
  "CardID":"thisissometextforid502"}},{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",
  "CardID":"thisissometextforid503"}},{"Card":{"CardStatusID":2,
  "CardStatusLabel":"Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler",
  "CardID":"thisissometextforid504"}},{"Card":{"CardStatusID":0,
  "CardStatusLabel":"Not Installed","CardTypeID":255,"CardTypeLabel":
  "Unknown","CardID":"Undefined"}},{"Card":{"CardStatusID":2,"CardStatusLabel":
  "Ready","CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":
  "thisissometextforid505"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":
  "thisissometextforid506"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":
  "thisissometextforid507"}},{"Card":{"CardStatusID":2,"CardStatusLabel":"Ready",
  "CardTypeID":50,"CardTypeLabel":"VPU Scaler","CardID":
  "thisissometextforid508"}}]}}}}}
  - النظام—اسم النظام والفهرس.
  - مجموعة الإطار—مجموعة الإطارات في نظام يحتوي على معلومات الإطار.
  - الإطار—يحتوي على معلومات الإطار.
  - المعرّف—معرّف Mac للإطار.
  - الاسم—اسم الإطار.
  - جهة التواصل—معلومات جهة التواصل.
  - الإصدار—الإصدار الحالي من البرنامج المثبّت على الإطار.
  - إصدار نظام التشغيل—إصدار نظام التشغيل الحالي المثبّت على الإطار.
  - FrameType—0: E2 ،1:S3, 2: Ex.
  - FrameTypeName—نوع الإطار: E2/S3/Ex.
  - Enet—إعدادات Ethernet.
  - بطاقة المزامنة—معلومات بطاقة النظام.
  - الفتحة—قائمة معلومات بطاقة الإدخال/الإخراج/التوسيع.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params":{}, "method":"getFrameSettings", "id":"1234", "jsonrpc":"2.0"}

listAuxContent

التعريف:
- تعرض واجهة برمجة التطبيقات هذه معلومات الوجهة المساعدة.
الطلب:
- المعلّمات: {"id" : x}
  - المعرّف—فهرس وجهة Aux.
الاستجابة:
- الاستجابة: {"id":0,"Name":"AuxDest1","PvwLastSrcIndex":0,"PgmLastSrcIndex":0}
  - المعرّف—فهرس وجهة Aux.
  - الاسم—اسم الوجهة المساعدة.
  - PvwLastSrcIndex—فهرس مصدر الإدخال/الخلفية في منطقة المعاينة.
  - PgmLastSrcIndex—فهرس مصدر الإدخال/الخلفية في منطقة البرنامج.
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id": 0}, "method":"listAuxContent", "id":"1234", "jsonrpc":"2.0"}

changeAuxContent

التعريف:
- تقوم واجهة برمجة التطبيقات هذه بتغيير المصدر في الوجهة المساعدة
الطلب:
- المعلّمات: {"id":x , "Name": "AuxDest1" , "PvwLastSrcIndex": y , "PgmLastSrcIndex": z}
  - المعرّف—فهرس وجهة Aux.
  - الاسم—اسم الوجهة المساعدة. (معلّمة اختيارية)
  - PvwLastSrcIndex—فهرس مصدر الإدخال/الخلفية المراد تعيينه في الوجهة المساعدة في منطقة المعاينة.
  - PgmLastSrcIndex— فهرس مصدر الإدخال/الخلفية المراد تعيينه في الوجهة المساعدة في منطقة البرنامج.
الاستجابة:
- الاستجابة: فارغة
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"id":0 , "Name": "AuxDest1" , "PvwLastSrcIndex": 6 ,
  "PgmLastSrcIndex": 1}, "method":"changeAuxContent", "id":"1234", "jsonrpc":"2.0"}
- {"params":{"id":0, "TestPattern" :3 }, "method":"changeAuxContent", "id":"1234", "jsonrpc":"2.0"}

الاشتراك وإلغاء الاشتراك

عندما يتم الاشتراك من تطبيق يستند إلى JSON، يتم إرسال إشعار إلى منفذ ip حيث يتم تشغيل التطبيق عندما يكون هناك تغيير قام المستخدم بالاشتراك فيه.

يتم إرسال الإشعار الفعلي بشكل غير متزامن كمنشور HTTP، بالهيكل التالي: {result: {method:

"notification",notificationType: "ScreenDestChanged",change: { add: [2],

remove: [], update: [0, 1, 2] }}}.

يحتوي حقل التغيير على XmlId(s) للشاشات التي تمت إضافتها/إزالتها أو تحديثها.

ملاحظة: جميع الاشتراكات مفقودة بمجرد إعادة تشغيل معالج Event Master، ويجب أن تكون مشتركة مجددًا إذا لزم الأمر.

الاشتراك

التعريف:
- يمكن للمستخدم استخدام واجهة برمجة التطبيقات هذه للاشتراك في أحداث التغيير في معالج Event Master.
- بمجرد الاشتراك، ترسل واجهة برمجة التطبيقات إشعارًا في شكل HTTP Post إلى عنوان URL:http://hostname:port/.
الطلب:
- المعلّمات: {"hostname": hostname, "port": port, "notification" : notificationType[]}
  اسم المضيف—اسم المضيف أو عنوان IP الذي يتم إرسال الإشعارات إليه.
  المنفذ—منفذ TCP الذي تم إرسال الإشعار إليه.
  أنواع التنبيهات—مجموعة من الإشعارات التي يرغب المستخدم في الاشتراك فيها.
  - ScreenDestChanged
  - AUXDestChanged
  - FrameChanged
  - NativeRateChanged
  - InputCfgChanged
  - SourceChanged
  - BGSourceChanged
  - PresetChanged
  - StillChanged
  - OutputCfgChanged
  - CueChanged
الاستجابة:
- الاستجابة: {"method": "subscribe"}
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" :
  ["ScreenDestChanged", "AUXDestChanged"]}, "method":"subscribe", "id":"1234",
  "jsonrpc":"2.0"}

إلغاء الاشتراك

التعريف:
- يمكن للمستخدم استخدام واجهة برمجة التطبيقات هذه لإزالة الاشتراك لاسم المضيف والمنفذ ونوع الإعلام المحدد.
الطلب:
- المعلّمات: {"hostname": hostname, "port": port, "notification" : notificationType[]}
  اسم المضيف—اسم المضيف أو عنوان IP الذي سيتم إزالة الاشتراك منه.
  المنفذ—منفذ TCP.
  أنواع التنبيهات—مجموعة من الإشعارات التي يرغب المستخدم في الاشتراك فيها.
  - ScreenDestChanged
  - AUXDestChanged
  - FrameChanged
  - NativeRateChanged
  - InputCfgChanged
  - SourceChanged
  - BGSourceChanged
  - PresetChanged
  - StillChanged
  - OutputCfgChanged
  - CueChanged
الاستجابة:
- الاستجابة: {"method": "unsubscribe"}
- النجاح: (0=النجاح، أي شيء آخر هو خطأ)
مثال:
- {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" :
  ["ScreenDestChanged", "AUXDestChanged"]}, "method":"unsubscribe",
  "id":"1234", "jsonrpc":"2.0"}