docs(calling): add call streaming guide - #692
Open
Devon-White wants to merge 3 commits into
Open
Devon-White wants to merge 3 commits into
Devon-White wants to merge 3 commits into
Conversation
Adds a call streaming guide covering SWML `stream`, the REST Calling API stream commands, and Relay's `call.stream()`, following the same template as the outbound calling guide (PR #660): prepare, stream your first call, handle the audio stream, control the stream, stream in both directions, and worked examples. - New guide at /voice/call-streaming with a themed lifecycle diagram. - Bidirectional streaming via `connect` to a `stream:wss://` device, covering SWML, REST (dial with inline SWML), and Relay (`call.connect()`), verified against the relay-apis and FreeSWITCH module source. - Examples: save call audio to WAV with no external dependencies, and a bidirectional echo server. - Links the new guide from the calling overview page.
Contributor
…guide # Conflicts: # fern/products/platform/pages/calling/voice/overview.mdx
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a call streaming guide following the same template as the outbound calling guide (#660): prepare, stream your first call, handle the audio stream, control the stream, stream in both directions, and worked examples.
/voice/call-streamingcovering SWMLstream, the REST Calling API stream commands, and Relay'scall.stream(), with a themed lifecycle diagram.connectdestination (stream:wss://…) across SWML, REST (dial with inline SWML), and Relay (call.connect()), verified against the relay-apis and FreeSWITCH module source.Verification
yarn fern-md-checkpasses (all MDX files valid).signalwire-sdk==3.4.1and@signalwire/sdk@2.0.5(Pythonpy_compile, TypeScripttsc --strict, JSnode --check).websockets, Nodews); save-audio and echo servers verified byte-for-byte.calling.stream,calling.stream.stop) andboth_tracksconfirmed againstspecs/signalwire-rest/calling-api/calls/.🤖 Generated with Claude Code