Products Solutions Developer Pricing Get For Free Download Sign in Sign up
Show topics

Application Playback Settings Update

Updates the playback settings for an application.

Request

Property Value
Method PATCH
URL /api/applications/{appName}/settings/playback
Content-Type application/json
Authentication Bearer Token

Path Parameters

Parameter Type Required Description
appName string Yes Application name

Request Body

Parameter Type Required Description
data.attributes.totalViewerLimit integer | null No Total viewer limit (null = unlimited)
data.attributes.streamViewerLimit integer | null No Viewer limit per stream (null = unlimited)
data.attributes.frameBufferSize integer No Frame buffer size
data.attributes.harnessTypes string[] No Enabled playback types

Allowed values for harnessTypes

  • "storm-hls" — Storm HLS player
  • "storm-mse" — Storm MSE player
  • "generic-hls" — Generic HLS
  • "rtmp" — RTMP playback

Example Request

{
  "data": {
    "attributes": {
      "totalViewerLimit": null,
      "streamViewerLimit": 100,
      "frameBufferSize": 5,
      "harnessTypes": ["storm-hls", "storm-mse", "generic-hls"]
    }
  }
}

Response

Status Codes

Code Description
200 Success - Settings updated
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing token
404 Not Found - Application does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (200)

{
  "data": {
    "attributes": {
      "totalViewerLimit": {
        "editable": true,
        "value": null
      },
      "streamViewerLimit": {
        "editable": true,
        "value": 100
      },
      "frameBufferSize": {
        "editable": true,
        "value": 5
      },
      "harnessTypes": ["storm-hls", "storm-mse", "generic-hls"]
    }
  },
  "meta": {
    "executionTime": 8,
    "generatedAt": 1766070331103
  },
  "message": "Playback Settings have been updated"
}

Response Body

Playback Settings

Parameter Type Description
data.attributes.totalViewerLimit.value integer|null Total viewer limit
data.attributes.totalViewerLimit.editable boolean Indicates if the field can be modified
data.attributes.totalViewerLimit.lockedBy string Locked by environment variable (if present)
data.attributes.streamViewerLimit.value integer|null Viewer limit per stream
data.attributes.streamViewerLimit.editable boolean Indicates if the field can be modified
data.attributes.streamViewerLimit.lockedBy string Locked by environment variable (if present)
data.attributes.frameBufferSize.value integer Frame buffer size
data.attributes.frameBufferSize.editable boolean Indicates if the field can be modified
data.attributes.frameBufferSize.lockedBy string Locked by environment variable (if present)
data.attributes.harnessTypes string[] Enabled playback types
message string Response status message

Metadata

Parameter Type Description
meta.executionTime integer Request processing time in milliseconds
meta.generatedAt integer Response generation timestamp (Unix timestamp in ms)

Error Responses

Application Not Found (404)

{
  "message": "Application not found"
}

Error Response Body

Parameter Type Description
message string Human-readable error message