Create a Screenshot Template

Create a screenshot template of an ingest domain, an app, or a stream.

Request

Request-Line

Post /lls/v1.0/template/screenshot

Request Body

Parameter	Type	Required	Description
templateName	String	Mandatory	Screenshot template name.
domain	String	Mandatory	Ingest domain name.
app	String	Optional	App name. If not specified, the screenshot template will be applied to all apps.
stream	String	Optional	Stream name. If not specified, the screenshot template will be applied to all streams.
screenshotFormat	String	Mandatory	Screenshot format. Valid values: png, jpg.
bucket	String	Mandatory	Bucket name to store the screenshot.
path	String	Mandatory	Storage path under the bucket.

Response

Response Body

Parameter	Type	Required	Description
templateName	String	Mandatory	Screenshot template name.
created	Timestamp	Mandatory	Timestamp of created time in UTC timezone. Default is now.
status	String	Mandatory	Status of screenshot template. Valid values: active, inactive.
domain	String	Mandatory	Ingest domain name.
app	String	Optional	App name. If not specified, the screenshot template will be applied to all apps.
stream	String	Optional	Stream name. If not specified, the screenshot template will be applied to all streams.
screenshotFormat	String	Mandatory	Screenshot format. Valid values: png, jpg.
bucket	String	Mandatory	Bucket name to store the screenshot.
path	String	Mandatory	Storage path under the bucket.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	LLS.ScreenshotTemplate.InvalidTemplateName	Recording template name invalid.
400	LLS.ScreenshotTemplate.TemplateNotFound	Template not found.
400	LLS.ScreenshotTemplate.DomainNotFound	Domain not found.
400	LLS.ScreenshotTemplate.AppNotFound	App not found.
400	LLS.ScreenshotTemplate.StreamNotFound	Stream not found.
400	LLS.ScreenshotTemplate.InvalidRecordingFrom	Invalid recording from.
400	LLS.ScreenshotTemplate.InvalidRecordingFormat	Invalid recording format.
400	LLS.ScreenshotTemplate.BucketNotFound	Bucket not found.
400	LLS.ScreenshotTemplate.InvalidStatus	Invalid status.
400	LLS.ScreenshotTemplate.InvalidPath	Invalid path.
400	LLS.ScreenshotTemplate.TemplateExists	Template already exists.
400	LLS.ScreenshotTemplate.ConflictTemplate	Template conflict.

Examples

Create a screenshot template of the specified domain with PNG format

Request

POST /lls/v1.0/template/screenshot HTTP/1.1

{
  "templateName": "domainTemplate",
  "domain": "ingest.example.com",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/mp4/"
}

Successful Response Body

{
  "templateName": "domainTemplate",
  "created": "2025-07-15T08:47:10Z",
  "status": "active",
  "domain": "ingest.example.com",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/mp4/"
}

Create a screenshot template of the specified app with PNG format

Request

POST /lls/v1.0/template/screenshot HTTP/1.1

{
  "templateName": "appTemplate",
  "domain": "ingest.example.com",
  "app": "live",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Successful Response Body

{
  "templateName": "appTemplate",
  "created": "2025-07-15T08:48:30Z",
  "status": "active",
  "domain": "ingest.example.com",
  "app": "live",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Create a screenshot template of the specified stream with PNG format

Request

POST /lls/v1.0/template/screenshot HTTP/1.1

{
  "templateName": "streamTemplate",
  "domain": "ingest.example.com",
  "app": "live",
  "stream": "stream1",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Successful Response Body

{
  "templateName": "streamTemplate",
  "created": "2025-07-15T08:49:45Z",
  "status": "active",
  "domain": "ingest.example.com",
  "app": "live",
  "stream": "stream1",
  "screenshotFormat": "png",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Create a screenshot template with JPG format

Request

POST /lls/v1.0/template/screenshot HTTP/1.1

{
  "templateName": "deliveryTemplate",
  "domain": "ingest.example.com",
  "app": "live",
  "stream": "stream1",
  "screenshotFormat": "jpg",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Successful Response Body

{
  "templateName": "deliveryTemplate",
  "created": "2025-07-15T08:51:30Z",
  "status": "active",
  "domain": "ingest.example.com",
  "app": "live",
  "stream": "stream1",
  "screenshotFormat": "jpg",
  "bucket": "my-bucket",
  "path": "/recording/hls/"
}

Rate Limits

Rate limiting is posed upon the API, check API calls to comply with the rate limit below:

• 100 requests per minute
• 1000 requests per hour