BOSE ورک ریسٹ API ایپ

تعارف

بوس ویڈیو بار ڈیوائسز نیٹ ورک مینجمنٹ اور مانیٹرنگ کے لیے نمائندہ اسٹیٹ ٹرانسفر ایپلیکیشن پروگرامنگ انٹرفیس (REST API) کی حمایت کرتی ہیں۔ یہ گائیڈ ویڈیو بار ڈیوائسز پر REST API کو فعال اور ترتیب دینے کے لیے ہدایات فراہم کرتا ہے، اور یہ معاون متغیرات اور آپریشنز کی تفصیلی وضاحت فراہم کرتا ہے۔
کنفیگریشن آئٹمز اور آپریشنز کو ان زمروں میں گروپ کیا گیا ہے:

• نظام
• سلوک
• USB
• آڈیو
• کیمرے
• آڈیو فریمنگ
• بلوٹوتھ
• نیٹ ورک (VBl)
• وائی ​​فائی
• ٹیلی میٹری (VBl)

API کمانڈ ریفرنس سیکشن ہر چیز کے لیے درج ذیل معلومات فراہم کرتا ہے۔

• نام/تفصیل آبجیکٹ کا نام اور اس کے استعمال کی تفصیل۔
• اعمال وہ اعمال جو اعتراض پر کیے جاسکتے ہیں۔ عمل ہو سکتا ہے۔
• درج ذیل میں سے ایک یا زیادہ ہو: حاصل کریں، ڈالیں، حذف کریں، پوسٹ کریں۔
• قدروں کی حد آبجیکٹ کے لیے قابل قبول اقدار۔
• ڈیفالٹ ویلیو آبجیکٹ کی ڈیفالٹ ویلیو۔ یہ وہ قدر ہے جو استعمال ہوتی ہے اگر آپ آلے کو فیکٹری ڈیفالٹس پر لوٹاتے ہیں۔
  تمام اقدار کو تار کے طور پر بیان کیا گیا ہے۔

ٹریڈ مارک نوٹس

• بوس، بوس ورک، اور ویڈیو بار بوس کارپوریشن کے ٹریڈ مارک ہیں۔
• The Bluetooth” لفظ کے نشان اور لوگوز بلوٹوتھ SIG, Inc. کی ملکیت والے رجسٹرڈ ٹریڈ مارک ہیں اور بوس کارپوریشن کی طرف سے ایسے نشانات کا کوئی بھی استعمال لائسنس کے تحت ہے۔
• ایچ ڈی ایم آئی کی اصطلاح ایچ ڈی ایم آئی لائسنسنگ ایڈمنسٹریٹر ، انکارپوریٹڈ کا ٹریڈ مارک یا رجسٹرڈ ٹریڈ مارک ہے۔
• دیگر تمام ٹریڈ مارک ان کے متعلقہ مالکان کی ملکیت ہیں۔

رازداری کی معلومات

بوس کے لیے آپ کی پرائیویسی اہم ہے اس لیے ہم نے ایک پرائیویسی پالیسی تیار کی ہے جس میں اس بات کا احاطہ کیا گیا ہے کہ ہم آپ کی ذاتی معلومات کو کیسے اکٹھا کرتے ہیں، استعمال کرتے ہیں، افشاء کرتے ہیں، منتقل کرتے ہیں اور محفوظ کرتے ہیں۔
یہ سمجھنے کے لیے کہ ہم آپ کی معلومات کو کیسے ہینڈل کرتے ہیں، براہ کرم اس پرائیویسی پالیسی کو غور سے پڑھیں۔ اگر آپ اس رازداری کی پالیسی سے اتفاق نہیں کرتے ہیں، تو براہ کرم خدمات کا استعمال نہ کریں۔

REST API کو فعال اور کنفیگر کرنا

کسی ڈیوائس پر REST API تک رسائی کو فعال کرنے کے لیے، Bose Work Configuration ایپ، Bose Work Management ایپ، یا Web UI نیٹ ورک> API سیٹنگز تک رسائی حاصل کریں۔ API رسائی کو فعال کریں اور API صارف نام اور پاس ورڈ کی وضاحت کریں۔ REST API کمانڈز میں سے کسی کو استعمال کرنے کے لیے آپ کو ان API اسناد کی ضرورت ہوگی۔ مزید معلومات کے لیے براہ کرم ایپلیکیشن صارف گائیڈز کا حوالہ دیں۔

REST API کی جانچ کرنا

