Settings Engine: Add documentation

Relates to #281
This commit is contained in:
backkem
2018-12-24 13:14:29 +01:00
committed by Michiel De Backker
parent 4b32aceba6
commit ae0a2a075f

View File

@@ -4,6 +4,9 @@ import "github.com/pions/webrtc/pkg/ice"
var defaultSettingEngine = newSettingEngine()
// settingEngine allows influencing behavior in ways that are not
// supported by the WebRTC API. This allows us to support additional
// use-cases without deviating from the WebRTC API elsewhere.
type settingEngine struct {
EphemeralUDP struct {
PortMin uint16
@@ -12,7 +15,8 @@ type settingEngine struct {
}
// SetEphemeralUDPPortRange limits the pool of ephemeral ports that
// ICE UDP connections can allocate from
// ICE UDP connections can allocate from. This setting currently only
// affects host candidates, not server reflexive candidates.
func SetEphemeralUDPPortRange(portMin, portMax uint16) error {
if portMax < portMin {
return ice.ErrPort