#include <IAgoraRecordingEngine.h>
Public Member Functions | |
virtual | ~IRecordingEngine () |
virtual int | joinChannel (const char *channelKey, const char *channelId, uid_t uid, const RecordingConfig &config)=0 |
virtual int | setVideoMixingLayout (const agora::linuxsdk::VideoMixingLayout &layout)=0 |
virtual int | stoppedOnError ()=0 |
virtual int | leaveChannel ()=0 |
virtual int | release ()=0 |
virtual const RecordingEngineProperties * | getProperties ()=0 |
virtual int | startService ()=0 |
virtual int | stopService ()=0 |
virtual int | setUserBackground (uid_t uid, const char *img_path)=0 |
virtual int | setLogLevel (agora::linuxsdk::agora_log_level level)=0 |
Static Public Member Functions | |
static IRecordingEngine * | createAgoraRecordingEngine (const char *appId, IRecordingEngineEventHandler *eventHandler) |
The IRecordingEngine class provides the main methods that can be invoked by your application.
|
inlinevirtual |
|
static |
This method creates the Agora recording engine object.
appId | The App ID used in the communications to be recorded. For more information, see Get an App ID. |
eventHandler | The Agora Recording SDK notifies the application of the triggered events by callbacks in the IRecordingEngineEventHandler. |
|
pure virtual |
This method allows the recording application to join a channel and start recording.
channelKey | This parameter is optional if the user uses a static key, or App ID. In this case, pass NULL as the parameter value. For more information, see Use Security Keys. |
channelId | Name of the channel to be recorded. The length must be within 64 bytes. The following is the supported scope:
|
uid | UID. A 32-bit unsigned integer ranging from 1 to (232-1) that is unique in a channel. |
config | Detailed recording configuration. See the structure RecordingConfig. |
|
pure virtual |
This method sets the video mixing layout.
layout | Layout setting. See VideoMixingLayout. |
|
pure virtual |
|
pure virtual |
This method allows the recording application to leave the channel and release the thread resources.
|
pure virtual |
This method destroys the IRecordingEngine object.
|
pure virtual |
This method allows you to retrieve the recording properties without joining a channel. For more information, see RecordingEngineProperties.
|
pure virtual |
This method manually starts recording.
The method is only valid when you set triggerMode to 1 (manually) when joining the channel. For more information, see TRIGGER_MODE_TYPE.
|
pure virtual |
This method manually stops recording.
The method is only valid when you set triggerMode to 1 (manually) when joining the channel. For more information, see TRIGGER_MODE_TYPE.
|
pure virtual |
This method sets the background image of a specified user. When the user is online but not sending out any video stream, the background image is displayed.
uid | The UID of the user for the background image to be set. |
img_path | The path of the image file. |
|
pure virtual |
This method sets the log level.
Only log levels preceding the selected level are generated. The default value of the log level is 6.
level | See agora_log_level. |