آپ ویڈیو بار ریسٹ API کو سویگر اوپن اے پی آئی انٹرفیس استعمال کرکے جانچ سکتے ہیں جو ڈیوائس میں سرایت کرتا ہے۔ اس انٹرفیس تک رسائی حاصل کرنے کے لیے ویڈیو بار کا کسی IP نیٹ ورک سے اس کے وائرڈ یا وائی فائی انٹرفیس کے ذریعے منسلک ہونا ضروری ہے، اور آپ کا میزبان پی سی اسی نیٹ ورک یا نیٹ ورک پر ہونا چاہیے جو HTTPS کے ذریعے ڈیوائس تک رسائی حاصل کر سکے۔
USB انٹرفیس کے ذریعے اپنے پی سی کو ویڈیو بار سے جوڑیں۔ بوس ورک کنفیگریشن ایپ شروع کریں اور ایڈمن کنٹرولز تک رسائی کے لیے سائن ان کریں۔ نیٹ ورک > API صفحہ منتخب کریں اور لنک پر کلک کریں:
REST API دستاویزات (Web UI)
اگر آپ USB کے ذریعے ڈیوائس سے منسلک نہیں ہیں اور آپ کا پی سی اسی نیٹ ورک پر ہے، تو آپ درج ذیل پتے پر براؤز کر کے اپنے براؤزر کے ذریعے REST API تک رسائی حاصل کر سکتے ہیں:
https://<videobar-ip-address>/doc-api

REST API کمانڈز

Videobar REST API انٹرفیس تعاون یافتہ HTTP طریقوں میں سے ہر ایک میں کمانڈ IDs استعمال کرتا ہے: حاصل کریں، ڈالیں، حذف کریں، اور پوسٹ کریں۔
ذیل میں چار طریقوں کی تفصیل دی گئی ہے جس کے بعد ایک ٹیبل ہر ایک کمانڈ کے لیے معاون طریقوں کی وضاحت کرتا ہے۔

حاصل کریں۔

"حاصل کریں" کا طریقہ ایک واحد کمانڈ ID یا متعدد کوما سے الگ کردہ IDs کو قبول کرتا ہے۔ سابق کے لیےample، audio.micMute حالت حاصل کرنے کے لیے، کمانڈ ID 2 ہے۔ URL اس طرح ہے:
https://192.168.1.40/api?query=2  

رسپانس باڈی مندرجہ ذیل ہے، "O" کی قدر کے ساتھ یہ بتاتا ہے کہ مائیک خاموش نہیں ہے:
{"2": {"سٹیٹس": "کامیابی"، "قدر": "0"}}

متعدد اقدار کے لیے استفسار کرنے کے لیے، ایک سے زیادہ کمانڈ ID کو کوما سے الگ کریں۔ سابق کے لیے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"}}

ڈالو

ایک "put" کمانڈ JSON باڈی فارمیٹ کا استعمال کرتی ہے جس میں کلید "ڈیٹا" ہے اور قدر ID: قدر کے جوڑے ہیں۔
سابق کے لیے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 کی وضاحت کرتے ہیں اور قدر کے لیے خالی سٹرنگ استعمال کرتے ہیں۔
سابق کے لیےample، اسپیکر والیوم کو ایک ٹک بڑھانے کے لیے، اس طرح باڈی فارمیٹ کے ساتھ 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 کمانڈ کے لئے درج ہیں۔

Videobar REST API کمانڈ کا حوالہ

