Camera

Actions v1.0 zero-schema

Camera action with four modes selected by Mode: Scan (barcode/QR), Capture (photo), Record (video), or Stream (live broadcast).

Missing descriptions: Handler, OnSuccess, OnFailure.

Required fields

Handler

Properties

Handler required

No description

Mode string optional

Scan returns the decoded barcode/QR string; Capture and Record return an upload-ready { name, bytes, size } (feeds an Http POST); Stream publishes a live broadcast.

Default "Scan"

Allowed Scan Capture Record Stream

Width number optional

Scanner width, or preferred capture width in pixels for Stream mode.

Height number optional

Scanner height, or preferred capture height in pixels for Stream mode.

FrameRate integer optional

Preferred video frames per second for Stream mode.

VideoBitrate integer optional

Preferred encoded video bitrate in bits per second.

AudioBitrate integer optional

Preferred encoded audio bitrate in bits per second.

Url string optional

For Stream mode, /api/live-streams or an existing live-stream URL.

Operation string optional

For Stream mode, Start begins publishing and Stop ends it.

Default "Start"

Allowed Start Stop

Audio boolean optional

Whether to capture the microphone. Set Video false and Audio true for a voice-only (audio) live stream.

Default true

Video boolean optional

Whether to capture the camera. Set false for a voice-only stream.

Default true

ChunkMilliseconds integer optional

How often, in milliseconds, encoded media is flushed to the stream.

Default 1000

Source string optional

For Capture/Record, whether to open the live camera or pick an existing item from the device gallery.

Default "Camera"

Allowed Camera Gallery

MaxSeconds integer optional

For Record, an optional cap on the recording length in seconds.

OnSuccess ref optional

No description

Ref Actions / Action / 1.0

OnFailure ref optional

No description

Ref Actions / Action / 1.0

Referenced contracts

Actions / Action / 1.0 raw

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Camera", "description": "Camera action with four modes selected by Mode: Scan (barcode/QR), Capture (photo), Record (video), or Stream (live broadcast).", "type": "object", "examples": [ { "title": "Scan a QR / barcode", "description": "Mode 'Scan' opens the camera and returns the decoded string on the first successful read. The browser will prompt for camera permission on the first tap. Chain the decoded value into any action via OnSuccess.", "document": { "PresentationType": "Button", "Text": "Scan a code", "Icon": "qr-code", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Scan", "OnSuccess": { "Handler": "Alert", "Theme": "Success", "Title": "Scanned", "Message": "You scanned: {{ Value }}" }, "OnFailure": { "Handler": "SnackBar", "Message": "Scan cancelled or camera unavailable." } } } }, { "title": "Capture a photo", "description": "Mode 'Capture' opens a shutter interface and returns an upload-ready {name, bytes, size} on success. Feed straight into an Http POST — the runtime switches to multipart automatically.", "document": { "PresentationType": "Button", "Text": "Take a photo", "Icon": "camera", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Capture", "OnSuccess": { "Handler": "SnackBar", "Message": "Captured {{ Value.name }} ({{ Value.size }} bytes)" } } } }, { "title": "Record a video clip", "description": "Mode 'Record' captures a short clip (defaults to MaxSeconds if the schema declares one) and returns the same {name, bytes, size} shape as Capture. Same OnSuccess pattern.", "document": { "PresentationType": "Button", "Text": "Record a clip", "Icon": "video", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Record", "MaxSeconds": 10, "OnSuccess": { "Handler": "SnackBar", "Message": "Recorded {{ Value.name }}" } } } } ], "x-version": "1.0", "required": [ "Handler" ], "properties": { "Handler": { "const": "Camera" }, "Mode": { "type": "string", "enum": [ "Scan", "Capture", "Record", "Stream" ], "default": "Scan", "description": "Scan returns the decoded barcode/QR string; Capture and Record return an upload-ready { name, bytes, size } (feeds an Http POST); Stream publishes a live broadcast." }, "Width": { "type": "number", "description": "Scanner width, or preferred capture width in pixels for Stream mode." }, "Height": { "type": "number", "description": "Scanner height, or preferred capture height in pixels for Stream mode." }, "FrameRate": { "type": "integer", "minimum": 1, "maximum": 120, "description": "Preferred video frames per second for Stream mode." }, "VideoBitrate": { "type": "integer", "minimum": 100000, "maximum": 50000000, "description": "Preferred encoded video bitrate in bits per second." }, "AudioBitrate": { "type": "integer", "minimum": 16000, "maximum": 512000, "description": "Preferred encoded audio bitrate in bits per second." }, "Url": { "type": "string", "description": "For Stream mode, /api/live-streams or an existing live-stream URL." }, "Operation": { "type": "string", "enum": [ "Start", "Stop" ], "default": "Start", "description": "For Stream mode, Start begins publishing and Stop ends it." }, "Audio": { "type": "boolean", "default": true, "description": "Whether to capture the microphone. Set Video false and Audio true for a voice-only (audio) live stream." }, "Video": { "type": "boolean", "default": true, "description": "Whether to capture the camera. Set false for a voice-only stream." }, "ChunkMilliseconds": { "type": "integer", "minimum": 250, "maximum": 5000, "default": 1000, "description": "How often, in milliseconds, encoded media is flushed to the stream." }, "Source": { "type": "string", "enum": [ "Camera", "Gallery" ], "default": "Camera", "description": "For Capture/Record, whether to open the live camera or pick an existing item from the device gallery." }, "MaxSeconds": { "type": "integer", "minimum": 1, "description": "For Record, an optional cap on the recording length in seconds." }, "OnSuccess": { "$ref": "/schema/Actions/Action/1.0/index.json" }, "OnFailure": { "$ref": "/schema/Actions/Action/1.0/index.json" } }, "if": { "properties": { "Mode": { "const": "Stream" } }, "required": [ "Mode" ] }, "then": { "required": [ "Url" ] }, "additionalProperties": false, "x-icon": "<svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"1.7\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><rect x=\"3\" y=\"7\" width=\"18\" height=\"13\" rx=\"2\"/><circle cx=\"12\" cy=\"13.5\" r=\"3.5\"/><path d=\"M8 7l1.5-2.5h5L16 7\"/></svg>", "$id": "/schema/Actions/Camera/1.0/index.json", "x-family": "Actions", "x-name": "Camera", "x-source-package": "zero-schema" }

{ "PresentationType": "Button", "Text": "Scan a code", "Icon": "qr-code", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Scan", "OnSuccess": { "Handler": "Alert", "Theme": "Success", "Title": "Scanned", "Message": "You scanned: {{ Value }}" }, "OnFailure": { "Handler": "SnackBar", "Message": "Scan cancelled or camera unavailable." } } }

{ "PresentationType": "Button", "Text": "Take a photo", "Icon": "camera", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Capture", "OnSuccess": { "Handler": "SnackBar", "Message": "Captured {{ Value.name }} ({{ Value.size }} bytes)" } } }

{ "PresentationType": "Button", "Text": "Record a clip", "Icon": "video", "BorderRadius": 6, "Color": "#FFFFFF", "BackgroundColor": "#2F6FED", "OnClick": { "Handler": "Camera", "Mode": "Record", "MaxSeconds": 10, "OnSuccess": { "Handler": "SnackBar", "Message": "Recorded {{ Value.name }}" } } }