Recording settings API
Account-level recording defaults applied when rooms record.
Endpoint: https://mediasfu.com/v1/recordingsettings
Authenticate with Authorization: Bearer <api-username>:<api-key> from your server. Try every action and copy the request in the API Sandbox.
Set defaults
POST https://mediasfu.com/v1/recordingsettings with action: "create"
Define the default recording behaviour.
Required fields
| Field | Type | Description | Default |
|---|---|---|---|
recordingAudioSupport | boolean | Record audio | true |
recordingVideoSupport | boolean | Record video | true |
Optional: More
HLS, orientation, multi-format.
| Field | Type | Description | Default |
|---|---|---|---|
recordingHLSSupport | boolean | HLS stream | false |
recordingPreferredOrientation | landscape, portrait, neutral | Orientation | "landscape" |
recordingMultiFormatsSupport | boolean | Multiple formats | false |
curl -X POST https://mediasfu.com/v1/recordingsettings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY" \
-d '{"action":"create","recordingAudioSupport":true,"recordingVideoSupport":true}'
Update defaults
POST https://mediasfu.com/v1/recordingsettings with action: "update"
Change only the settings you specify.
No fields are required.
Optional: Settings
Any recording settings to change.
| Field | Type | Description | Default |
|---|---|---|---|
recordingAudioSupport | boolean | Record audio | true |
recordingVideoSupport | boolean | Record video | true |
recordingHLSSupport | boolean | HLS stream | false |
recordingPreferredOrientation | landscape, portrait, neutral | Orientation | "landscape" |
recordingMultiFormatsSupport | boolean | Multiple formats | false |
curl -X POST https://mediasfu.com/v1/recordingsettings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY" \
-d '{"action":"update"}'
List / get
GET https://mediasfu.com/v1/recordingsettings with action: "get"
Retrieve records. Everything is optional — send as-is to list all.
No fields are required.
Optional: Filters
All optional — narrow or page the results.
| Field | Type | Description | Default |
|---|---|---|---|
startIndex | number | Start index | 0 |
pageSize | number (1–100) | Page size | 20 |
curl "https://mediasfu.com/v1/recordingsettings?action=get" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY"
See errors and response format for failure handling.