Document the "empty defaults" behaviour of NewAPI

By default the API object has no Codecs or Interceptors enabled.
pion · Sep 11, 2023 · 6b22634 · 6b22634
1 parent 898fdd6
commit 6b22634
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/api.go b/api.go
@@ -25,6 +25,10 @@ type API struct {
 }
 
 // NewAPI Creates a new API object for keeping semi-global settings to WebRTC objects
+//
+// WARNING: No Codecs or Interceptors are enabled by default. Unless configured properly a
+// PeerConnection will not be able to transmit media. For an example of how to do that,
+// see the body of the webrtc.NewPeerConnection() function.
 func NewAPI(options ...func(*API)) *API {
 	a := &API{
 		interceptor:         &interceptor.NoOp{},