Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 841b837

Browse files
committed
Address comments.
1 parent e6799f2 commit 841b837

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

doc/Client-Portal Protocol.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,11 @@ This a format for client reconnects.
369369
transport: object(TransportOptions),
370370
attributes: object(ClientDefinedAttributes) | null
371371
}
372+
```
373+
374+
A publication can send either media or data, but a QUIC *transport* channel can support multiple stream for both media and data. Setting `media:null` and `data:false` is meaningless, so it should be rejected by server. Protocol itself doesn't forbit to create WebRTC connection for data. However, SCTP data channel is not implemented at server side, so currently `data:true` is only support by QUIC transport channels.
372375

376+
```
373377
object(WebRTCMediaOptions)::
374378
{
375379
audio: {
@@ -565,7 +569,7 @@ This a format for client reconnects.
565569
object(TransportOptions)::
566570
{
567571
type: "webrtc" | "quic-p2p",
568-
id: string(transportId) | null, // null will result to create a new transport channel.
572+
id: string(transportId) | null, // null will result to create a new transport channel. Always be null if transport type is webrtc because webrtc agent doesn't support multiple transceivers on a single PeerConnection at this time.
569573
}
570574

571575
object(P2PQuicParametersMessage)::
@@ -608,16 +612,9 @@ This a format for client reconnects.
608612
object(SessionProgress)::
609613
{
610614
id: string(SessionId), /* StreamId returned in publishing or SubscriptionId returned in subscribing*/
611-
status: "soac" | "ready" | "error",
612-
data: object(RecorderInfo)/*If status equals “ready” and session is for recording*/ )
615+
status: "ready" | "error"
613616
}
614617

615-
object(RecorderInfo)::
616-
{
617-
host: string(HostnameOrIPOfRecorder),
618-
file: string(FullPathNameOfRecordedFile)
619-
}
620-
621618
# 4. Examples
622619

623620
This section provides a few examples of signaling messages for specific purposes.

0 commit comments

Comments
 (0)