स्थानीय API

स्थानीय API आपके OBS ओवरले के साथ ओवरले पोर्ट पर एक ही सर्वर साझा करता है। यह केवल इसी कंप्यूटर पर चलने वाले प्रोग्रामों को उत्तर देता है, और केवल तब जब वे आपका एक्सेस टोकन ले जाते हैं।

स्थानीय API चालू करें

टोकन जनरेट करें टोकन को बदल देता है। पुराने टोकन का उपयोग करने वाली प्रत्येक स्क्रिप्ट तुरंत डिस्कनेक्ट हो जाती है, जबकि ओवरले और आपके लाइव कनेक्शन चलते रहते हैं। आप अपना स्वयं का टोकन भी टाइप कर सकते हैं: 32 से 256 अक्षर, अंक, डैश या अंडरस्कोर।

पोर्ट उसी कार्ड में साझा सर्वर पोर्ट के रूप में रहता है। आपके द्वारा Vfinity को पुनरारंभ करने के बाद एक नया पोर्ट प्रभावी होता है। यदि लॉन्च के समय पोर्ट व्यस्त है, तो Vfinity दूसरा चुनता है और कार्ड वह पता दिखाता है जिसका वह वास्तव में उपयोग करता है।

अनुरोधों की जाँच कैसे की जाती है

प्रत्येक HTTP अनुरोध और प्रत्येक WebSocket कनेक्शन को इस हेडर की आवश्यकता होती है:

Authorization: Bearer YOUR_TOKEN

जब कोई अनुरोध किसी अन्य कंप्यूटर से आता है, जब टोकन गायब या गलत होता है, या जब वह ब्राउज़र Origin हेडर ले जाता है, तो अनुरोध अस्वीकार कर दिया जाता है। उस अंतिम नियम का अर्थ है कि कोई वेब पेज API को कॉल नहीं कर सकता है, भले ही वह इस कंप्यूटर पर खुला हो। एक डेस्कटॉप स्क्रिप्ट या टूल का उपयोग करें जो हेडर सेट कर सकता है।

किसी अन्य PC पर OBS के लिए ओवरले एक्सेस चालू करने से नेटवर्क पर API नहीं खुलता है, और ओवरले एक्सेस कुंजी API टोकन नहीं है।

API के उत्तर देने के लिए Vfinity का चलना आवश्यक है। ट्रे में छिपा हुआ भी गिना जाता है; आपके छोड़ने के बाद, कुछ भी नहीं सुन रहा होता है।

HTTP पर अनुरोध भेजें

प्रत्येक POST के साथ Content-Type: application/json भेजें। बॉडी 64 KiB तक हो सकती है।

# मैं क्या चला सकता हूँ?
curl -H "Authorization: Bearer YOUR_TOKEN" http://127.0.0.1:21424/api/state

# सबथॉन टाइमर में 30 सेकंड जोड़ें
curl -X POST http://127.0.0.1:21424/api/command \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"timer.add","args":30}'

$headers = @{ Authorization = "Bearer YOUR_TOKEN" }

# मैं क्या चला सकता हूँ?
Invoke-RestMethod -Uri http://127.0.0.1:21424/api/state -Headers $headers

