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

Add document for SVC API #1039

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add document for SVC API #1039

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fba8fb1
Add document for SVC API
starwarfan Jul 9, 2021
db55ecb
Take layer specification as subscription parameters
starwarfan Jul 12, 2021
c198e37
Change configuration name for bandwidth estimation
starwarfan Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/Client-Portal Protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ This a format for client reconnects.
source: "mic" | "camera" | "screen-cast" | "raw-file" | "encoded-file" | undefined,
mid: string(mid) | undefined,
rid: string(rid) | undefined,
scalabilityMode: "L1T3" | ... | undefined,
optional:
{
format: [object(AudioFormat)] | [object(VideoFormat)] | undefined,
Expand Down Expand Up @@ -379,6 +380,7 @@ A publication can send either media or data, but a QUIC *transport* channel can
type: "audio" | "video",
mid: string(MID),
source: "mic" | "screen-cast" | ... | "encoded-file",
scalabilityMode: "L1T3" | ... | undefined,
}
]
}
Expand Down Expand Up @@ -452,6 +454,10 @@ A publication can send either media or data, but a QUIC *transport* channel can
mid: string(MID),
from: string(TrackID) | string(StreamID),
parameters: object(VideoParametersSpecification) | undefined,
preferredLayers: { // Used to force layers for SVC stream
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we move this to parameters above? And the same shall be shared by subscription control singaling.

Copy link
Collaborator Author

@starwarfan starwarfan Jul 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My consideration is that the preferredLayers may have conflict with parameters.resolution or parameters.framerate. For example, spatial layer 0 and resolution 720p may not align. Placing it outside parameters can mean that it will override parameters.
Besides, I have no idea about describing the parameters of an SVC stream yet. Because an SVC stream may have multiple resolutions. I'll use highest layers for parameters so far.

spatialId: number(SpatialLayerId) | undefined,
temporalId: number(TemporalLayerId) | undefined,
} | undefined,
}
]
}
Expand Down
1 change: 1 addition & 0 deletions doc/servermd/RESTAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Data Model:<br>
transcoding: object(Transcoding), // the transcoding control
notifying: object(Notifying), // notification control
selectActiveAudio: boolean, // select 3 most active audio streams for the room
senderBandwidthEstimation: boolean, // enable send side bandwidth estimation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be part of webrtc agent configuration instead of room configuration.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion, ok to put this as part of room configuration.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change its name to webrtcSenderSideBandwidthEstimation? This configuration doesn't work for WebTransport connections.

sip: object(Sip) // SIP configuration
}

Expand Down