BOSE ڪم آرام API ايپ
تعارف
Bose Videobar ڊيوائسز نيٽ ورڪ مينيجمينٽ ۽ مانيٽرنگ لاءِ نمائندگي واري اسٽيٽ ٽرانسفر ايپليڪيشن پروگرامنگ انٽرفيس (REST API) جي حمايت ڪن ٿيون. هي گائيڊ مهيا ڪري ٿو REST API کي فعال ڪرڻ ۽ ترتيب ڏيڻ لاءِ وڊيو بار ڊوائيسز، ۽ اهو مهيا ڪري ٿو تفصيلي وضاحت سان سهڪار ڪيل متغيرن ۽ عملن جو.
ٺاھ جوڙ جون شيون ۽ آپريشن ھنن ڀاڱن ۾ ورهايل آھن:
- سسٽم
- رويي
- USB
- آڊيو
- ڪئميرا
- آڊيو فريمنگ
- بلوٽوٿ
- نيٽ ورڪ (VBl)
- وائي فائي
- ٽيليميٽري (VBl)
API حڪم ريفرنس سيڪشن هر اعتراض لاء هيٺ ڏنل معلومات مهيا ڪري ٿو:
- نالو/وضاحت اعتراض جو نالو ۽ ان جي استعمال جي وضاحت.
- ڪارناما جيڪي اعتراض تي ڪري سگهجن ٿيون. عمل ڪري سگهي ٿو
- ھيٺين مان ھڪڙو يا وڌيڪ ھجي: حاصل ڪريو، رکو، ختم ڪريو، پوسٽ ڪريو.
- قدرن جي حد اعتراض لاءِ قابل قبول قدر.
- Default Value اعتراض جو Default value. هي اهو قدر آهي جيڪو استعمال ڪيو ويندو آهي جيڪڏهن توهان ڊوائيس کي فيڪٽري ڊفالٽ ڏانهن واپس آڻيو.
سڀئي قدر اسٽرنگ طور بيان ڪيا ويا آهن.
ٽريڊ مارڪ نوٽس
- بوس، بوس ڪم، ۽ ويڊيوبار بوس ڪارپوريشن جا ٽريڊ مارڪ آهن.
- The Bluetooth” لفظ جا نشان ۽ لوگو رجسٽرڊ ٽريڊ مارڪ آھن جيڪي Bluetooth SIG, Inc. جي ملڪيت آھن ۽ Bose Corporation پاران اھڙين نشانين جو ڪو به استعمال لائسنس جي تحت آھي.
- اصطلاح HDMI ھڪڙو ٽريڊ مارڪ يا رجسٽرڊ ٽريڊ مارڪ آھي HDMI لائسنسنگ ايڊمنسٽريٽر، Inc.
- ٻيا سڀئي ٽريڊ مارڪ انهن جي لاڳاپيل مالڪن جي ملڪيت آهن.
رازداري ڄاڻ
بوس لاءِ توهان جي پرائيويسي اهم آهي ان ڪري اسان هڪ پرائيويسي پاليسي ٺاهي آهي جنهن ۾ اهو شامل آهي ته اسان توهان جي ذاتي معلومات ڪيئن گڏ، استعمال، ظاهر، منتقلي ۽ ذخيرو ڪريون ٿا.
مھرباني ڪري ھن پرائيويسي پاليسي کي غور سان پڙھو سمجھڻ لاءِ ته اسان توھان جي معلومات کي ڪيئن سنڀاليندا آھيون. جيڪڏهن توهان هن رازداري پاليسي سان متفق نه آهيو، مهرباني ڪري خدمتون استعمال نه ڪريو.
REST API کي فعال ۽ ترتيب ڏيڻ
ڊوائيس تي REST API تائين رسائي کي فعال ڪرڻ لاءِ، Bose Work Configuration ايپ، Bose Work Management ايپ، يا Web UI. نيٽ ورڪ> API سيٽنگون تائين رسائي ڪريو. API رسائي کي فعال ڪريو ۽ API صارف نالو ۽ پاسورڊ بيان ڪريو. توھان کي انھن API سندن جي ضرورت پوندي REST API حڪمن مان ڪنھن کي استعمال ڪرڻ لاءِ. مھرباني ڪري حوالو ڏيو ايپليڪيشن استعمال ڪندڙ ھدايتون وڌيڪ معلومات لاءِ.
REST API جي جاچ ڪندي
توھان استعمال ڪري سگھوٿا ويڊيوبار REST API کي استعمال ڪندي Swagger OpenAPI انٽرفيس جيڪو ڊوائيس ۾ شامل ڪيو ويو آھي. هن انٽرفيس تائين رسائي حاصل ڪرڻ لاءِ وڊيوبار کي لازمي طور تي IP نيٽ ورڪ سان ان جي وائرڊ يا وائي فائي انٽرفيس ذريعي ڳنڍيو وڃي، ۽ توهان جو ميزبان پي سي هڪ ئي نيٽ ورڪ يا نيٽ ورڪ تي هجي جيڪو HTTPS ذريعي ڊوائيس تائين رسائي ڪري سگهي.
USB انٽرفيس ذريعي پنهنجي پي سي کي وڊيو بار سان ڳنڍيو. شروع ڪريو Bose Work Configuration ائپ ۽ سائن ان ڪريو انتظامي ڪنٽرول تائين رسائي حاصل ڪرڻ لاءِ. نيٽورڪ> API صفحو چونڊيو ۽ لنڪ تي ڪلڪ ڪريو:
REST API دستاويز (Web UI)
جيڪڏهن توهان USB ذريعي ڊوائيس سان ڳنڍيل نه آهيو ۽ توهان جو PC ساڳئي نيٽ ورڪ تي آهي، توهان هيٺ ڏنل ايڊريس تي برائوز ڪندي پنهنجي برائوزر ذريعي REST API تائين رسائي ڪري سگهو ٿا:
https://<videobar-ip-address>/doc-api
REST API حڪم
ويڊيوبار REST API انٽرفيس استعمال ڪري ٿو ڪمان IDs مان هر هڪ ۾ چار HTTP طريقن جي حمايت ڪئي: حاصل ڪريو، رکو، حذف ڪريو، ۽ پوسٽ ڪريو.
هيٺ ڏنل چار طريقن جي وضاحت آهي جنهن جي پٺيان هڪ جدول بيان ڪيو ويو آهي طريقن جي هر هڪ حڪم جي حمايت ڪئي وئي آهي.
حاصل ڪريو
"حاصل" جو طريقو ھڪڙي ڪمانڊ ID يا گھڻن ڪاما-ڊيلائيٽ ٿيل IDs کي قبول ڪري ٿو. مثال طورample، audio.micMute اسٽيٽ حاصل ڪرڻ لاءِ، ڪمانڊ ID 2 آهي URL هن طرح آهي:
https://192.168.1.40/api?query=2
جوابي جسم هن ريت آهي، "O" جي قيمت سان اشارو ڪيو ويو آهي ته مائڪ خاموش نه آهي:
{"2": {"اسٽيٽس": "ڪامياب"، "قيمت": "0"}}
گھڻن قدرن لاءِ سوال ڪرڻ لاءِ، ڪاما سان گھڻن ڪمانڊ IDs کي الڳ ڪريو. مثال طورample، توهان audio.micMute (ID=2) ۽ system.firmwareVersion (ID=l6) لاءِ سوال ڪري سگهو ٿا:
https://192.168.1.40/api?query=2,16
نوٽ: گھڻن IDs جي وچ ۾ خال شامل نه ڪريو.
نتيجو ٿيندو:
{"2": {"اسٽيٽس": "ڪامياب"، "قدر": "0"}، "16": {"اسٽيٽس": "ڪامياب"، "قدر": "1.2.13_fd6cc0e"}}
پوٽو
هڪ ”پٽ“ ڪمانڊ استعمال ڪري ٿو JSON باڊي فارميٽ کي چاٻي سان ”ڊيٽا“ ۽ قدر هجڻ جي سڃاڻپ: قدر جوڙو.
مثال طورample، audio.loudspeakerVolume (ID=3) کي 39 تي سيٽ ڪرڻ لاءِ، ”https://192.168.1.40/ api“ باڊي آهي:
{"ڊيٽا":"{"3":"39"}"}
جواب آهي:
{"3": {"اسٽيٽس": "ڪامياب"، "ڪوڊ": "0xe000"}}
هتي هڪ سابق آهيampڪيترن ئي قدرن کي ترتيب ڏيو:
{"ڊيٽا":"{"2":"1"،"3":"70"}"}
جواب آهي:
{"2": {"اسٽيٽس": "ڪامياب"، "ڪوڊ": "0xe000"}، "3": {"اسٽيٽس": "ڪامياب"، "ڪوڊ": "0xe000"}}
جواب "ڪوڊ" قدر ھيٺين مان ڪو به ٿي سگھي ٿو:
- 0xe000: ڪاميابي
- 0xe001: ڪاميابي - قيمت ۾ ڪابه تبديلي
- 0xe002: غلطي - غلط ملڪيت
- 0xe003: غلطي - غلط ملڪيت جي قيمت
- 0xe004: غلطي - غلط ملڪيت جي عمل
- 0xe005: غلطي - پيغام خراب ٿيل
- 0xe006: غلطي - رسائي رد ڪئي وئي
پوسٽ
هڪ ”پوسٽ“ ”پٽ“ سان ملندڙ جلندڙ آهي ۽ ڪمن لاءِ استعمال ٿئي ٿي، جهڙوڪ ٽوگل مائڪ ميوٽ ۽ اسپيڪر جو مقدار مٿي/هيٺ. توھان وضاحت ڪريو حڪم جي ID ۽ قيمت لاءِ خالي اسٽرنگ استعمال ڪريو.
مثال طورampلي، اسپيڪر جي مقدار کي وڌائڻ لاءِ هڪ ٽِڪ، استعمال ڪريو audio.loudspeakerVolumeUp (ID=4) باڊي فارميٽ سان:
{"ڊيٽا":"{"4":""}"}
ردعمل جسم آهي:
{"4": {"اسٽيٽس": "ڪامياب"، "ڪوڊ": "0xe000"}}
ممڪن جواب "ڪوڊ" قيمتون ساڳيون آهن جيڪي PUT حڪم لاء درج ٿيل آهن.
حذف ڪريو
"حذف" حڪم جي شڪل "حاصل" سان ملندڙ جلندڙ آهي، ۽ جوابي جسم "پٽ" سان ملندڙ جلندڙ آهي. حذف استعمال ڪندي قيمت واپس ان جي ڊفالٽ تي سيٽ ڪندو.
مثال طورample، audio.loudspeaker حجم (ID=3) کي ان جي ڊفالٽ ويل تي سيٽ ڪرڻ لاءِ، URL هن طرح آهي:
https://192.168.1.40/api?delete=3
ردعمل جسم آهي:
{"3": {"اسٽيٽس": "ڪامياب"، "ڪوڊ": "0xe000"}}
توهان کي نئين قيمت حاصل ڪرڻ لاءِ ”حاصل“ جاري ڪرڻ جي ضرورت پوندي، جيڪا هن صورت ۾ 50 آهي. مثال لاءِampاليزي:
حڪم:
https://192.168.1.40/api?query=3
جواب:
{"3": {"اسٽيٽس": "ڪامياب"، "قيمت": "50"}}
ممڪن جواب "ڪوڊ" قيمتون ساڳيون آهن جيڪي PUT حڪم لاء درج ٿيل آهن
ويڊيوبار REST API ڪمانڊ ريفرنس
| نالو / وضاحت | عمل | سي ايم ڊي ID | قدرن جي حد | ڊفالٽ قدر |
| system.reboot
سسٽم کي ريبوٽ ڪري ٿو. |
پوسٽ | 32 | N/A | N/A |
| سسٽم.سيريل نمبر
ڊوائيس جو سيريل نمبر. |
حاصل ڪرڻ | 10 | تار
(17 اکر) |
اووووووووووو |
| system.firmwareVersion
ڊوائيس تي هلندڙ firmware جو نسخو. اهو خودڪار طريقي سان سسٽم فرم ويئر اپ گريڊ تي مقرر ڪيو ويو آهي. |
حاصل ڪرڻ | 16 | تار
(1-16 اکر) |
0.0.0 |
| سسٽم ماڊل
هن ڊوائيس جو ماڊل. |
حاصل ڪرڻ | D6 | تار
(1-22 اکر) |
مقرر نه ڪيو |
| سسٽم جو نالو
ڊوائيس جو نالو ان ڪري ان کي منفرد طور سڃاڻي سگهجي ٿو. |
حذف ڪرڻ | 25 | تار
(1-22 اکر) |
مقرر نه ڪيو |
| سسٽم.ڪمرو
ڊوائيس جي ڪمري جي جڳھ |
حذف ڪرڻ | 26 | تار
(0-128 اکر) |
مقرر نه ڪيو |
| سسٽم. فرش
ڊوائيس جي فرش جي جڳھ. |
حذف ڪرڻ | 27 | تار
(0-128 اکر) |
مقرر نه ڪيو |
| سسٽم.بلڊنگ
ڊوائيس جي عمارت جي جڳھ. |
حذف ڪرڻ | 28 | تار
(0-128 اکر) |
مقرر نه ڪيو |
| system.gpiMuteStatus (VBl)
GPI خاموش حالت (آن/بند). |
حاصل ڪرڻ | C7 | 110 | (VBl ۾ سپورٽ ٿيل) 0 |
| system.max Occupancy
ڪمري جي وڌ ۾ وڌ گنجائش ڊوائيس جي. |
حذف ڪرڻ | DF | تار
(0-128 اکر) |
مقرر نه ڪيو |
| behavior.ethernetEnabled (VBl)
سسٽم Ethernet انٽرفيس تي / بند ڪري ٿو. |
حذف ڪرڻ | 38 | 110 | (VBl ۾ سپورٽ ٿيل) 1 |
| behavior.bluetoothEnabled
سسٽم بلوٽوت کي آن / بند ڪري ٿو. |
حذف ڪرڻ | 3A | 110 | 1 |
| behavior.wifiEnabled
سسٽم وائي فائي کي آن / بند ڪري ٿو. |
حذف ڪرڻ | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
HDMI کي آن / بند ڪري ٿو. |
حذف ڪرڻ | C9 | 110 | (VBl ۾ سپورٽ ٿيل) 0 |
| usb.connectionStatus
USB ڪيبل ڪنيڪشن جي حالت؛ 0 جڏهن ڌار ٿي ويو. |
حاصل ڪرڻ | 36 | 110 | 0 |
| usb.callStatus
سسٽم جي USB بندرگاهن سان ڳنڍيل ميزبان کان ڪال اسٽيٽس. |
حاصل ڪرڻ | 37 | 110 | 0 |
| audio.micMute
سسٽم مائڪروفون کي خاموش / غير خاموش ڪري ٿو. |
لڳائڻ | 2 | 110 | 0 |
| audio.micMuteToggle
سسٽم مائڪروفون جي گونگا حالت کي ٽوگل ڪري ٿو. |
پوسٽ | 15 | N/A | N/A |
| نالو / وضاحت | عمل | سي ايم ڊي ID | قدرن جي حد | ڊفالٽ قدر |
| audio.loudspeakerMute
سسٽم لائوڊ اسپيڪر کي خاموش/ان ميوٽ ڪري ٿو. |
پوسٽ | 34 | N/A | N/A |
| audio.loudspeakerMuteToggle
سسٽم لائوڊ اسپيڪر جي گونگا حالت کي ٽوگل ڪري ٿو. |
پوسٽ | 34 | N/A | N/A |
| audio.loudspeakerVolume
سسٽم لائوڊ اسپيڪر جي مقدار کي سيٽ ڪري ٿو. |
حذف ڪرڻ | 3 | 0-100 | 50 |
| audio.loudspeakerVolumeUp
سسٽم لائوڊ اسپيڪر جي مقدار کي ھڪڙي قدم وڌائي ٿو. |
پوسٽ | 4 | N/A | N/A |
| audio.loudspeakerVolumeDown
سسٽم لائوڊ اسپيڪر جي مقدار کي ھڪڙي قدم گھٽائي ٿو. |
پوسٽ | 5 | N/A | N/A |
| ڪئميرا زوم
ڪئميرا جي موجوده زوم قدر. |
حذف ڪرڻ | 6 | 1-10 | 1 |
| ڪئميرا پين
ڪئميرا جي موجوده پين جي قيمت. |
حذف ڪرڻ | 7 | -10-10 | 0 |
| ڪيمرا.ٽائل
ڪئميرا جي موجوده جھلڪ قدر. |
حذف ڪرڻ | 8 | -10-10 | 0 |
| camera.zoom In
ڪئميرا کي هڪ قدم سان زوم ڪريو. |
پوسٽ | 9 | N/A | N/A |
| camera.zoomOut
ڪئميرا کي هڪ قدم سان زوم ڪري ٿو. |
پوسٽ | OA | N/A | N/A |
| ڪئميرا پين کاٻو
پنس ڪئميرا هڪ قدم کان ڇڏي ويو. |
پوسٽ | OB | N/A | N/A |
| ڪئميرا پين ساڄو
پنيس ڪئميرا ساڄي طرف هڪ قدم. |
پوسٽ | oc | N/A | N/A |
| camera.tiltUp
ڪئميرا کي هڪ قدم کان مٿي ڪري ٿو. |
پوسٽ | OD | N/A | N/A |
| camera.tiltDown
ڪئميرا کي ھڪ قدم ھيٺ جھڪي ٿو. |
پوسٽ | OE | N/A | N/A |
| camera.homePreset
گھر جي ڪئميرا اڳي سيٽ پين ٽائل زوم آرڊر ۾ |
حذف ڪرڻ | 56 | 0 01 | |
| camera.firstPreset
ڪئميرا پهريون اڳيئي پين ٽائل زوم آرڊر ۾. |
حذف ڪرڻ | 57 | 0 01 | |
| camera.second Preset
پين ٽلٽ زوم آرڊر ۾ ڪيمرا سيڪنڊ پري سيٽ. |
حذف ڪرڻ | 58 | 0 01 | |
| camera.savePresetHome
موجوده PTZ قدرن کي گھر ۾ محفوظ ڪري ٿو. |
پوسٽ | 12 | N/A | N/A |
| camera.savePresetFirst
موجوده PTZ قدرن کي پھرين سيٽ تي محفوظ ڪري ٿو. |
پوسٽ | 17 | N/A | N/A |
| camera.savePresetSecond
موجوده PTZ قدرن کي سيڪنڊ پري سيٽ تي محفوظ ڪري ٿو. |
پوسٽ | 18 | N/A | N/A |
| نالو / وضاحت | عمل | سي ايم ڊي ID | قدرن جي حد | ڊفالٽ قدر |
| camera.apply ActivePreset
PTZ سيٽنگون تي فعال اڳوڻو لاڳو ڪريو. |
پوسٽ | OF | N/A | N/A |
| ڪئميرا فعال اڳواٽ
هي فعال اڳواٽ آهي. نوٽ، ڪئميرا شروع ڪرڻ يا ٻيهر شروع ڪرڻ تي فعال اڳوڻو گھر تي سيٽ ڪيو ويو آهي. |
حذف ڪرڻ | 13 | 11213 | 1 |
| ڪئميرا رياست
ڪئميرا جي حالت. جڏهن فعال، ڪئميرا وڊيو اسٽريمنگ آهي. جڏهن غير فعال، ڪئميرا اسٽريمنگ نه آهي. جڏهن اپڊيٽ ڪرڻ، ڪئميرا فرم ويئر کي اپڊيٽ ڪري رهيو آهي. |
حاصل ڪرڻ | 60 | فعال ۽ غير فعالI اپڊيٽ ڪرڻ | غير فعال |
| autoframing.state
ڪئميرا آٽو فريمنگ فيچر کي آن/آف ڪريو. |
حذف ڪرڻ | 19 | 110 | 0 |
| bluetooth.pairingStateToggle
جوڙڻ واري حالت کي آن/آف کان آف/ آن کي ٽوگل ڪريو. |
پوسٽ | C6 | N/A | N/A |
| bluetooth.pairingState
بلوٽوٿ جوڙڻ واري حالت. آن اسٽيٽ هڪ مقرر وقفي لاءِ ڊوائيس سان جوڙڻ جي اجازت ڏيندو. هڪ دفعو جوڙڻ جو وقفو ختم ٿي ويو آهي، رياست بند ٿي ويندي. |
لڳائڻ | 14 | 110 | 0 |
| bluetooth.state
بلوٽوٽ ۽ BLE اسٽيٽ. آن اسٽيٽ ظاهر ڪندو ته بلوٽوت ۽ BLE آن آهن؛ آف اسٽيٽ ظاهر ڪندو ته بلوٽوت ۽ BLE بند آهن. |
حاصل ڪرڻ | 67 | 110 | 0 |
| bluetooth.paired
جوڙيل ڊوائيس جو نالو. |
حاصل ڪرڻ | 6A | تار
(0-128 اکر) |
مقرر نه ڪيو |
| bluetooth.connected
جوڙيل ڊوائيس ڪنيڪشن جي حالت. |
حاصل ڪرڻ | 6B | 110 | 0 |
| bluetooth.stream اسٽيٽ
بلوٽوٿ جي اسٽريم اسٽيٽس. |
حاصل ڪرڻ | C2 | 110 | 0 |
| bluetooth.callState
بلوٽوٿ ڪال جي حالت. |
حاصل ڪرڻ | 6C | 110 | 0 |
| bluetooth.disconnect
بلوٽوٿ ڊوائيس ختم ڪريو. |
پوسٽ | E4 | 11213 | N/A |
| network.dhcpState
DHCP رياست. جڏهن DHCP اسٽيٽ تي آهي، نيٽ ورڪ DHCP ذريعي ترتيب ڏني ويندي. جڏهن DHCP رياست بند آهي، جامد قدر استعمال ڪيا ويندا آهن. |
حذف ڪرڻ | 74 | 110 | 1 |
| network.ip (VBl)
جامد IP پتو جڏهن DHCP رياست بند آهي. |
حذف ڪرڻ | 75 | (VBl ۾ سپورٽ ٿيل) 0.0.0.0 | |
| network.state (VBl)
Ethernet ماڊل جي حالت. |
حاصل ڪرڻ | 7F | بيڪار ناڪامي!
associationI configurationI readyI ڌار ڪريو! آن لائن |
(VBl ۾ سپورٽ) تيار |
| نالو / وضاحت | عمل | سي ايم ڊي ID | قدرن جي حد | ڊفالٽ قدر |
| network.mac (VBl)
LAN انٽرفيس جو MAC پتو. |
حاصل ڪرڻ | 80 | (VBl ۾ سپورٽ ٿيل) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP رياست. جڏهن DHCP اسٽيٽ تي آهي، وائي فائي DHCP ذريعي ترتيب ڏني ويندي. جڏهن DHCP رياست بند آهي، جامد قدر استعمال ڪيا ويندا آهن. |
حذف ڪرڻ | Al | 110 | 1 |
| wifi.ip
جامد IP پتو جڏهن DHCP رياست بند آهي. |
حذف ڪرڻ | A2 | 0.0.0.0 | |
| wifi.mac
وائي فائي انٽرفيس جو MAC پتو. |
حاصل ڪرڻ | AC | 00:00:00:00:00:00 | |
| wifi.state
وائي فائي ماڊل جي حالت. |
حاصل ڪرڻ | BO | بيڪار ناڪامي!
associationI configurationI readyI ڌار ڪريو! آن لائن |
بيڪار |
| telemetry.peopleCount (VBl)
ماڻهن جو تعداد ڪيمرا آٽو فريمنگ الگورٿم جي حساب سان. |
حذف ڪرڻ | DA | 0-99 | (VBl ۾ سپورٽ ٿيل) 0 |
| telemetry.peoplePresent (VBl)
اهو سچ آهي جڏهن ڪنهن به ماڻهو کي ڪيمرا آٽو فريمنگ الورورٿم طرفان ڳولي لڌو ويو آهي. |
حذف ڪرڻ | DC | 110 | (VBl ۾ سپورٽ ٿيل) 0 |
دستاويز / وسيلا
 |
BOSE ڪم آرام API ايپ [pdf] استعمال ڪندڙ ھدايت ڪم، باقي API، ايپ، ڪم باقي API ايپ |
