File tree Expand file tree Collapse file tree 1 file changed +34
-0
lines changed
agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/api/req Expand file tree Collapse file tree 1 file changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -389,7 +389,22 @@ public VideoUIDList build() {
389
389
}
390
390
}
391
391
392
+ /**
393
+ * @brief Used to update the web page recording configurations.
394
+ * @since v0.4.0
395
+ */
392
396
public static class WebRecordingConfig {
397
+ /**
398
+ * Set whether to pause the web page recording.
399
+ * <p>
400
+ * - true: Pauses web page recording and generating recording files.
401
+ * <p>
402
+ * - false: (Default) Continues web page recording and generates recording
403
+ * files.
404
+ * <p>
405
+ * If you want to resume a paused web page recording, you can call the
406
+ * update method and set onhold to false.
407
+ */
393
408
@ JsonProperty ("onhold" )
394
409
private Boolean onHold ;
395
410
@@ -434,8 +449,16 @@ public WebRecordingConfig build() {
434
449
}
435
450
}
436
451
452
+ /**
453
+ * @brief Used to update the configurations for pushing web page recording to
454
+ * the CDN.
455
+ * @since v0.4.0
456
+ */
437
457
public static class RtmpPublishConfig {
438
458
459
+ /**
460
+ * The output of pushing web page recording to the CDN.
461
+ */
439
462
@ JsonProperty ("outputs" )
440
463
private List <UpdateOutput > outputs ;
441
464
@@ -480,8 +503,19 @@ public RtmpPublishConfig build() {
480
503
}
481
504
}
482
505
506
+ /**
507
+ * @brief Used to update the output of pushing web page recording to the CDN.
508
+ * @since v0.4.0
509
+ */
483
510
public static class UpdateOutput {
484
511
512
+ /**
513
+ * The CDN URL where you push the stream to.
514
+ * <p>
515
+ * URLs only support the RTMP and RTMPS protocols.
516
+ * <p>
517
+ * The maximum number of streams being pushed to the CDN is 1.
518
+ */
485
519
@ JsonProperty ("rtmpUrl" )
486
520
private String rtmpURL ;
487
521
You can’t perform that action at this time.
0 commit comments