Skip to content

Commit 1ec99e5

Browse files
committed
Enhance documentation for FileDetail class in QueryResourceRes
1 parent deee560 commit 1ec99e5

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/api/res/QueryResourceRes.java

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -724,22 +724,61 @@ public String toString() {
724724
'}';
725725
}
726726

727+
/**
728+
* @brief The file details when the avFileType is set to ["hls","mp4"].
729+
* @since v0.4.0
730+
*/
727731
public static class FileDetail {
732+
/**
733+
* The file name of the M3U8 and MP4 files generated during recording.
734+
* (Optional)
735+
*/
728736
@JsonProperty("fileName")
729737
private String fileName;
730738

739+
/**
740+
* The recording file type.(Optional)
741+
* <p>
742+
* - "audio": Audio-only files.
743+
* <p>
744+
* - "video": Video-only files.
745+
* <p>
746+
* - "audio_and_video": audio and video files
747+
*/
731748
@JsonProperty("trackType")
732749
private String trackType;
733750

751+
/**
752+
* User UID, indicating which user's audio or video stream is being recorded. In
753+
* composite recording mode, the uid is "0".(Optional)
754+
*/
734755
@JsonProperty("uid")
735756
private String uid;
736757

758+
/**
759+
* Whether the users were recorded separately.(Optional)
760+
* <p>
761+
* - true: All users are recorded in a single file.
762+
* <p>
763+
* - false: Each user is recorded separately.
764+
*/
737765
@JsonProperty("mixedAllUser")
738766
private Boolean mixedAllUser;
739767

768+
/**
769+
* Whether or not can be played online.(Optional)
770+
* <p>
771+
* - true: The file can be played online.
772+
* <p>
773+
* - false: The file cannot be played online.
774+
*/
740775
@JsonProperty("isPlayable")
741776
private Boolean isPlayable;
742777

778+
/**
779+
* The recording start time of the file, the Unix timestamp, in
780+
* seconds.(Optional)
781+
*/
743782
@JsonProperty("sliceStartTime")
744783
private Long sliceStartTime;
745784

0 commit comments

Comments
 (0)