Source Resources

Synopsis

A source is an incoming unicast or multicast MPEG-TS video stream that can be viewed or recorded after it has been added to a Session. The sources API is used to create and manage the streaming A/V sources to be available for content creators to view and capture.

Source Parameters

Property	JSON Type	Property Type	Description
`name`	String	Required	Source name.
`type`	String	Required	Source type, either UDP or SRT.
`host`	String	Required, for multicast UDP, SRT caller, or SRT rendezvous Optional, when multicast is false	Hostname of the source.
`port`	Number	Required	Port number.
`multicast`	Boolean	Required if type is UDP	True: source is a multicast stream . False: source is a unicast stream directed to the specified port.
`id`	String	Immutable	Identifies the source, generated by HMP.
`active`	Boolean	Ignored	Whether stream data is available.
`bitrate`	Number	Ignored	Bitrate at which source is sending data.
`ctime`	Number	Ignored	Source creation time: Unix timestamp (seconds).
`mtime`	Number	Ignored	Source last modified time: Unix timestamp (seconds).
`description`	String	Optional	Source description
`continuous`	Boolean	Optional, value forced to true for SRT	Default is false.
`mode`	String	Required, if type is SRT	The SRT Connection Mode, either CALLER, LISTENER, or RENDEZVOUS.
`latency`	Number	Optional	Configured latency for SRT in milliseconds.
`passphrase`	String	Optional	Encrypted SRT passphrase.

Source Actions

Source Share Permissions