Skip to main content

Stream Configuration

StreamConfig is a sub-object inside the stream object.

{
"address" : String,
"enable" : Boolean,
"auto_stop" : Boolean,
"remove_audio" : Boolean,
"source" : SourceSelection
}
Member nameTypeDescription
addressStringIP address to which the data is to be sent.
enableBooleanWhether the stream is enabled or not
auto_stopBooleanWhen true, the stream stops automatically whenever the video source is lost or the resolution changes; it must then be restarted with start. A resolution change alters the stream's bandwidth, so a client can adjust settings such as compression before restarting. Always false for streams other than the scaled stream (HDMI:1).
remove_audioBooleanWhen true, HDMI audio is not sent with the stream.
Reminder: Audio only present on first HDMI stream (HDMI 0).
sourceSourceSelection(Optional) Selection of the input source. This member is only present if the input source is configurable on this specific stream.