نام/تفصیل	اعمال	سی ایم ڈی ID	اقدار کی حد	ڈیفالٹ قدر
system.reboot سسٹم کو ریبوٹ کرتا ہے۔	پوسٹ	32	N/A	N/A
system.serialNumber ڈیوائس کا سیریل نمبر۔	حاصل کریں	10	تار (17 حروف)	ooooooooooooooxx
system.firmwareVersion ڈیوائس پر چلنے والے فرم ویئر کا ورژن۔ یہ سسٹم فرم ویئر اپ گریڈ پر خود بخود سیٹ ہوجاتا ہے۔	حاصل کریں	16	تار (1-16 حروف)	0.0.0
سسٹم ماڈل اس ڈیوائس کا ماڈل۔	حاصل کریں	D6	تار (1-22 حروف)	سیٹ نہیں ہے
system.name ڈیوائس کا نام تاکہ اس کی منفرد شناخت کی جاسکے۔	حذف کریں	25	تار (1-22 حروف)	سیٹ نہیں ہے
سسٹم روم ڈیوائس کے کمرے کا مقام	حذف کریں	26	تار (0-128 حروف)	سیٹ نہیں ہے
system.floor ڈیوائس کا فرش کا مقام۔	حذف کریں	27	تار (0-128 حروف)	سیٹ نہیں ہے
system.building ڈیوائس کی عمارت کا مقام۔	حذف کریں	28	تار (0-128 حروف)	سیٹ نہیں ہے
system.gpiMuteStatus (VBl) GPI خاموش حالت (آن/آف)۔	حاصل کریں	C7	110	(VBl میں تعاون یافتہ) 0
system.max Occupancy کمرے میں ڈیوائس کا زیادہ سے زیادہ قبضہ۔	حذف کریں	DF	تار (0-128 حروف)	سیٹ نہیں ہے
behavior.ethernetEnabled (VBl) سسٹم ایتھرنیٹ انٹرفیس کو آن/آف کرتا ہے۔	حذف کریں	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.loudspeaker والیوم سسٹم لاؤڈ اسپیکر والیوم سیٹ کرتا ہے۔	حذف کریں	3	0-100	50
audio.loudspeakerVolumeUp سسٹم لاؤڈ اسپیکر والیوم کو ایک قدم بڑھاتا ہے۔	پوسٹ	4	N/A	N/A
audio.loudspeakerVolumeDown سسٹم لاؤڈ اسپیکر والیوم کو ایک قدم سے کم کرتا ہے۔	پوسٹ	5	N/A	N/A
camera.zoom کیمرے کی موجودہ زوم قدر۔	حذف کریں	6	1-10	1
کیمرہ پین کیمرے کی موجودہ پین کی قدر۔	حذف کریں	7	-10-10	0
camera.tilt کیمرے کی موجودہ جھکاؤ کی قدر۔	حذف کریں	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 پیش سیٹ پین ٹیلٹ زوم آرڈر میں کیمرہ دوسرا پیش سیٹ۔	حذف کریں	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 ایکٹو پری سیٹ فعال پیش سیٹ کو PTZ سیٹنگز پر لاگو کرتا ہے۔	پوسٹ	OF	N/A	N/A
camera.active پیش سیٹ یہ فعال پیش سیٹ ہے۔ نوٹ، کیمرہ شروع ہونے یا دوبارہ شروع کرنے پر ایکٹو پری سیٹ ہوم پر سیٹ ہوتا ہے۔	حذف کریں	13	11213	1
camera.state کیمرے کی حالت۔ فعال ہونے پر، کیمرہ ویڈیو سٹریم کر رہا ہے۔ غیر فعال ہونے پر، کیمرہ اسٹریم نہیں ہوتا ہے۔ اپ گریڈ کرتے وقت، کیمرہ فرم ویئر کو اپ گریڈ کر رہا ہے۔	حاصل کریں	60	فعال میں غیر فعال میں اپ گریڈ کر رہا ہوں۔	غیر فعال
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.streamState بلوٹوتھ کی اسٹریم کی حیثیت۔	حاصل کریں	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) ایتھرنیٹ ماڈیول کی حالت۔	حاصل کریں	7F	بیکار ناکامی! associationI configurationI تیار منقطع! آن لائن	(VBl میں تعاون یافتہ) تیار ہے۔

نام/تفصیل	اعمال	سی ایم ڈی ID	اقدار کی حد	ڈیفالٹ قدر
network.mac (VBl) LAN انٹرفیس کا میک ایڈریس۔	حاصل کریں	80		(VBl میں تعاون یافتہ) 00:00:00:00:00:00
wifi.dhcpState DHCP ریاست۔ DHCP حالت آن ہونے پر، WiFi کو DHCP کے ذریعے ترتیب دیا جائے گا۔ جب DHCP حالت آف ہو، جامد قدریں استعمال کی جاتی ہیں۔	حذف کریں	Al	110	1
wifi.ip جامد IP ایڈریس جب DHCP حالت آف ہو۔	حذف کریں	A2		0.0.0.0
wifi.mac وائی ​​فائی انٹرفیس کا میک ایڈریس۔	حاصل کریں	AC		00:00:00:00:00:00
wifi.state وائی ​​فائی ماڈیول کی حالت۔	حاصل کریں	BO	بیکار ناکامی! associationI configurationI تیار منقطع! آن لائن	بیکار
telemetry.peopleCount (VBl) کیمرہ آٹو فریمنگ الگورتھم کے ذریعے گننے والے لوگوں کی تعداد۔	حذف کریں	DA	0-99	(VBl میں تعاون یافتہ) 0
telemetry.peoplePresent (VBl) درست ہے جب کیمرے آٹو فریمنگ الگورتھم کے ذریعہ کسی بھی لوگوں کا پتہ چلا ہو۔	حذف کریں	DC	110	(VBl میں تعاون یافتہ) 0

دستاویزات / وسائل

BOSE ورک ریسٹ API ایپ [پی ڈی ایف] یوزر گائیڈ ورک، ریسٹ API، ایپ، ورک ریسٹ API ایپ

حوالہ جات

• صارف دستی