Skip to main content

You are viewing Agora Docs forBeta products and features. Switch to Docs

Use Trancoding Scripts

The transcoding tool includes the video_convert.py and ffmpeg modules. The Python script can merge the separated audio and video recorded files into one MPEG-4 file and the script relies on the ffmpeg transcoding tool. You can get ffmpeg and video_convert.py in the tools folder in On-Premise Recording SDK. Decompress ffmpeg, and make sure it is in the same directory as video_convert.py.

Execute python video_convert.py with the following usage:


_13
Usage: video_convert.py [options]
_13
_13
Options:
_13
-h, --help
_13
-f FOLDER, --folder=FOLDER
_13
Convert folder
_13
-m MODE, --mode=MODE Convert merge mode, [0: txt merge A/V(Default); 1: uid
_13
merge A/V; 2: uid merge audio; 3: uid merge video]
_13
-p PFS, --fps=FPS Convert fps, default 15
_13
-s --saving Convert Do not time sync
_13
-r RESOLUTION, --resolution=RESOLUTION
_13
Specific resolution to convert '-r width height'
_13
Eg: '-r 640 360'

OptionDescription
-fThe directory of the file to be transcoded.
-mThe transcoding mode:
  • 0: Transcode by the session. Merge the audio and video files of one session into one file.
  • 1: Merge the audio and video files of the same uid into a file chronologically.
  • 2: Merge the audio files of the same uid into a file chronologically.
  • 3: Merge the video files of the same uid into a file chronologically.
  • -pThe parameter for setting the frame rate in both composite and individual recording. 15 fps is the default value.
    -sThe saving mode that indicates if the transcoding should be strictly synchronized with time; in other words, if the time interval when the user is not in the channel is in the recorded file. Make sure that you use this parameter together with -m = 1, 2 or 3. The default value indicates “always recording”.
    -rThe parameter for setting the resolution of transcoding in the “width height” format.
    • If multiple audio files are generated after the recording, transcoding merges them into one M4A file in the format of UIDHHMMSSMS.m4a.
    • If multiple audio and video files are generated after the recording, transcoding merges them into one MPEG-4 file in the format of UID_HHMMSSMS_av.mp4. To merge the audio and video files by the session:
      • If a uid leaves a channel and rejoins it within 15 seconds, the Agora On-Premise Recording SDK considers this session as one. A new audio file is not generated but a new video file is generated and merged into the audio and video file, and a UIDHHMMSSMSav.mp4 file is generated.
      • If a uid leaves a channel and rejoins it after 15 seconds, the Agora On-Premise Recording SDK considers this as two separate sessions. A new audio and video file is generated, and a new UIDHHMMSSMSav.mp4 file is generated for the new session.
    • If multiple audio and video files are generated after the recording, and you wish to merge the MPEG-4 files of different sessions by the uid, transcoding merges them into different MPEG-4 files such as UID_0_merge_av.mp4, UID_1_merge_av.mp4, and UID_2_merge_av.mp4.
    • triggerMode = 0 is the automatic recording mode. The -m parameter merges all audio and video files of one uid and generates a single UID_0_merge_av.mp4 file.
    • triggerMode = 1 is the manual recording mode. The start and stop parameters manage and separate the recorded files. Each start/stop makes one session, and the -m parameter generates multiple UID_XX_merge_av.mp4 files.

    See the following figure for the different transcoding script options:

    ../_images/recording_demo.png

    The transcoded MPEG-4 file supports the following players:

    Operation SystemPlayers
    WindowsWindows Media Player, KMPlayer, VLC Media Player
    MacMac QuickTime Player, Movist, MPlayerX, KMPlayer
    iOSiOS default player, VLC Media Player, KMPlayer
    AndroidAndroid default player, MX Player, VLC Media Player, KMPlayer

    You can start transcoding only if a recording2-done.txt file exists in the recording folder. A convert-done.txt file is generated after the transcoding is complete. Once the transcoding script is used, a convert.log file is generated in the same directory as the audio and video files upon completion of the transcoding.

    vundefined