Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Fork Stream

Fork Stream Studio Widget

Description:

Fork Stream allows you to send real-time audio streams of a phone call over the Internet. Websocket and SIPREC protocols are supported.

Required Configuration:

You must select an Action when configuring this Widget.

Name

Description

Action

Whether you want to Start or Stop a stream.

Optional Configuration:

Name

Description

Stream Name

Friendly name given to the Stream

Stream Type

Transport protocol, one of WebSocket or SIPREC.

URL

URL of the service where to stream the audio. This is requrired when the Stream Type is WebSocket. The only supported protocol is wss.

Connector Name

Name of the Add-on use to configure the Stream. This is required when Stream Type is SIPREC.

Tracks

Select audio streams to be sent. Can be any of: Inbound Track, Outbound Track or Both Tracks

Stream Parameters

Zero or more extra parameters expressed as key/value pairs that will be sent to the remote service during connection.

Transitions

The "Next" transition fires inmediately after the Stream connection has been created (Start) or terminated (Stop).

Example Flow

In the call flow screenshot below the audio streams of an incoming call are forked for real-time processing while the call is bridged to another phone number.

Fork Stream Studio Flow

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.