Fields

FieldTypeDescription
playback policyDropdownSpecifies playback options: public, signed, or drm.
audio onlyBooleanWhen set to true, processes only the audio track; Mux will drop the video track if broadcasted.
latency modeDropdownSets the time from transmission to display in the player. Options: low, reduced, standard.
testBooleanMarks the stream as a test. Test streams allow API evaluation without incurring costs.

Returned Values

FieldTypeDescription
stream keyTextUnique key for streaming to a Mux RTMP endpoint. Treat this as sensitive information; anyone with this key can begin streaming.
statusTextStatus of the stream. Possible values: active, idle, disabled.
reconnect windowTextDuration (in seconds) that Mux will wait for reconnection before ending the stream.
playback idsText (list)List of Playback IDs, used to generate HLS playback URLs.
playback policiesTextLists the playback policies: public, signed, drm.
idTextUnique identifier for the live stream. Maximum of 255 characters.
created atTextCreation timestamp for the live stream, given as a Unix timestamp (seconds since epoch).