Skip to content
This repository has been 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 all commits
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
10 changes: 9 additions & 1 deletion 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 @@ -451,7 +453,7 @@ A publication can send either media or data, but a QUIC *transport* channel can
type: "audio" | "video",
mid: string(MID),
from: string(TrackID) | string(StreamID),
parameters: object(VideoParametersSpecification) | undefined,
parameters: object(VideoParametersSpecification) | object(LayerSpecification) | undefined,
}
]
}
Expand All @@ -463,6 +465,12 @@ A publication can send either media or data, but a QUIC *transport* channel can
bitrate: number(WantedBitrateKbps) | string(WantedBitrateMultiple) | undefined,
keyFrameInterval: number(WantedKeyFrameIntervalSecond) | undefined
}

object(LayerSpecification)::
{ // Used to force layers for SVC stream
spatialLayer: number(SpatialLayerId) | undefined,
temporalLayer: number(TemporalLayerId) | undefined,
}
**ResponseData**: The SubscriptionResult object with following definition if **ResponseStatus** is “ok”:

object(SubscriptionResult)::
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
rtcSenderBandwidthEstimation: boolean, // enable send side bandwidth estimation for webrtc subscription
sip: object(Sip) // SIP configuration
}

Expand Down