Pavlov TV API - Revision history

Parl4224h: Added TOC and link to openapi spec

2024-12-07T16:53:43Z

Added TOC and link to openapi spec

← Older revision		Revision as of 11:53, 7 December 2024
Line 1:		Line 1:
	Pavlov TV has exposed endpoints to allow users to create their own UI interface for use in steaming software such as OBS, data-sets, or any other purpose of your choosing from Pavlov replays.		Pavlov TV has exposed endpoints to allow users to create their own UI interface for use in steaming software such as OBS, data-sets, or any other purpose of your choosing from Pavlov replays.

			__TOC__

	=== Enable the API ===		=== Enable the API ===
Line 22:		Line 24:

	5. Paste in the HTML file path and click OK		5. Paste in the HTML file path and click OK

			=== Open API Specification ===

			The following [https://github.com/Parl4224h/pav-tv-openapi GitHub Repository] contains an OpenAPI v3 specification for the API that allows for easier viewing and conversion to types for typed languages.

	=== The GET Endpoints ===		=== The GET Endpoints ===
Line 461:		Line 467:


	'''<code>/~~PlayerPos~~</code> endpoint to include these fields in SND if the bomb is available. Bomb States (0 = dropped, 1 = carried, 2 = planted)'''		'''<code>/PlayersPos</code> endpoint to include these fields in SND if the bomb is available. Bomb States (0 = dropped, 1 = carried, 2 = planted)'''

	{\| class="wikitable"		{\| class="wikitable"

2024-12-03T18:35:09Z

← Older revision		Revision as of 13:35, 3 December 2024
Line 301:		Line 301:

	'''Pitch, Roll, Yaw''' give you the orientation of the camera relative to the world normal, each in <u>float</u>		'''Pitch, Roll, Yaw''' give you the orientation of the camera relative to the world normal, each in <u>float</u>
	[[File:Pitchrollyaw.png\|~~left~~\|~~thumb~~]]		[[File:Pitchrollyaw.png\|right\|frameless]]

	===== Camera Play GET Endpoint - It will call your game to play the path currently in that slot =====		===== Camera Play GET Endpoint - It will call your game to play the path currently in that slot =====

2024-12-03T18:34:09Z

2024-12-03T18:27:17Z

@@ Line 92: / Line 92: @@
 const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects
-CODE BLOCK
+{| class="wikitable"
@@ Line 115: / Line 186: @@
 const killfeedData = await response.json();</blockquote>Returns the most recent
-CODE BLOCK EXAMPLE
+{| class="wikitable"
@@ Line 131: / Line 224: @@
 Gives you an event log for things like Win and Round, will list ALL events during the round if watching a replay, will list them as they happen if watching live<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchEvents'</nowiki>);
-const eventData = await response.json();</blockquote>
+           "Name": "Win",
-EXAMPLE CODE BLOCK

2024-12-03T16:19:19Z

← Older revision		Revision as of 11:19, 3 December 2024
Line 219:		Line 219:
	'''POST <code>/Pause</code>'''		'''POST <code>/Pause</code>'''

	~~'''Body:'''~~

	<code>{</code>		<code>{</code>
Line 240:		Line 239:


	GET <code>/MatchTime</code>
			'''GET <code>/MatchTime</code>'''

	returns		returns
Line 251:		Line 251:


	POST <code>/MatchTime</code>
			'''POST <code>/MatchTime</code>'''

	returns		returns
Line 310:		Line 311:


	POST <code>/LoadReplay</code>
			'''POST <code>/LoadReplay</code>'''

	<code>{</code>		<code>{</code>
Line 328:		Line 330:


	<code>/PlayerPos</code> endpoint to include these fields in SND if the bomb is available. Bomb States (0 = dropped, 1 = carried, 2 = planted)
			'''<code>/PlayerPos</code> endpoint to include these fields in SND if the bomb is available. Bomb States (0 = dropped, 1 = carried, 2 = planted)'''



Line 338:		Line 342:

	<code>"BombState": 1</code>		<code>"BombState": 1</code>


	=== Possible issues you may encounter ===		=== Possible issues you may encounter ===

2024-12-03T16:18:18Z

2024-12-03T15:49:07Z

← Older revision		Revision as of 10:49, 3 December 2024
Line 32:		Line 32:

	<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);		<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);


	const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''		const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''

Line 86:		Line 88:

	''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0		''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0


	const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects		const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects

2024-12-03T15:48:55Z

← Older revision		Revision as of 10:48, 3 December 2024
Line 32:		Line 32:

	<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);		<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);


	const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''		const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''

Line 88:		Line 86:

	''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0		''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0


	const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects		const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects

2024-12-03T15:48:31Z

← Older revision		Revision as of 10:48, 3 December 2024
Line 31:		Line 31:
	Ex.in JS to fetch this endpoint on port 1234 const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>); const matchData = await response.json()		Ex.in JS to fetch this endpoint on port 1234 const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>); const matchData = await response.json()

	<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);		<blockquote>const response = await fetch('<nowiki>http://localhost:1234/MatchStatus'</nowiki>);


	const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''		const matchData = await response.json();</blockquote>'''Elements in MatchStatus'''
Line 87:		Line 88:

	''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0		''Ex.in JS to fetch Team0 from MatchStatus''<blockquote>const teamZero = matchData.Team0


	const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects		const teamOne = matchData.Team1</blockquote>These will give you an array of JSON style objects

2024-12-03T15:47:56Z

← Older revision		Revision as of 10:47, 3 December 2024
Line 81:		Line 81:
	''Ex. "Team0Cash": 2500, "Team1Cash": 2500''		''Ex. "Team0Cash": 2500, "Team1Cash": 2500''
	MatchStatus.Team0 or MatchStatus.Team1		MatchStatus.Team0 or MatchStatus.Team1



	'''MatchStatus.Team0 or MatchStatus.Team1'''		'''MatchStatus.Team0 or MatchStatus.Team1'''