Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 2.92 KB

SimulcastTarget.md

File metadata and controls

37 lines (22 loc) · 2.92 KB

SimulcastTarget

Properties

Name Type Description Notes
id String ID of the Simulcast Target [optional]
passthrough String Arbitrary user-supplied metadata set when creating a simulcast target. [optional]
status StatusEnum The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. When a simulcast target has this status it will have an `error_severity` field with more details about the error. [optional]
streamKey String Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. [optional]
url String The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`. Note: SRT simulcast targets can only be used when an source is connected over SRT. [optional]
errorSeverity ErrorSeverityEnum The severity of the error encountered by the simulcast target. This field is only set when the simulcast target is in the `errored` status. See the values of severities below and their descriptions. * `normal`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. A simulcast may transition back into the broadcasting state if a connection with the service can be re-established. * `fatal`: The simulcast target is incompatible with the current input to the parent live stream. No further attempts to this simulcast target will be made for the current live stream asset. [optional]

Enum: StatusEnum

Name Value
IDLE "idle"
STARTING "starting"
BROADCASTING "broadcasting"
ERRORED "errored"

Enum: ErrorSeverityEnum

Name Value
NORMAL "normal"
FATAL "fatal"