Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.6 KB

WebInput.md

File metadata and controls

43 lines (28 loc) · 1.6 KB

WebInput

Properties

Name Type Description Notes
id String Unique identifier for the Web Input. [optional]
createdAt String Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). [optional]
url String The URL for the Web Input to load. [optional]
autoLaunch Boolean When set to `true` the Web Input will automatically launch and start streaming immediately after creation [optional]
liveStreamId String The Live Stream ID to broadcast this Web Input to [optional]
status StatusEnum [optional]
passthrough String Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. Max: 255 characters. [optional]
resolution ResolutionEnum The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. [optional]
timeout Integer The number of seconds that the Web Input should stream for before automatically shutting down. [optional]

Enum: StatusEnum

Name Value
IDLE "idle"
LAUNCHING "launching"
STREAMING "streaming"

Enum: ResolutionEnum

Name Value
_1920X1080 "1920x1080"
_1280X720 "1280x720"
_1080X1920 "1080x1920"
_720X1280 "720x1280"
_1080X1080 "1080x1080"
_720X720 "720x720"