# सबथॉन टाइमर में 30 सेकंड जोड़ें
Invoke-RestMethod -Method Post -Uri http://127.0.0.1:21424/api/command `
  -Headers $headers -ContentType "application/json" `
  -Body '{"name":"timer.add","args":30}'

अपने किसी इवेंट को ट्रिगर करें

किसी इवेंट को API ट्रिगर और एक ट्रिगर का नाम दें, फिर उस नाम को /api/trigger पर पोस्ट करें। नाम केस की परवाह किए बिना मेल खाता है।

curl -X POST http://127.0.0.1:21424/api/trigger \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"raid_alarm","data":{"message":"Raid incoming","level":3}}'

data में प्रत्येक फ़ील्ड एक टेम्प्लेट वेरिएबल बन जाता है जिसे इवेंट के स्टेप्स उपयोग कर सकते हैं, इसलिए {message} वाला एक स्पीच स्टेप "Raid incoming" पढ़ता है। टेक्स्ट, नंबर और true या false मान गुजरते हैं; नेस्टेड ऑब्जेक्ट और सूचियाँ नहीं। फ़ील्ड नाम एक अक्षर से शुरू होना चाहिए, और पहले 50 फ़ील्ड गिने जाते हैं।

उत्तर {"ok":true} का अर्थ है कि Vfinity ने ट्रिगर स्वीकार कर लिया। जो इवेंट बंद है, रुका हुआ है, या अपने कूलडाउन द्वारा रोका गया है, वह अभी भी कुछ नहीं करता है, इसलिए यदि आपको यह जानने की आवश्यकता है कि क्या चला तो WebSocket पर actionResult को सुनें।

एक कमांड चलाएँ

कमांड वही नामित एक्शन हैं जिनका उपयोग हॉटकी, क्विक डेक पैड्स और कमांड स्टेप्स करते हैं। GET /api/state उन कमांड्स को सूचीबद्ध करता है जो यह बिल्ड अभी पेश करता है, क्योंकि कुछ केवल तभी मौजूद होते हैं जब ऐप का उनका भाग चल रहा हो।

{ "name": "control.panic" }
{ "name": "deck.press", "args": "Applause" }
{ "name": "giveaway.draw" }
{ "name": "sceneCard.showBrb" }
{ "name": "mapping.trigger", "args": "YOUR_EVENT_ID" }

mapping.trigger आपके किसी एक इवेंट को ऐसे चलाता है जैसे कि उसका ट्रिगर चालू हो गया हो, और उत्तर देता है कि उसने कितने रन शुरू किए। यह किसी इवेंट की ID या API ट्रिगर का नाम लेता है। ID प्राप्त करने के लिए, Events टैब पर इवेंट पर राइट-क्लिक करें और इवेंट ID कॉपी करें चुनें।

प्रत्येक कमांड को उसके तर्क के साथ कमांड में सूचीबद्ध किया गया है।

किसी स्क्रिप्ट से TikTok LIVE कनेक्ट करें

{
  "name": "tiktok.connect",
  "args": { "username": "yourname", "autoRejoin": true, "waitForLive": true }
}

उत्तर {"ok":true,"result":{"accepted":true}} का अर्थ है कि अनुरोध कतारबद्ध किया गया था, न कि LIVE से जुड़ा गया था। /api/state के tiktok भाग, या WebSocket पर tiktokStatus को देखें: Vfinity के LIVE में होने पर room.state "connected" पढ़ता है।

WebSocket पर सुनें

समान Authorization हेडर के साथ ws://127.0.0.1:21424/api/ws से कनेक्ट करें। आप HTTP की तरह ही समान अनुरोध भेज सकते हैं, प्रत्येक आपके द्वारा चुने गए requestId के साथ, और Vfinity आपकी स्ट्रीम पर होने वाली गतिविधियों को आपके पास वापस स्ट्रीम करता है।

// npm install ws
const WebSocket = require('ws');

const socket = new WebSocket('ws://127.0.0.1:21424/api/ws', {
  headers: { Authorization: 'Bearer YOUR_TOKEN' },
});

socket.on('open', () => {
  socket.send(JSON.stringify({ type: 'command', name: 'timer.add', args: 30, requestId: '1' }));
});

socket.on('message', (raw) => {
  const message = JSON.parse(raw);
  if (message.type === 'event' && message.event === 'gift') {
    console.log(`${message.data.nickname} sent ${message.data.giftName}`);
  }
  if (message.type === 'response') console.log(message.requestId, message.data);
});

आप क्या भेजते हैं

{ "type": "state", "requestId": "1" }
{ "type": "command", "name": "timer.add", "args": 30, "requestId": "2" }
{ "type": "trigger", "name": "raid_alarm", "data": {}, "requestId": "3" }

प्रत्येक को एक उत्तर मिलता है: {"type":"response","requestId":"2","data":{"ok":true}}।

Vfinity क्या भेजता है

एक उपहार जो कॉम्बो का हिस्सा है (giftType 1) कॉम्बो चलने के दौरान अपडेट भेजता है। इस पर केवल तभी कार्रवाई करें जब repeatEnd false न हो, जैसा Vfinity करता है। टाइमस्टैम्प यूनिक्स मिलीसेकंड हैं।

स्ट्रीम केवल लाइव है: कुछ भी दोहराया नहीं जाता है, और जो क्लाइंट बहुत धीमी गति से पढ़ता है वह संदेशों से चूक सकता है।

सीमाएँ और त्रुटियाँ

साधारण बैकअप टोकन को छोड़ देते हैं और API बंद होने के साथ रिस्टोर होते हैं। इसे बनाए रखने के लिए बैकअप लेते समय पासवर्ड और टोकन शामिल करें पर टिक करें।

इसके बजाय Vfinity को आपसे कनेक्ट होने दें

ट्रिगर API कार्ड, जो उन्नत के अंतर्गत भी है, कनेक्शन को उलट देता है: Vfinity आपके द्वारा चलाए जाने वाले WebSocket सर्वर से एक क्लाइंट के रूप में कनेक्ट होता है। यह पहले से मौजूद सर्वर (जैसे कोई गेम या बॉट) के लिए उपयुक्त है।

ट्रिगर API चालू करें, WebSocket होस्ट और WebSocket पोर्ट दर्ज करें, फिर API कनेक्ट करें पर क्लिक करें। आपका सर्वर तब भेज सकता है:

{ "type": "trigger", "name": "raid_alarm", "data": { "message": "Raid incoming" } }
{ "type": "command", "name": "timer.add", "args": 30, "requestId": "abc-1" }
{ "type": "request", "requestType": "event_list", "requestId": "abc-2" }

requestId वाले कमांड को ऐसा उत्तर मिलता है जैसे कि {"type":"response","requestType":"command","requestId":"abc-1","data":{"name":"timer.add","ok":true}}। event_list प्रत्येक इवेंट के साथ उत्तर देता है जिसमें API ट्रिगर है, इसके स्टेप्स और क्या यह चालू है, और stats कनेक्शन स्थिति और इवेंट गणना के साथ उत्तर देता है।

जो कुछ भी आपके सर्वर तक पहुँच सकता है वह इन कमांड को चला सकता है, इसलिए सर्वर को इसी कंप्यूटर पर रखें या इसके सामने अपना स्वयं का प्रमाणीकरण रखें।

संबंधित