webrtc icon indicating copy to clipboard operation
webrtc copied to clipboard

Published 20 hours ago • verified publisher icon pion

Address differences between Go API and Wasm bindings

Open albrow opened this issue 6 years ago • 1 comments

Summary

This issue lists all known API differences between the Go API and the Wasm bindings. Some of these already have their own issues.

List of Differences

  • [ ] If no certificates are provided during initialization, GetConfiguration returns the default generated certificate in the Go API but no certificates in the Wasm bindings (See #513).
  • [x] (Fixed in https://github.com/pions/webrtc/pull/527). Some properties of PeerConnection are implemented as struct fields in the Go API but are methods in the Wasm bindings. Specifically:
    • CurrentLocalDescription
    • PendingLocalDescription
    • CurrentRemoteDescription
    • PendingRemoteDescription
    • SignalingState
    • ICEGatheringState
    • ConnectionState
  • [x] (Fixed in https://github.com/pions/webrtc/pull/524). Similarly, some properties of DataChannel are implemented as struct fields in the Go API but are methods in the Wasm bindings:
    • Label
    • Ordered
    • MaxPacketLifeTime
    • MaxRetransmits
    • Protocol
    • Negotiated
    • ID
    • ReadyState
    • BufferedAmount
    • BufferedAmountLowThreshold
  • [x] (Fixed in https://github.com/pions/webrtc/pull/546) In the Go API, ICE candidate gathering is synchronous but in the Wasm bindings, ICE candidate gathering happens in the background. The Go API is missing the OnICECandidate and OnNegotiationNeeded methods.
  • [ ] The Wasm bindings do not support certificates or credentials (See #499). This might not be addressed before the v2 release.
  • [x] The Wasm bindings do not support tracks, streams, or media (See #500). This might not be addressed before the v2 release.
  • [ ] The Wasm bindings do not support the BufferedAmount methods (introduced in https://github.com/pions/webrtc/pull/572).
  • [ ] The Wasm bindings can't properly subscribe to OnOpen callback when creating a DataChannel. This function might return an already opened DataChannel.

albrow avatar Mar 15 '19 22:03 albrow

Once we have addressed this differences, it should be possible to create a (probably unexported) interface to help enforce homogeneity between the two APIs going forward. This is what @backkem suggested here.

albrow avatar Mar 15 '19 22:03 albrow

All the subtasks have been resolved.

The API differences between WASM/Go are unfortunate, but surprisingly no user has brought it up!

Sean-Der avatar Apr 04 '24 03:04 Sean-Der