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 recording application to join the channel.
appId | Set appId of the recording application the same as that of the Native/Web SDK. A channel does not accept duplicate uids. Otherwise, there will be unpredictable behaviors. For more information, see Getting an App ID. |
channelKey | The channelKey for authentication. Set channelKey of the recording application the same as that of the Native/Web SDK. If the Native/Web SDK uses a token, channelKey must be set as the token. For more information, see Use Security Keys. In the Recording SDK, requestToken and renewToken are private interfaces. Make sure that you set expireTimestamp as 0 when generating a token, which means that the privilege, once generated, never expires. |
name | The 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 | The unique identifier of a user.
|
config | Detailed recording configuration. See RecordingConfig. |
logLevel | Sets the log level. Only logs in the levels preceding the selected level are 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 layout in composite recording mode.
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 in RecordingConfig as 1 (manually) when joining the channel.
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 in RecordingConfig as 1 (manually) when joining the channel.
nativeHandle | The recording engine. |
native RecordingEngineProperties io.agora.recording.RecordingSDK.getProperties | ( | long | nativeHandle | ) |
This method allows you to retrieve the recording properties.
nativeHandle | The recording engine. |