Public Member Functions | |
RecordingConfig () | |
Public Attributes | |
boolean | isAudioOnly |
boolean | isVideoOnly |
boolean | isMixingEnabled |
MIXED_AV_CODEC_TYPE | mixedVideoAudio |
String | mixResolution |
String | decryptionMode |
String | secret |
String | appliteDir |
String | recordFileRootDir |
String | cfgFilePath |
VIDEO_FORMAT_TYPE | decodeVideo |
AUDIO_FORMAT_TYPE | decodeAudio |
int | lowUdpPort |
int | highUdpPort |
int | idleLimitSec |
int | captureInterval |
int | audioIndicationInterval |
CHANNEL_PROFILE_TYPE | channelProfile |
REMOTE_VIDEO_STREAM_TYPE | streamType |
int | triggerMode |
String | proxyServer |
int | audioProfile |
String | defaultVideoBgPath |
String | defaultUserBgPath |
io.agora.recording.common.RecordingConfig.RecordingConfig | ( | ) |
boolean io.agora.recording.common.RecordingConfig.isAudioOnly |
Sets whether or not to record audio only:
Used together with isVideoOnly:
boolean io.agora.recording.common.RecordingConfig.isVideoOnly |
Sets whether or not to record video only:
Used together with isAudioOnly:
boolean io.agora.recording.common.RecordingConfig.isMixingEnabled |
Sets whether or not to enable the composite recording mode.
MIXED_AV_CODEC_TYPE io.agora.recording.common.RecordingConfig.mixedVideoAudio |
If you set isMixingEnabled as true, mixedVideoAudio allows you to mix the audio and video in an MP4 file in real time. For more information, see MIXED_AV_CODEC_TYPE.
String io.agora.recording.common.RecordingConfig.mixResolution |
If you set isMixingEnabled as true, mixResolution allows you to set the video profile, including the width, height, frame rate, and bitrate. The default setting is 360 x 640, 15 fps, 500 Kbps.
See the Video Profile Table.
String io.agora.recording.common.RecordingConfig.decryptionMode |
When the whole channel is encrypted, the recording SDK uses decryptionMode to enable the built-in decryption function:
The default value is NULL.
String io.agora.recording.common.RecordingConfig.secret |
The decryption password when decryption mode is enabled. The default value is NULL.
String io.agora.recording.common.RecordingConfig.appliteDir |
Sets the path of AgoraCoreService. The default path of AgoraCoreService is Agora_Recording_SDK_for_Linux_FULL/bin/.
String io.agora.recording.common.RecordingConfig.recordFileRootDir |
Sets the path of the recorded files. The default value is NULL.
After setting recordFileRootDir
, the subdirectory will be automatically generated according to the date of the recording.
String io.agora.recording.common.RecordingConfig.cfgFilePath |
Sets the path of the configuration file. The default value is NULL.
In the configuration file, you can set the absolute directory of the output, but the subdirectory will not be generated automatically. The content in the configuration file must be in JSON format, such as {"Recording_Dir" : "<recording path>"}. You cannot change "Recording_Dir".
VIDEO_FORMAT_TYPE io.agora.recording.common.RecordingConfig.decodeVideo |
Sets the video decoding format. See VIDEO_FORMAT_TYPE.
AUDIO_FORMAT_TYPE io.agora.recording.common.RecordingConfig.decodeAudio |
Sets the audio decoding format. See AUDIO_FORMAT_TYPE.
int io.agora.recording.common.RecordingConfig.lowUdpPort |
Sets the lowest UDP port. The default value is 0. Ensure that the value of highUdpPort - lowUdpPort ≥ 6.
int io.agora.recording.common.RecordingConfig.highUdpPort |
Sets the highest UDP port. The default value is 0. Ensure that the value of highUdpPort - lowUdpPort ≥ 6.
int io.agora.recording.common.RecordingConfig.idleLimitSec |
Sets a time period. The value must be ≥ 3 seconds. The default value is 300 seconds.
When the Agora Recording SDK is recording, if there is no user in the channel after a time period of idleLimitSec
, it automatically stops recording and leaves the channel.
int io.agora.recording.common.RecordingConfig.captureInterval |
Sets the interval of the screen capture. The interval must be longer than 1 second and the default value is 5 seconds.
captureInterval
is only valid when decodeVideo is set as 3, 4 or 5. int io.agora.recording.common.RecordingConfig.audioIndicationInterval |
Sets whether or not to detect the users who speak.
CHANNEL_PROFILE_TYPE io.agora.recording.common.RecordingConfig.channelProfile |
Sets the channel mode. See CHANNEL_PROFILE_TYPE.
REMOTE_VIDEO_STREAM_TYPE io.agora.recording.common.RecordingConfig.streamType |
streamType
takes effect only when the Agora Native SDK/Web SDK enables the dual-stream mode (high stream by default). See REMOTE_VIDEO_STREAM_TYPE.
int io.agora.recording.common.RecordingConfig.triggerMode |
Sets whether to start the recording automatically or manually:
If you wish to call startService and stopService, then choose Manually.
String io.agora.recording.common.RecordingConfig.proxyServer |
Deploys the Enterprise Proxy. It allows you to record the content with the Intranet server. For details, please contact support@agora.io.
int io.agora.recording.common.RecordingConfig.audioProfile |
If you set isMixingEnabled as true, mixResolution allows you to set the audio profile of the recording file:
String io.agora.recording.common.RecordingConfig.defaultVideoBgPath |
Sets the path of the default background image of the canvas in composite recording mode. If defaultVideoBgPath
is not set, the cavas displays the background color.
String io.agora.recording.common.RecordingConfig.defaultUserBgPath |
Sets the path of the default background image of users in composite recording mode.
The background image is displayed when a user is online and does not send any video stream. If defaultUserBgPath
is not set, the the user region displays the background color.