Legs

Mix an audio stream into a room

Changed on

Attaches one of the leg's secondary streams to a room, which may differ from the leg's own room — that is what lets an original audio stream and a translated one be mixed separately. A leg never hears its own other streams, whatever the routing matrix says.

post/legs/{id}/streams/{streamId}/room

Request

  • Base URL
    http://localhost:8080/v1
  • URL
    http://localhost:8080/v1/legs/{id}/streams/{streamId}/room
  • Auth
    none declared

Request body

room_idstring required

Room to mix this stream into. May differ from the leg's own room.

rolestring

Routing role for the stream inside that room. The room's routing matrix decides who hears it.

Response

Updated stream

idstring required

Stream identifier, stable for the life of the dialog. The primary stream is always "0".

midstring

The stream's SDP a=mid token (RFC 5888), used to correlate it across offer/answer.

indexinteger required

Position of the stream's m= line in the SDP. Fixed for the life of the dialog (RFC 3264 §8).

primaryboolean required

True for the call's main bidirectional audio stream, which cannot be removed or attached to a room independently.

state'pending' | 'active' | 'removed' required

Negotiation state.

direction'sendrecv' | 'sendonly' | 'recvonly' | 'inactive' required

Negotiated media direction from this server's point of view.

desired_direction'sendrecv' | 'sendonly' | 'recvonly' | 'inactive'

Direction requested by the application. Survives hold/unhold, unlike the negotiated direction.

codecstring

Codec the stream's media pipeline is actually running, which after a mid-call re-INVITE is the renegotiated one. Streams on one leg may use different codecs.

sample_rateinteger

Native sample rate of the codec the stream is running, in Hz. It follows a mid-call codec renegotiation.

local_portinteger

Local RTP port. Each stream binds its own port; a shared transport is undefined without BUNDLE (RFC 9143).

remote_addrstring

Remote RTP address media is currently sent to.

labelstring

The stream's a=label value (RFC 4574), for correlating it with external metadata.

contentstring

The stream's a=content value (RFC 4796), e.g. "main" for original audio and "alt" for a translated feed.

langstring

The stream's a=lang value (RFC 8866): a BCP 47 language tag such as "en" or "es-ES".

room_idstring

Room this stream's audio is mixed into. A secondary stream may sit in a different room than its leg.

rolestring

Routing role of this stream within its room. Streams carry their own role, independent of their leg's.

Changes