BOSE Work Rest API एप
परिचय
बोस भिडियोबार उपकरणहरूले नेटवर्क व्यवस्थापन र निगरानीको लागि प्रतिनिधित्वात्मक राज्य स्थानान्तरण अनुप्रयोग प्रोग्रामिङ इन्टरफेस (REST API) समर्थन गर्दछ। यो गाइडले भिडियोबार यन्त्रहरूमा REST API सक्षम र कन्फिगर गर्न निर्देशनहरू प्रदान गर्दछ, र यसले समर्थित चरहरू र सञ्चालनहरूको विस्तृत विवरण प्रदान गर्दछ।
कन्फिगरेसन वस्तुहरू र सञ्चालनहरू यी कोटीहरूमा समूहबद्ध छन्:
- प्रणाली
- व्यवहार
- usb
- अडियो
- क्यामेरा
- अडियोफ्रेमिङ
- ब्लुटुथ
- नेटवर्क (VBl)
- wifi
- टेलिमेट्री (VBl)
API आदेश सन्दर्भ खण्डले प्रत्येक वस्तुको लागि निम्न जानकारी प्रदान गर्दछ:
- नाम/विवरण वस्तुको नाम र यसको प्रयोगको विवरण।
- वस्तुमा गर्न सकिने कार्यहरू। कारबाही गर्न सक्छ
- निम्न मध्ये एक वा बढी हुनुहोस्: प्राप्त गर्नुहोस्, राख्नुहोस्, मेटाउनुहोस्, पोस्ट गर्नुहोस्।
- मानहरूको दायरा वस्तुको लागि स्वीकार्य मानहरू।
- पूर्वनिर्धारित मान वस्तुको पूर्वनिर्धारित मान। यदि तपाईंले यन्त्रलाई पूर्वनिर्धारित फ्याक्ट्रीमा उल्टाउनुभयो भने यो मान प्रयोग गरिन्छ।
सबै मानहरू स्ट्रिङको रूपमा निर्दिष्ट गरिएका छन्।
ट्रेडमार्क सूचनाहरू
- बोस, बोस वर्क, र भिडियोबार बोस कर्पोरेशनका ट्रेडमार्क हुन्।
- ब्लुटुथ" शब्द चिन्ह र लोगोहरू ब्लुटुथ SIG, Inc. को स्वामित्वमा दर्ता गरिएका ट्रेडमार्कहरू हुन् र Bose Corporation द्वारा त्यस्ता चिन्हहरूको कुनै पनि प्रयोग इजाजतपत्र अन्तर्गत छ।
- HDMI शब्द HDMI लाइसेन्सिङ एडमिनिस्ट्रेटर, Inc को ट्रेडमार्क वा दर्ता गरिएको ट्रेडमार्क हो।
- अन्य सबै ट्रेडमार्कहरू तिनीहरूका सम्बन्धित मालिकहरूको सम्पत्ति हुन्।
गोपनीयता जानकारी
तपाईंको गोपनीयता बोसको लागि महत्त्वपूर्ण छ त्यसैले हामीले तपाईंको व्यक्तिगत जानकारी कसरी सङ्कलन, प्रयोग, खुलासा, स्थानान्तरण र भण्डारण गर्छौं भन्ने कुरा समावेश गर्ने गोपनीयता नीति विकास गरेका छौं।
हामीले तपाइँको जानकारीलाई कसरी ह्यान्डल गर्छौं भनेर बुझ्नको लागि कृपया यो गोपनीयता नीति ध्यानपूर्वक पढ्नुहोस्। यदि तपाईं यो गोपनीयता नीतिमा सहमत हुनुहुन्न भने, कृपया सेवाहरू प्रयोग नगर्नुहोस्।
REST API सक्षम र कन्फिगर गर्दै
यन्त्रमा REST API मा पहुँच सक्षम गर्न, Bose Work Configuration एप, Bose Work Management एप, वा Web UI। नेटवर्क> API सेटिङहरू पहुँच गर्नुहोस्। API पहुँच सक्षम गर्नुहोस् र API प्रयोगकर्ता नाम र पासवर्ड निर्दिष्ट गर्नुहोस्। कुनै पनि REST API आदेशहरू प्रयोग गर्नका लागि तपाईंलाई यी API प्रमाणहरू आवश्यक पर्नेछ। थप जानकारीको लागि कृपया अनुप्रयोग प्रयोगकर्ता गाइडहरू सन्दर्भ गर्नुहोस्।
REST API परीक्षण गर्दै
तपाईंले यन्त्रमा इम्बेड गरिएको Swagger OpenAPI इन्टरफेस प्रयोग गरेर Videobar REST API परीक्षण गर्न सक्नुहुन्छ। यो इन्टरफेस पहुँच गर्न भिडियोबार यसको वायर्ड वा वाइफाइ इन्टरफेस मार्फत आईपी नेटवर्कमा जडान हुनुपर्छ, र तपाईंको होस्ट पीसी एउटै नेटवर्क वा HTTPS मार्फत उपकरण पहुँच गर्न सक्ने नेटवर्कमा हुनुपर्छ।
USB इन्टरफेस मार्फत आफ्नो पीसी भिडियोबारमा जडान गर्नुहोस्। Bose कार्य कन्फिगरेसन एप सुरु गर्नुहोस् र प्रशासक नियन्त्रणहरू पहुँच गर्न साइन इन गर्नुहोस्। नेटवर्क > API पृष्ठ छान्नुहोस् र लिङ्क क्लिक गर्नुहोस्:
REST API कागजात (Web UI)
यदि तपाइँ USB मार्फत उपकरणमा जडान हुनुहुन्न र तपाइँको PC उही नेटवर्कमा छ भने, तपाइँ निम्न ठेगानामा ब्राउज गरेर तपाइँको ब्राउजर मार्फत REST API पहुँच गर्न सक्नुहुन्छ:
https://<videobar-ip-address>/doc-api
REST API आदेशहरू
Videobar REST API इन्टरफेसले समर्थित चार HTTP विधिहरू मध्ये प्रत्येकमा कमाण्ड ID प्रयोग गर्दछ: प्राप्त गर्नुहोस्, राख्नुहोस्, मेटाउनुहोस्, र पोस्ट गर्नुहोस्।
तल प्रत्येक आदेशको लागि समर्थित विधिहरू वर्णन गर्ने तालिकाको पछि चार विधिहरूको वर्णन छ।
प्राप्त गर्नुहोस्
"प्राप्त गर्नुहोस्" विधिले एकल कमाण्ड आईडी वा बहुविरामले छुट्याइएको आईडीहरू स्वीकार गर्दछ। पूर्वका लागिample, audio.micMute स्थिति प्राप्त गर्न, आदेश ID 2 हो URL यो जस्तै छ:
https://192.168.1.40/api?query=2
प्रतिक्रिया मुख्य भाग निम्नानुसार छ, "O" को मानको साथ माइक म्यूट गरिएको छैन भनेर संकेत गर्दछ:
{"2": {"स्थिति": "सफलता", "मान": "०"}}
बहुविध मानहरूको लागि क्वेरी गर्न, अल्पविरामले धेरै कमाण्ड आईडीहरू अलग गर्नुहोस्। पूर्वका लागिample, तपाईंले audio.micMute (ID=2) र system.firmwareVersion (ID=l6) को लागि सोध्न सक्नुहुन्छ:
https://192.168.1.40/api?query=2,16
नोट: धेरै आईडीहरू बीच खाली ठाउँहरू समावेश नगर्नुहोस्।
परिणाम हुनेछ:
{“2”: {“स्थिति”: “सफलता”, “मान”: “0”}, “16”: {“स्थिति”: “सफलता”, “मान”: “1.2.13_fd6cc0e”}}
PUT
एउटा "पुट" कमाण्डले JSON बडी ढाँचा प्रयोग गर्दछ जसमा कुञ्जी "डेटा" र मान ID: मान जोडीहरू।
पूर्वका लागिample, audio.loudspeakerVolume (ID=3) लाई 39 मा सेट गर्न, "https://192.168.1.40/ api" मुख्य भाग हो:
{“डेटा”:”{“३″:”३९″}”}
प्रतिक्रिया यस्तो छ:
{“३”: {“स्थिति”: “सफलता”, “कोड”: “०xe3”}}
यहाँ एक पूर्व छampले धेरै मानहरू सेट गर्दै:
{“डेटा”:”{“2″:”1″,”3″:”70″}”}
प्रतिक्रिया यस्तो छ:
{“2”: {“स्थिति”: “सफलता”, “कोड”: “0xe000”}, “3”: {“स्थिति”: “सफलता”, “कोड”: “0xe000”}}
प्रतिक्रिया "कोड" मानहरू निम्न मध्ये कुनै पनि हुन सक्छ:
- 0xe000 : सफलता
- 0xe001 : सफलता - मानमा कुनै परिवर्तन छैन
- 0xe002 : त्रुटि - अवैध गुण
- 0xe003 : त्रुटि - अवैध गुण मान
- 0xe004 : त्रुटि - अवैध गुण कार्य
- 0xe005 : त्रुटि - सन्देश विकृत
- 0xe006: त्रुटि - पहुँच अस्वीकार गरियो
POST
"पोस्ट" "पुट" जस्तै हो र माइक म्युट र स्पिकर भोल्युम माथि/डाउन टगल गर्ने जस्ता कार्यहरूको लागि प्रयोग गरिन्छ। तपाईंले कमाण्ड ID निर्दिष्ट गर्नुहोस् र मानको लागि खाली स्ट्रिङ प्रयोग गर्नुहोस्।
पूर्वका लागिample, स्पिकर भोल्युम बढाउनको लागि एक टिक, यस प्रकारको बडी ढाँचामा audio.loudspeakerVolumeUp (ID=4) प्रयोग गर्नुहोस्:
{“डेटा”:”{“४″:””}”}
प्रतिक्रिया निकाय हो:
{“३”: {“स्थिति”: “सफलता”, “कोड”: “०xe4”}}
सम्भावित प्रतिक्रिया "कोड" मानहरू PUT आदेशको लागि सूचीबद्ध गरिएका समान हुन्।
मेट्नुहोस्
"मेट्नुहोस्" आदेश ढाँचा "प्राप्त" जस्तै छ, र प्रतिक्रिया शरीर "पुट" जस्तै छ। मेटाउने प्रयोगले यसको पूर्वनिर्धारित मान सेट गर्नेछ।
पूर्वका लागिample, audio.loudspeaker भोल्युम (ID=3) लाई यसको पूर्वनिर्धारित मानमा सेट गर्न, URL यो जस्तै छ:
https://192.168.1.40/api?delete=3
प्रतिक्रिया निकाय हो:
{“३”: {“स्थिति”: “सफलता”, “कोड”: “०xe3”}}
तपाईंले नयाँ मान पुन: प्राप्त गर्न "प्राप्त" जारी गर्न आवश्यक छ, जुन यस अवस्थामा ५० हो। पूर्वका लागिampLe:
आदेश:
https://192.168.1.40/api?query=3
प्रतिक्रिया:
{"3": {"स्थिति": "सफलता", "मान": "०"}}
सम्भावित प्रतिक्रिया "कोड" मानहरू PUT आदेशको लागि सूचीबद्ध गरिएका समान हुन्
Videobar REST API आदेश सन्दर्भ
| नाम/विवरण | कार्यहरू | Cmd ID | मानहरूको दायरा | पूर्वनिर्धारित मान |
| system.reboot
प्रणाली रिबुट गर्दछ। |
पोस्ट | 32 | N/A | N/A |
| system.serialNumber
यन्त्रको क्रम संख्या। |
प्राप्त गर्नुहोस् | 10 | तार
(१७ वर्ण) |
ooooooooooooooxx |
| system.firmwareVersion
यन्त्रमा चलिरहेको फर्मवेयरको संस्करण। यो प्रणाली फर्मवेयर अपग्रेडमा स्वचालित रूपमा सेट गरिएको छ। |
प्राप्त गर्नुहोस् | 16 | तार
(१-१६ वर्ण) |
0.0.0 |
| प्रणाली मोडेल
यस उपकरणको मोडेल। |
प्राप्त गर्नुहोस् | D6 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| system.name
यन्त्रको नाम ताकि यसलाई विशिष्ट रूपमा पहिचान गर्न सकिन्छ। |
मेटाउन पाउनुहोस् | 25 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| प्रणाली कोठा
उपकरणको कोठा स्थान |
मेटाउन पाउनुहोस् | 26 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| system.floor
यन्त्रको भुइँ स्थान। |
मेटाउन पाउनुहोस् | 27 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| system.building
उपकरणको निर्माण स्थान। |
मेटाउन पाउनुहोस् | 28 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| system.gpiMuteStatus (VBl)
GPI मौन स्थिति (अन/अफ)। |
प्राप्त गर्नुहोस् | C7 | 110 | (VBl मा समर्थित) 0 |
| system.maxOccupancy
यन्त्रको कोठा अधिकतम अधिभोग। |
मेटाउन पाउनुहोस् | DF | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| behavior.ethernetEnabled (VBl)
प्रणाली इथरनेट इन्टरफेस खोल्छ / बन्द गर्दछ। |
मेटाउन पाउनुहोस् | 38 | 110 | (VBl मा समर्थित) 1 |
| behavior.bluetoothEnabled
प्रणाली ब्लुटुथ अन/अफ गर्छ। |
मेटाउन पाउनुहोस् | 3A | 110 | 1 |
| behavior.wifi सक्षम
प्रणाली वाइफाइ अन/अफ गर्छ। |
मेटाउन पाउनुहोस् | 3B | 110 | 1 |
| behavior.hdmiEnabled (VBl)
HDMI अन/अफ गर्छ। |
मेटाउन पाउनुहोस् | C9 | 110 | (VBl मा समर्थित) 0 |
| usb.connectionStatus
USB केबल जडान स्थिति; ० विच्छेद हुँदा। |
प्राप्त गर्नुहोस् | 36 | 110 | 0 |
| usb.callStatus
प्रणालीको USB पोर्टमा जडान भएको होस्टबाट कल स्थिति। |
प्राप्त गर्नुहोस् | 37 | 110 | 0 |
| audio.micMute
प्रणाली माइक्रोफोनलाई म्यूट/अनम्युट गर्दछ। |
राख्नु | 2 | 110 | 0 |
| audio.micMuteToggle
प्रणाली माइक्रोफोनको मौन अवस्था टगल गर्दछ। |
पोस्ट | 15 | N/A | N/A |
| नाम/विवरण | कार्यहरू | Cmd 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 |
| camera.zoom
क्यामेराको हालको जुम मान। |
मेटाउन पाउनुहोस् | 6 | 1-10 | 1 |
| क्यामेरा प्यान
क्यामेराको हालको प्यान मान। |
मेटाउन पाउनुहोस् | 7 | -६२१-००१८३७.००२ | 0 |
| क्यामेरा टिल्ट
क्यामेराको हालको झुकाव मान। |
मेटाउन पाउनुहोस् | 8 | -६२१-००१८३७.००२ | 0 |
| camera.zoom इन
क्यामेरालाई एक चरणमा जुम इन गर्नुहोस्। |
पोस्ट | 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 |
| नाम/विवरण | कार्यहरू | Cmd 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 | तार
(१-१६ वर्ण) |
तयार भएको छैन |
| 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)
DHCP स्थिति बन्द हुँदा स्थिर IP ठेगाना। |
मेटाउन पाउनुहोस् | 75 | (VBl मा समर्थित) 0.0.0.0 | |
| network.state (VBl)
इथरनेट मोड्युलको अवस्था। |
प्राप्त गर्नुहोस् | 7F | निष्क्रिय असफलता!
associationI कन्फिगरेसनI तैयारI जडान विच्छेद! अनलाइन |
(VBl मा समर्थित) तयार छ |
| नाम/विवरण | कार्यहरू | Cmd ID | मानहरूको दायरा | पूर्वनिर्धारित मान |
| network.mac (VBl)
LAN इन्टरफेसको MAC ठेगाना। |
प्राप्त गर्नुहोस् | 80 | (VBl मा समर्थित) 00:00:00:00:00:00 | |
| wifi.dhcpState
DHCP राज्य। DHCP स्थिति सक्रिय हुँदा, WiFi DHCP मार्फत कन्फिगर हुनेछ। जब DHCP स्थिति बन्द हुन्छ, स्थिर मानहरू प्रयोग गरिन्छ। |
मेटाउन पाउनुहोस् | Al | 110 | 1 |
| wifi.ip
DHCP स्थिति बन्द हुँदा स्थिर IP ठेगाना। |
मेटाउन पाउनुहोस् | A2 | 0.0.0.0 | |
| wifi.mac
वाइफाइ इन्टरफेसको MAC ठेगाना। |
प्राप्त गर्नुहोस् | AC | 00:00:00:00:00:00 | |
| wifi.state
WiFi मोड्युलको अवस्था। |
प्राप्त गर्नुहोस् | BO | निष्क्रिय असफलता!
associationI कन्फिगरेसनI तैयारI जडान विच्छेद! अनलाइन |
निष्क्रिय |
| telemetry.peopleCount (VBl)
क्यामेरा अटोफ्रेमिङ एल्गोरिदमद्वारा गणना गरिएका व्यक्तिहरूको सङ्ख्या। |
मेटाउन पाउनुहोस् | DA | 0-99 | (VBl मा समर्थित) 0 |
| telemetry.peoplePresent (VBl)
जब कुनै पनि व्यक्ति क्यामेरा अटोफ्रेमिङ एल्गोरिथ्म द्वारा पत्ता लगाइएको छ। |
मेटाउन पाउनुहोस् | DC | 110 | (VBl मा समर्थित) 0 |
कागजातहरू / स्रोतहरू
 |
BOSE Work Rest API एप [pdf] प्रयोगकर्ता गाइड कार्य, विश्राम API, अनुप्रयोग, कार्य विश्राम API अनुप्रयोग |
