|
On-premise Recording SDK v3.0.6 API Reference for Linux (C++)
|
The IRecordingEngine class provides the main methods that can be invoked by your application.
| Method | Description |
|---|---|
| createAgoraRecordingEngine | Creates an IRecordingEngine instance. |
| joinChannel | Allows the recording server to join a channel. |
| joinChannelWithUserAccount | Allows the recording server to join the channel with the user account. |
| getUserInfoByUserAccount | Gets the user information by passing in the user account. |
| getUserInfoByUid | Gets the user information by passing in the user ID. |
| setVideoMixingLayout | Sets the video layout in composite recording mode. |
| updateWatermarkConfigs | Adds, updates, or deletes the watermark configurations. |
| stoppedOnError | Stops onError handler. |
| updateSubscribeVideoUids | Updates the UIDs of the users whose video streams you want to record. |
| updateSubscribeAudioUids | Updates the UIDs of the users whose audio streams you want to record. |
| leaveChannel | Allows the recording server to leave the channel. |
| release | Releases the IRecordingEngine instance. |
| getProperties | Retrieves the recording properties. |
| startService | Manually starts the recording. |
| stopService | Manually stops the recording. |
| setUserBackground | Sets the user background image. |
| setLogLevel | Sets the log level. |
The IRecordingEngineEventHandler class enables callbacks to your application.
| Callback | Description |
|---|---|
| onError | Occurs when an error occurs during SDK runtime. |
| onWarning | Occurs when a warning occurs during SDK runtime. |
| onConnectionLost | Occurs when the SDK loses connection to the server. |
| onConnectionInterrupted | Occurs when the connection between the SDK and the server is interrupted. |
| onConnectionStateChanged | Occurs when the network connection state changes. |
| onJoinChannelSuccess | Occurs when the recording server joins the specified channel. |
| onLocalUserRegistered | Occurs when the recording server successfully registers a user account. |
| onUserInfoUpdated | Occurs when the SDK gets the user ID and user account of a remote user. |
| onRejoinChannelSuccess | Occurs when the recording server rejoins the channel after being disconnected due to network problems. |
| onLeaveChannel | Occurs when the recording server leaves the channel. |
| onUserJoined | Occurs when a remote user joins the channel. |
| onUserOffline | Occurs when a remote user leaves the channel. |
| audioFrameReceived | Occurs when the raw audio data is received. |
| videoFrameReceived | Occurs when the video frame is received. |
| onAudioVolumeIndication | Reports the list of users who are speaking and their volumes. |
| onActiveSpeaker | Reports the user who speaks loudest. |
| onFirstRemoteAudioFrame | Occurs when the first remote audio frame is received. |
| onFirstRemoteVideoDecoded | Occurs when the first remote video frame is decoded. |
| onReceivingStreamStatusChanged | Occurs when the status of receiving the audio or video stream changes. |
| onRemoteAudioStreamStateChanged | Occurs when the state of a remote user's audio stream changes. |
| onRemoteVideoStreamStateChanged | Occurs when the state of a remote user's video stream changes. |
| onRemoteVideoStats | Reports the statistics of the video stream from the remote user. |
| onRemoteAudioStats | Reports the statistics of the audio stream from the remote user. |
| onRecordingStats | Reports the statistics of IRecordingEngine once every two seconds. |