| | 1 | # Captura |
| | 2 | |
| | 3 | Bring your own backend screen recorder |
| | 4 | |
| | 5 | ## Bring Your Own Backend (Protocol version 1.0) |
| | 6 | |
| | 7 | Captura allows you to define a URL that will be used to POST the recording. |
| | 8 | |
| | 9 | ### The Request |
| | 10 | |
| | 11 | A `POST` will be made to the request, with the payload containing the binary |
| | 12 | contents of the file. You can expect the following headers: |
| | 13 | |
| | 14 | * `User-Agent`: `Captura/1.0` |
| | 15 | * `Content-Type`: `video/mp4` or `image/gif`, depending on the output format |
| | 16 | selected. |
| | 17 | |
| | 18 | ### Authentication / Authorization |
| | 19 | |
| | 20 | We will only do a POST request, so if you need any type of keys or user |
| | 21 | identifiers, include them in the URL itself (eg. via path elements or |
| | 22 | in the query parameters) |
| | 23 | |
| | 24 | ### Expected Response |
| | 25 | |
| | 26 | If the upload is successful, the response *MUST* be a JSON object containing |
| | 27 | a key called `url` with a value of type `string` corresponding to the URL |
| | 28 | where the file is available. The status code *MUST* be 201 Created. |
| | 29 | |
| | 30 | Any response code other than 201 Created will be treated as an error. Captura |
| | 31 | will not re-attempt an upload. |
| | 32 | |
| | 33 | ## Building |
| | 34 | |
| | 35 | For development, build the app using xcode. For release, a makefile is provided |
| | 36 | with commands to archive and package. If you just want the built and signed app |
| | 37 | you can use `make archive`. To generate the whole package use `make distribute` |
| | 38 | |
| | 39 | ### Signing |
| | 40 | |
| | 41 | There's no automated handling of signing. For the app to be signed correctly, |
| | 42 | update the signing configuration in the xcode project. |
git.r.bdr.sh / rbdr / captura / blame_incremental