mirror of
https://github.com/pion/webrtc.git
synced 2025-10-04 23:02:48 +08:00
Document the "empty defaults" behaviour of NewAPI
By default the API object has no Codecs or Interceptors enabled.
This commit is contained in:
4
api.go
4
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{},
|
||||
|
Reference in New Issue
Block a user