Cloudflare SFU API documentation update

[eadwu]

Existing documentation URL(s)

https://developers.cloudflare.com/realtime/static/calls-api-2024-05-21.yaml

What changes are you suggesting?

Latest documentation? But here are some specific things missing

/apps/{appId}/sessions/new doesn't seem to introduce sessionDescription anywhere, even though that it is a valid parameter (requestBody).

For /apps/{appId}/sessions/{sessionId}/tracks/new I tried the example

              push_track_without_an_offer:
                description: SFU can generate an offer to push a local track
                value:
                  tracks:
                    - location: local
                      trackName: mic-1
                      kind: "audio"

but it doesn't work. For some reason, using bidirectionalMediaStream: true makes it work, but that generates a sendrecv transceiver while bidirectionalMediaStream: false (or unset) fails with backend error - I believe the example is implying a one way transceiver.

Additional information

I don't also see any information with regard to Trickle ICE so I'm guessing it is not supported.

[dataCenter430]

Hi, @eadwu
The points to address:

The /apps/{appId}/sessions/new endpoint doesn’t currently document the sessionDescription parameter, even though it’s valid in the requestBody. The docs should include it.

For /apps/{appId}/sessions/{sessionId}/tracks/new, the example with push_track_without_an_offer fails unless bidirectionalMediaStream: true is set. This seems inconsistent with the example, which implies a one-way transceiver. The docs should clarify the behavior and update the example so that it works as expected with one-way tracks.

This will help ensure the Realtime API examples are accurate and match actual behavior.

[eadwu]

Actually I think SFU-initiated local tracks might just be broken, connected bidirectionalMediaStream and added track and WebRTC stats show that data is being emitted.

Trying to play that same remote track results in an a=inactive m= offer, remote_tracks example call. If I switch from SFU-initiated local track to exposing my tracks via SDP, local_tracks example, then I can play the remote track fine.