Skip to content

Commit 58f4fea

Browse files
RaphReynaudRaphReynaud
committed
Update docs texts
1 parent 262cd2e commit 58f4fea

8 files changed

Lines changed: 40 additions & 37 deletions

File tree

‎pkg/cmd/raw-recording/constants.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ const (
3333

3434
// Flag descriptions for global/persistent flags
3535
const (
36-
DescInputFile = "Raw recording zip file path"
37-
DescInputDir = "Raw recording directory path"
36+
DescInputFile = "Raw recording tar.gz archive path"
37+
DescInputDir = "Raw recording extracted directory path"
3838
DescInputS3 = "Raw recording S3 URL (s3://bucket/path or presigned HTTPS URL)"
3939
DescOutput = "Output directory"
4040
DescVerbose = "Enable verbose logging"
@@ -52,7 +52,7 @@ const (
5252
const (
5353
DescFillGapsAudio = "Fill with silence when track was muted"
5454
DescFillGapsVideo = "Fill with black frame when track was muted"
55-
DescFixDtx = "Fix DTX shrink audio"
55+
DescFixDtx = "Restore original audio duration by filling DTX silence gaps (required for A/V sync)"
5656
DescMedia = "Filter by media type: 'user', 'display', or 'both'"
5757
)
5858

‎pkg/cmd/raw-recording/extract_audio.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ func extractAudioCmd() *cobra.Command {
1616
Long: heredoc.Doc(`
1717
Generate playable audio files from raw recording tracks.
1818
19-
Supports formats: webm, mp3, and others.
19+
Output format: MKV container with Opus audio codec.
2020
2121
Filters are mutually exclusive: you can only specify one of
2222
--user-id, --session-id, or --track-id at a time.
2323
`),
2424
Example: heredoc.Doc(`
2525
# Extract audio for all users (no filters)
26-
$ stream-cli video raw-recording extract-audio --input-file recording.zip --output ./out
26+
$ stream-cli video raw-recording extract-audio --input-file recording.tar.gz --output ./out
2727
2828
# Extract audio for specific user (all their tracks)
29-
$ stream-cli video raw-recording extract-audio --input-file recording.zip --output ./out --user-id user123
29+
$ stream-cli video raw-recording extract-audio --input-file recording.tar.gz --output ./out --user-id user123
3030
3131
# Extract audio for specific session
32-
$ stream-cli video raw-recording extract-audio --input-file recording.zip --output ./out --session-id session456
32+
$ stream-cli video raw-recording extract-audio --input-file recording.tar.gz --output ./out --session-id session456
3333
3434
# Extract a specific track
35-
$ stream-cli video raw-recording extract-audio --input-file recording.zip --output ./out --track-id track1
35+
$ stream-cli video raw-recording extract-audio --input-file recording.tar.gz --output ./out --track-id track1
3636
`),
3737
RunE: runExtractAudio,
3838
}

‎pkg/cmd/raw-recording/extract_video.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ func extractVideoCmd() *cobra.Command {
1616
Long: heredoc.Doc(`
1717
Generate playable video files from raw recording tracks.
1818
19-
Supports formats: webm, mp4, and others.
19+
Output format: MKV container with original video codec (VP8, VP9, H264, or AV1).
2020
2121
Filters are mutually exclusive: you can only specify one of
2222
--user-id, --session-id, or --track-id at a time.
2323
`),
2424
Example: heredoc.Doc(`
2525
# Extract video for all users (no filters)
26-
$ stream-cli video raw-recording extract-video --input-file recording.zip --output ./out
26+
$ stream-cli video raw-recording extract-video --input-file recording.tar.gz --output ./out
2727
2828
# Extract video for specific user (all their tracks)
29-
$ stream-cli video raw-recording extract-video --input-file recording.zip --output ./out --user-id user123
29+
$ stream-cli video raw-recording extract-video --input-file recording.tar.gz --output ./out --user-id user123
3030
3131
# Extract video for specific session
32-
$ stream-cli video raw-recording extract-video --input-file recording.zip --output ./out --session-id session456
32+
$ stream-cli video raw-recording extract-video --input-file recording.tar.gz --output ./out --session-id session456
3333
3434
# Extract a specific track
35-
$ stream-cli video raw-recording extract-video --input-file recording.zip --output ./out --track-id track1
35+
$ stream-cli video raw-recording extract-video --input-file recording.tar.gz --output ./out --track-id track1
3636
`),
3737
RunE: runExtractVideo,
3838
}

‎pkg/cmd/raw-recording/list_tracks.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ func listTracksCmd() *cobra.Command {
2626
`),
2727
Example: heredoc.Doc(`
2828
# List all tracks in table format
29-
$ stream-cli video raw-recording list-tracks --input-file recording.zip
29+
$ stream-cli video raw-recording list-tracks --input-file recording.tar.gz
3030
3131
# Get JSON output for programmatic use
32-
$ stream-cli video raw-recording list-tracks --input-file recording.zip --format json
32+
$ stream-cli video raw-recording list-tracks --input-file recording.tar.gz --format json
3333
3434
# Get user IDs only
35-
$ stream-cli video raw-recording list-tracks --input-file recording.zip --format users
35+
$ stream-cli video raw-recording list-tracks --input-file recording.tar.gz --format users
3636
3737
# Filter by track type
38-
$ stream-cli video raw-recording list-tracks --input-file recording.zip --track-type audio
38+
$ stream-cli video raw-recording list-tracks --input-file recording.tar.gz --track-type audio
3939
`),
4040
RunE: runListTracks,
4141
}

‎pkg/cmd/raw-recording/mix_audio.go‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,17 @@ func mixAudioCmd() *cobra.Command {
1717
Mix all audio tracks from multiple users/sessions into a single audio file
1818
with proper timing synchronization (like a conference call recording).
1919
20-
Creates 'mixed_audio.webm' - a single audio file containing all mixed tracks
21-
with proper timing synchronization based on the original recording timeline.
20+
Creates a composite audio file (MKV format by default) containing all mixed
21+
tracks with proper timing synchronization based on the original recording timeline.
22+
23+
Output: composite_{callType}_{callId}_audio_{timestamp}.mkv
2224
`),
2325
Example: heredoc.Doc(`
2426
# Mix all audio tracks from all users and sessions
25-
$ stream-cli video raw-recording mix-audio --input-file recording.zip --output ./out
27+
$ stream-cli video raw-recording mix-audio --input-file recording.tar.gz --output ./out
2628
2729
# Mix with verbose logging
28-
$ stream-cli video raw-recording mix-audio --input-file recording.zip --output ./out --verbose
30+
$ stream-cli video raw-recording mix-audio --input-file recording.tar.gz --output ./out --verbose
2931
`),
3032
RunE: runMixAudio,
3133
}

‎pkg/cmd/raw-recording/mux_av.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ func muxAVCmd() *cobra.Command {
2929
`),
3030
Example: heredoc.Doc(`
3131
# Mux all tracks
32-
$ stream-cli video raw-recording mux-av --input-file recording.zip --output ./out
32+
$ stream-cli video raw-recording mux-av --input-file recording.tar.gz --output ./out
3333
3434
# Mux tracks for specific user
35-
$ stream-cli video raw-recording mux-av --input-file recording.zip --output ./out --user-id user123
35+
$ stream-cli video raw-recording mux-av --input-file recording.tar.gz --output ./out --user-id user123
3636
3737
# Mux only user camera tracks
38-
$ stream-cli video raw-recording mux-av --input-file recording.zip --output ./out --media user
38+
$ stream-cli video raw-recording mux-av --input-file recording.tar.gz --output ./out --media user
3939
4040
# Mux only display sharing tracks
41-
$ stream-cli video raw-recording mux-av --input-file recording.zip --output ./out --media display
41+
$ stream-cli video raw-recording mux-av --input-file recording.tar.gz --output ./out --media display
4242
`),
4343
RunE: runMuxAV,
4444
}

‎pkg/cmd/raw-recording/process_all.go‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,27 @@ func processAllCmd() *cobra.Command {
1616
Long: heredoc.Doc(`
1717
Process audio, video, and mux them into combined files (all-in-one workflow).
1818
19-
Outputs 3 files per session: audio WebM, video WebM, and muxed WebM.
20-
Gap filling is always enabled for seamless playback.
19+
Outputs multiple MKV files: individual audio/video tracks, muxed A/V, and mixed audio.
20+
Gap filling and DTX fix are always enabled for seamless playback and proper A/V sync.
2121
2222
Filters are mutually exclusive: you can only specify one of
2323
--user-id, --session-id, or --track-id at a time.
2424
25-
Output files per session:
26-
audio_{userId}_{sessionId}_{trackId}.webm - Audio-only file
27-
video_{userId}_{sessionId}_{trackId}.webm - Video-only file
28-
muxed_{userId}_{sessionId}_{trackId}.webm - Combined audio+video file
25+
Output files:
26+
individual_{callType}_{callId}_{userId}_{sessionId}_audio_only_{timestamp}.mkv
27+
individual_{callType}_{callId}_{userId}_{sessionId}_video_only_{timestamp}.mkv
28+
individual_{callType}_{callId}_{userId}_{sessionId}_audio_video_{timestamp}.mkv
29+
composite_{callType}_{callId}_audio_{timestamp}.mkv
2930
`),
3031
Example: heredoc.Doc(`
3132
# Process all tracks
32-
$ stream-cli video raw-recording process-all --input-file recording.zip --output ./out
33+
$ stream-cli video raw-recording process-all --input-file recording.tar.gz --output ./out
3334
3435
# Process tracks for specific user
35-
$ stream-cli video raw-recording process-all --input-file recording.zip --output ./out --user-id user123
36+
$ stream-cli video raw-recording process-all --input-file recording.tar.gz --output ./out --user-id user123
3637
3738
# Process tracks for specific session
38-
$ stream-cli video raw-recording process-all --input-file recording.zip --output ./out --session-id session456
39+
$ stream-cli video raw-recording process-all --input-file recording.tar.gz --output ./out --session-id session456
3940
`),
4041
RunE: runProcessAll,
4142
}

‎pkg/cmd/raw-recording/root.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ func NewRootCmd() *cobra.Command {
3939
`),
4040
Example: heredoc.Doc(`
4141
# List all tracks in a recording
42-
$ stream-cli video raw-recording list-tracks --input-file recording.zip
42+
$ stream-cli video raw-recording list-tracks --input-file recording.tar.gz
4343
4444
# Extract audio tracks for a specific user
45-
$ stream-cli video raw-recording extract-audio --input-file recording.zip --output ./out --user-id user123
45+
$ stream-cli video raw-recording extract-audio --input-file recording.tar.gz --output ./out --user-id user123
4646
4747
# Mux audio and video tracks
48-
$ stream-cli video raw-recording mux-av --input-file recording.zip --output ./out
48+
$ stream-cli video raw-recording mux-av --input-file recording.tar.gz --output ./out
4949
`),
5050
}
5151

0 commit comments

Comments
 (0)