Improve documentation of NewPeerConnection

It is important to mention that, unlike API.NewPeerConnection, this
registers default interceptors.
This commit is contained in:
Juliusz Chroboczek
2020-12-22 10:14:04 +01:00
committed by Sean DuBois
parent 4ff9196a91
commit de913a99a8
2 changed files with 9 additions and 4 deletions

View File

@@ -10,8 +10,9 @@ import (
"github.com/pion/rtp"
)
// RegisterDefaultInterceptors will register some useful interceptors. If you want to customize which interceptors are loaded,
// you should copy the code from this method and remove unwanted interceptors.
// RegisterDefaultInterceptors will register some useful interceptors.
// If you want to customize which interceptors are loaded, you should copy the
// code from this method and remove unwanted interceptors.
func RegisterDefaultInterceptors(mediaEngine *MediaEngine, interceptorRegistry *interceptor.Registry) error {
if err := ConfigureNack(mediaEngine, interceptorRegistry); err != nil {
return err