Public Member Functions | |
RecordingSDK () | |
void | registerOberserver (RecordingEventHandler recordingEventHandler) |
void | unRegisterOberserver (RecordingEventHandler recordingEventHandler) |
native boolean | createChannel (String appId, String channelKey, String name, int uid, RecordingConfig config, int logLevel) |
native boolean | leaveChannel (long nativeHandle) |
native int | setVideoMixingLayout (long nativeHandle, VideoMixingLayout layout) |
native int | startService (long nativeHandle) |
native int | stopService (long nativeHandle) |
native RecordingEngineProperties | getProperties (long nativeHandle) |
io.agora.recording.RecordingSDK.RecordingSDK | ( | ) |
Main methods that can be invoked by your app.
void io.agora.recording.RecordingSDK.registerOberserver | ( | RecordingEventHandler | recordingEventHandler | ) |
To register observer to receive Recording event notification.
void io.agora.recording.RecordingSDK.unRegisterOberserver | ( | RecordingEventHandler | recordingEventHandler | ) |
To remove previously registered observer.
native boolean io.agora.recording.RecordingSDK.createChannel | ( | String | appId, |
String | channelKey, | ||
String | name, | ||
int | uid, | ||
RecordingConfig | config, | ||
int | logLevel | ||
) |
This method creates a channel and enables the app to join the channel.
appId | The App ID used in the communication to be recorded. For details, see Getting an App ID. |
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 details, see Use Security Keys. |
name | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
uid | User ID. A 32-bit unsigned integer ranging from 1 to (232-1) that is unique in a channel. Two Settings:
|
config | Detailed recording configuration. See RecordingConfig. |
logLevel | Generate the level of the log. After setting up, only logs with a level lower than logLevel will be generated. |
native boolean io.agora.recording.RecordingSDK.leaveChannel | ( | long | nativeHandle | ) |
This method allows the recording app to leave the channel and release the thread resources.
nativeHandle | The recording engine. |
native int io.agora.recording.RecordingSDK.setVideoMixingLayout | ( | long | nativeHandle, |
VideoMixingLayout | layout | ||
) |
This method sets the video mixing layout.
nativeHandle | The recording engine. |
layout | Layout setting. See VideoMixingLayout. |
native int io.agora.recording.RecordingSDK.startService | ( | long | nativeHandle | ) |
This method manually starts a recording. The method is only valid when you set triggerMode to 1 (manually) when joining the channel. For more information, see triggerMode.
nativeHandle | The recording engine. |
native int io.agora.recording.RecordingSDK.stopService | ( | long | nativeHandle | ) |
This method manually pauses the recording. The method is only valid when you set triggerMode to 1 (manually) when joining the channel. For more information, see triggerMode.
nativeHandle | The recording engine. |
native RecordingEngineProperties io.agora.recording.RecordingSDK.getProperties | ( | long | nativeHandle | ) |
This method allows you to retrieve the recording properties without joining a channel.
nativeHandle | The recording engine. |