cloudflare / cloudflare/cloudflare-docs

Cloudflare SFU API documentation update

Open
#28,488 3 comments 0 reactions 0 assignees View on GitHub
content:edit documentation product:realtime stale
Dominant language
MDX
Stars
5.2k
Forks
16.7k
Avg merge
2d 6h
Merged PRs (30d)
337

Description

### 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.