Agora Recording C++ API Reference

Sets whether or not to record audio only.

• true: Enables audio recording and disables video recording.
• false: (Default) Enables both audio and video recording.

Used together with isVideoOnly:

• If isAudioOnly is true and isVideoOnly is false, only records audio;
• If isAudioOnly is false and isVideoOnly is true, only records video;
• If isAudioOnly is false and isVideoOnly is false, records both audio and video;
• isAudioOnly and isVideoOnly can not be set as true at the same time.

Sets whether or not to record video only.

• true: Enables video recording and disables audio recording.
• false: (Default) Enables both audio and video recording.

Used together with isAudioOnly:

• If isAudioOnly is true and isVideoOnly is false, only records audio;
• If isAudioOnly is false and isVideoOnly is true, only records video;
• If isAudioOnly is false and isVideoOnly is false, records both audio and video;
• isAudioOnly and isVideoOnly cannot be set as true at the same time.

Sets whether or not to enable the audio- or video-mixing mode.

• true: Enables the composite mode, which means the audio of all uids is mixed in an audio file and the video of all uids is mixed in a video file. The sample rate, bitrate, and audio channel number of the recorded file are the same as the highest level of those of the original audio streams.
• false: (Default) Enables the individual mode, which means one audio or video file for an uid. The bitrate and audio channel number of the recording file are the same as those of the original audio stream.

If you set isMixingEnabled as true and enable the composite mode, mixedVideoAudio allows you to mix the audio and video in a file in real time. For more information, see MIXED_AV_CODEC_TYPE.

If you set isMixingEnabled as true and enable the composite mode, mixResolution allows you to set the video profile, including the width, height, frame rate, and bitrate.

Resolution, Frame Rate and Bitrate Table

When the whole channel is encrypted, the recording SDK uses decryptionMode to enable the built-in decryption function.

The following decryption methods are supported:

• “aes-128-xts”: AES-128, XTS mode.
• “aes-128-ecb”: AES-128, ECB mode.
• “aes-256-xts”: AES-256, XTS mode.

The decryption password when the decryptionMode is enabled. The default value is NULL.

The directory of AgoraCoreService. The default value is NULL.

The root directory of the recorded files. The default value is NULL. The sub-path will be generated automatically.

The path of the configuration file. The default value is NULL. In the configuration file, you can set the absolute path of the recorded file, but the sub-path will not be generated automatically. The content in the configuration file must be in JSON format, such as {“Recording_Dir” : “<recording path>”}. “Recording_Dir” can not be changed.

Video decoding format. For more information, see VIDEO_FORMAT_TYPE.

Note

• When VIDEO_FORMAT_TYPE = 1, 2, 3 or 4, isMixingEnabled cannot be set as true.
• When VIDEO_FORMAT_TYPE = 1, 2, 3 or 5, raw video data in YUV format for the Web SDK is supported while H.264 format is not supported.

Audio decoding format. For more information, see AUDIO_FORMAT_TYPE.

Note

When AUDIO_FORMAT_TYPE = 1, 2 or 3, isMixingEnabled cannot be set as true.

The lowest UDP port.

Ensure that the value of highUdpPort - lowUdpPort is ≥ 4. The default value is 0.

The highest UDP port.

Ensure that the value of highUdpPort - lowUdpPort is ≥ 4. The default value is 0.

The Agora Recording SDK automatically stops recording when there is no user in the channel after a time period of idleLimitSec.

The value must be ≥ 3 seconds. The default value is 300 seconds.

The time interval of the screen capture.

The time interval must be longer than 1 second and the default value is 5 seconds. captureInterval is only valid when the VIDEO_FORMAT_TYPE = 3, 4 or 5.

Whether or not to detect speakers. It is disabled by default.

• ≤ 0: Disables the function of detecting speakers.
• > 0: The time interval (ms) of detecting speakers. Agora recommends setting the time interval to be longer than 200ms. When a speaker is found, the SDK returns the UID of the speaker in the onActiveSpeaker callback.

Sets the channel mode. For more information, see CHANNEL_PROFILE_TYPE.

Takes effect only when the Agora Native SDK enables the dual-stream mode (high stream by default). For more information, see REMOTE_VIDEO_STREAM_TYPE.

Sets whether to record automatically or manually. For more information, see TRIGGER_MODE_TYPE.

Sets the programming language. For more information, see LANGUAGE_TYPE.

Sets the proxy server, which allows recording with the Intranet server. For more information, please contact sales.nosp@m.@ago.nosp@m.ra.io.

Audio profile of the recording file. Takes effect only when isMixingEnabled is set as true. For more information, see AUDIO_PROFILE_TYPE.

The default background image of the canvas.

The background image is displayed when a user is online but not sending out any video stream.

Note

If the user uses Agora Web SDK, the user sends the audio and video stream all the time. In this case, the background image is not displayed.