/

WebRTC Configuration Properties


WebRTC Configuration Properties

PropertyRequiredDefaultDescription
protocol[x]wssThe protocol for the WebSocket communication; ws or wss.
port[x]443The port on the host that the WebSocket listens on; 5080 or 443 (insecure or secure, respectively).
app[x]liveThe webapp name that the WebSocket is listening on.
streamMode[x]liveThe mode to broadcast; live, record or append.
keyFramerate[-]3000The framerate (in milliseconds) between sending key frames in broadcast.
host[x]NoneThe IP or address that the WebSocket server resides on.
streamName[x]NoneThe name of the stream to subscribe to.
mediaElementId[-]red5pro-publisherThe target video or audio element id attribute which will display the preview media.
rtcConfiguration[-]NoneThe RTCConfiguration to user in setting up RTCPeerConnection. RTCConfiguration
iceServers[x]None (Test)The list of ICE servers to use in requesting a Peer Connection. Marked for Deprecation. Favor rtcConfiguration.
iceTransport[-]UDPThe transport type to use in ICE negotiation. Either UDP or TCP
bandwidth[-]{audio: 56, video: 512}A configuration object to setup bandwidth setting in publisher.
connectionParams[-]undefinedAn object of connection parameters to send to the server upon connection request.
mediaConstraints[x]see belowA object representative of the Media Constraints to use while setting up the Media (via getUserMedia internally to the SDK).
onGetUserMedia[-]see belowAn override method for performing your own getUserMedia request.