Skip to main content

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​

FieldTypeDescriptionDefault
recordingAudioSupportbooleanRecord audiotrue
recordingVideoSupportbooleanRecord videotrue

Optional: More​

HLS, orientation, multi-format.

FieldTypeDescriptionDefault
recordingHLSSupportbooleanHLS streamfalse
recordingPreferredOrientationlandscape, portrait, neutralOrientation"landscape"
recordingMultiFormatsSupportbooleanMultiple formatsfalse
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}'

Example response:

{
"success": true,
"recordingSettings": {
"recordingAudioSupport": true,
"recordingVideoSupport": true,
"recordingHLSSupport": false,
"recordingPreferredOrientation": "landscape",
"recordingSupportForOtherOrientation": false,
"recordingMultiFormatsSupport": false,
"recordingAddWatermark": false,
"recordingWatermarkPosition": "bottomRight",
"…": "and the participant and pause limits"
}
}

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.

FieldTypeDescriptionDefault
recordingAudioSupportbooleanRecord audiotrue
recordingVideoSupportbooleanRecord videotrue
recordingHLSSupportbooleanHLS streamfalse
recordingPreferredOrientationlandscape, portrait, neutralOrientation"landscape"
recordingMultiFormatsSupportbooleanMultiple formatsfalse
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"}'

Example response:

{
"success": true,
"recordingSettings": {
"…": "same fields as create"
}
}

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.

FieldTypeDescriptionDefault
startIndexnumberStart index0
pageSizenumber (10–50)Page size. Between 10 and 50.20
curl "https://mediasfu.com/v1/recordingsettings?action=get" \
-H "Authorization: Bearer $MEDIASFU_API_USERNAME:$MEDIASFU_API_KEY"

Example response:

{
"success": true,
"recordingSettings": {
"…": "same fields as create"
}
}

See errors and response format for failure handling.