Skip to content

Commit f38cf3b

Browse files
authored
Merge pull request #36 from seymourtang/fix-doc
fix: Update comments for clarity and correct value range in RecordingConfig
2 parents 2075739 + 533143b commit f38cf3b

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

services/cloudrecording/api/query.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,7 @@ type QueryRtmpPublishServerResponse struct {
403403
// - "exit": Service exits.
404404
State string `json:"state"`
405405

406+
// The push stream to the CDN output.
406407
Outputs []struct {
407408
// The CDN address to which you push the stream.
408409
RtmpUrl string `json:"rtmpUrl"`

services/cloudrecording/api/start.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ type RecordingConfig struct {
159159
//
160160
// The unit is seconds.
161161
//
162-
// The value range is [5,259,200].
162+
// The value range is [5,259200].
163163
//
164164
// The default value is 30.
165165
MaxIdleTime int `json:"maxIdleTime,omitempty"`
@@ -177,7 +177,7 @@ type RecordingConfig struct {
177177
//
178178
// If you want to subscribe to the video streams of all UIDs, no need to set this field.
179179
SubscribeVideoUIDs []string `json:"subscribeVideoUids,omitempty"`
180-
// Specify which UIDs' audio streams not to subscribe to.(Optional)
180+
// Specify which UIDs' video streams not to subscribe to.(Optional)
181181
//
182182
// The cloud recording service will subscribe to the video streams of all UIDs except the specified ones.
183183
UnsubscribeVideoUIDs []string `json:"unSubscribeVideoUids,omitempty"`
@@ -241,6 +241,8 @@ type TransConfig struct {
241241
}
242242

243243
// @brief Audio properties of the file.
244+
//
245+
// @since v0.8.0
244246
type Audio struct {
245247
// Audio sampling rate.(Optional)
246248
//

0 commit comments

Comments
 (0)