SoulFire LogoSoulFire

Input

POST
/soulfire.v1.PovService/Input

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sessionId?string
sequence?string
Match^(0|[1-9][0-9]*)$
captured?boolean
width?integer
Formatint32
height?integer
Formatint32
events?array<>
escape?boolean

Forward Escape to the game, including opening the pause menu.

requestKeyFrame?boolean

Recover after dropping dependent frames or resetting the decoder.

feedback?

Client-relative delivery delay avoids requiring synchronized clocks.

inputToken?string
clipboard?|

Clipboard is set before processing the accompanying paste key event.

readClipboard?boolean
maxFps?integer
Formatint64
Range0 <= value <= 4294967295

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/soulfire.v1.PovService/Input" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "",    "sequence": "0",    "captured": false,    "width": 0,    "height": 0,    "events": [],    "escape": false,    "requestKeyFrame": false,    "inputToken": "",    "readClipboard": false,    "maxFps": 0  }'
{}

How is this page?