zishuo/webrtc
1
0
Fork 0
mirror of https://github.com/pion/webrtc.git synced 2025-10-05 07:06:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document the "empty defaults" behaviour of NewAPI

Browse Source 
By default the API object has no Codecs or Interceptors enabled.
This commit is contained in:
forest
2023-07-23 22:25:56 -05:00
committed by Sean DuBois
parent 898fdd6f6c
commit 6b22634c1d
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api.go
View File

@@ -25,6 +25,10 @@ type API struct {
} }
// NewAPI Creates a new API object for keeping semi-global settings to WebRTC objects // 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 { func NewAPI(options ...func(*API)) *API {
a := &API{ a := &API{
interceptor: &interceptor.NoOp{}, interceptor: &interceptor.NoOp{},