Skip to main content

WebRTC

Provides WebRTC output

Dependency on other protocol(s)

DependencyDescription
HTTP(S)Provides WebRTC output

Playing WebRTC from MistServer

MethodTypeURL
WebRTC with WebSocket signallingwebrtcws(s)://HOST:PORT/webrtc/STREAMNAME
WebRTC with WHEP signallingwhephttp(s)://HOST:PORT/webrtc/STREAMNAME

WebRTC Optional configurations

OptionDescriptionTypeDefaultAPICommandline
UDP bind address (internal)Interface address or hostname to bind SRTP UDP socket to. Defaults to originating interface address.Stringbindhost--bindhost
Certificate(Root) certificate(s) file(s) to append to chainStringcert--cert
debugThe debug level at which messages need to be printed.debugInherited from parent processdebug--debug
Default track sortingWhat tracks are selected first when no specific track selector is used for playback. = Default (last added for live, first added for VoD)
bps_lth = Bit rate, low to high
bps_htl = Bit rate, high to low
id_lth = Track ID, low to high
id_htl = Track ID, high to low
res_lth = Resolution, low to high
res_htl = Resolution, high to low
default_track_sorting--default_track_sorting
STUN/TURN configAn array of RTCIceServer objects, each describing one server which may be used by the ICE agent; these are typically STUN and/or TURN servers. These will be passed verbatim to the RTCPeerConnection constructor as the 'iceServers' property.jsoniceservers--iceservers
Write jitter logWrites log of frame transmit jitter to /tmp/ for each outgoing connectionFlag0jitterlog--jitterlog
KeyPrivate key for SSLStringkey--key
RTP lost timeoutAmount of packets any track will wait for a packet to arrive before considering it lostNumber (unsigned integer)30losttimeout--losttimeout
RTP lost timeout (mobile)Amount of packets any track will wait for a packet to arrive before considering it lost, on mobile connectionsNumber (unsigned integer)90losttimeoutmobile--losttimeoutmobile
merge sessionsif enabled, merges together all views from a single user into a single combined session. if disabled, each view (reconnection of the signalling websocket) is a separate session.Flag0mergesessions--mergesessions
Disallow NACKs for viewersDisallows viewers to send NACKs for lost packetsFlag0nackdisable--nackdisable
RTP NACK timeoutAmount of packets any track will wait for a packet to arrive before NACKing itNumber (unsigned integer)5nacktimeout--nacktimeout
RTP NACK timeout (mobile)Amount of packets any track will wait for a packet to arrive before NACKing it, on mobile connectionsNumber (unsigned integer)15nacktimeoutmobile--nacktimeoutmobile
Write packet logWrites log of full packet contents to /tmp/ for each connectionFlag0packetlog--packetlog
Preferred audio codecsComma separated list of audio codecs you want to support in preferred order. e.g. opus,ALAW,ULAWStringopus,ALAW,ULAWpreferredaudiocodec--webrtc-audio-codecs
Preferred video codecsComma separated list of video codecs you want to support in preferred order. e.g. H264,VP8StringH264,VP9,VP8preferredvideocodec--webrtc-video-codecs
UDP bind address (public)Interface address or hostname for clients to connect to. Defaults to internal address.Stringpubhost--pubhost
UsernameUsername to drop privileges to - default if unprovided means do not drop privilegesStringrootusername--username