Socket ingest

The socketIngress resource streams raw media or data frames into a room over a WebSocket. socketIngress.create returns a single-use WebSocket URL that stays valid for about 90 seconds. Connect to that URL, push your frames, and close the socket when you are done.

Node.js

const socket = await client.socketIngress.create(roomId, { participantId: "telephony-leg" });
socket.wsUrl;
socket.expiresIn;

Go

socket, err := client.SocketIngress.Create(ctx, roomID, videosdk.CreateSocketIngressParams{ParticipantID: "telephony-leg"})
fmt.Println(socket.WSURL, socket.ExpiresIn)

Options: participantId, name, metadata, agent, region.

Full streaming example

Creating the URL is only the first step. For the complete flow (opening the WebSocket, streaming PCM16 audio frames, and receiving room audio), see the Custom WebSocket guide.

The ingress object

Returned by socketIngress.create.

Field	Type	Description
wsUrl	string	Single-use WebSocket URL (valid about 90s).
roomId	string	Room being streamed into.
expiresIn	number	Seconds until the URL expires (about 90).
ref	string	Single-use ref handle parsed from wsUrl.