Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W X Y Z 

A

advancedConfig - Variable in class io.agora.recording.LocalAccessPointConfiguration
Local proxy connection, advanced Config info.
AdvancedConfigInfo - Class in io.agora.recording
The definition of the AdvancedConfigInfo class.
AdvancedConfigInfo() - Constructor for class io.agora.recording.AdvancedConfigInfo
Constructs the AdavancedConfigInfo class wirh default values.
AdvancedConfigInfo(LogUploadServerInfo) - Constructor for class io.agora.recording.AdvancedConfigInfo
 
AgoraMediaComponentFactory - Class in io.agora.recording
A factory class for creating Agora media components.
AgoraMediaComponentFactory(long) - Constructor for class io.agora.recording.AgoraMediaComponentFactory
Constructs an AgoraMediaComponentFactory instance.
AgoraMediaRtcRecorder - Class in io.agora.recording
The AgoraMediaRtcRecorder class provides functionality for recording Agora RTC media streams.
AgoraMediaRtcRecorder(long) - Constructor for class io.agora.recording.AgoraMediaRtcRecorder
Constructs an AgoraMediaRtcRecorder instance.
AgoraParameter - Class in io.agora.recording
The AgoraParameter class provides functionality to get and set various parameters for Agora SDK configuration.
AgoraParameter(long) - Constructor for class io.agora.recording.AgoraParameter
Constructs an AgoraParameter instance.
AgoraService - Class in io.agora.recording
The AgoraService class provides core functionality for Agora service initialization and management.
AgoraService() - Constructor for class io.agora.recording.AgoraService
Constructs an AgoraService instance and initializes the native components.
AgoraServiceConfiguration - Class in io.agora.recording
Configuration class for Agora service initialization.
AgoraServiceConfiguration() - Constructor for class io.agora.recording.AgoraServiceConfiguration
Constructs an AgoraServiceConfiguration instance with default values.
AgoraServiceConfiguration(boolean, boolean, boolean, Object, String, Constants.AreaCode, Constants.ChannelProfileType, String, Constants.AudioScenarioType, LogConfig, boolean, boolean, boolean) - Constructor for class io.agora.recording.AgoraServiceConfiguration
Constructs an AgoraServiceConfiguration instance with specified parameters.
alpha - Variable in class io.agora.recording.MixerLayoutConfig
The transparency level of the layout.
appId - Variable in class io.agora.recording.AgoraServiceConfiguration
The App ID of your project.
areaCode - Variable in class io.agora.recording.AgoraServiceConfiguration
The supported area code, default is AREA_CODE_GLOB
AreaCode(int) - Constructor for enum io.agora.recording.Constants.AreaCode
 
areFilesIdentical(String, String) - Static method in class io.agora.recording.utils.Utils
Compares two files to determine if they are identical
audioLossRate - Variable in class io.agora.recording.RemoteAudioStatistics
The audio loss rate in percentage.
audioScenario - Variable in class io.agora.recording.AgoraServiceConfiguration
The audio scenario.
AudioScenarioType(int) - Constructor for enum io.agora.recording.Constants.AudioScenarioType
 

B

backgroundColor - Variable in class io.agora.recording.VideoMixingLayout
The background color of the canvas, represented as a long value.
backgroundImage - Variable in class io.agora.recording.VideoMixingLayout
The background image of the canvas.
byteBufferToString(ByteBuffer) - Static method in class io.agora.recording.utils.Utils
Converts a ByteBuffer to a UTF-8 encoded string
bytesToHex(byte[]) - Static method in class io.agora.recording.utils.Utils
Converts a byte array to a hexadecimal string
byteStringToByteArray(String) - Static method in class io.agora.recording.utils.Utils
Converts a string to a byte array where each character is converted to a byte

C

canvasFps - Variable in class io.agora.recording.VideoMixingLayout
The frame rate of the canvas.
canvasHeight - Variable in class io.agora.recording.VideoMixingLayout
The height of the canvas.
canvasWidth - Variable in class io.agora.recording.VideoMixingLayout
The width of the canvas.
channelNum - Variable in class io.agora.recording.MediaRecorderConfiguration
The number of audio channels in the recording.
channelProfile - Variable in class io.agora.recording.AgoraServiceConfiguration
The channel profile.
ChannelProfileType(int) - Constructor for enum io.agora.recording.Constants.ChannelProfileType
 
checkPlatformArchitecture() - Method in class io.agora.recording.AgoraService
 
cleanDirectBuffer(ByteBuffer) - Static method in class io.agora.recording.utils.Utils
Cleans a direct ByteBuffer by setting it to null and invoking garbage collection
config - Variable in class io.agora.recording.UserMixerLayout
The layout configuration for the user.
ConnectionChangedReasonType(int) - Constructor for enum io.agora.recording.Constants.ConnectionChangedReasonType
 
Constants - Class in io.agora.recording
 
Constants() - Constructor for class io.agora.recording.Constants
 
Constants.AreaCode - Enum in io.agora.recording
The region for connection, which is the region where the server the SDK connects to is located.
Constants.AudioScenarioType - Enum in io.agora.recording
The audio scenario.
Constants.ChannelProfileType - Enum in io.agora.recording
The channel profile.
Constants.ConnectionChangedReasonType - Enum in io.agora.recording
Reasons causing the change of the connection state.
Constants.EncryptionErrorType - Enum in io.agora.recording
Encryption error types.
Constants.EncryptionMode - Enum in io.agora.recording
Encryption modes.
Constants.ErrorCodeType - Enum in io.agora.recording
The error codes.
Constants.LocalProxyMode - Enum in io.agora.recording
The local proxy mode type.
Constants.LogLevel - Enum in io.agora.recording
Log Level.
Constants.MediaRecorderContainerFormat - Enum in io.agora.recording
* The format of the recording file.
Constants.MediaRecorderStreamType - Enum in io.agora.recording
The recording content.
Constants.RecorderReasonCode - Enum in io.agora.recording
The reason for the state change.
Constants.RecorderState - Enum in io.agora.recording
The current recording state.
Constants.RemoteAudioState - Enum in io.agora.recording
Remote audio states.
Constants.RemoteAudioStateReason - Enum in io.agora.recording
Reasons for the remote audio state change.
Constants.RemoteVideoState - Enum in io.agora.recording
The state of the remote video.
Constants.RemoteVideoStateReason - Enum in io.agora.recording
The reason for the remote video state change.
Constants.UserOfflineReasonType - Enum in io.agora.recording
Reasons for a user being offline.
Constants.VideoSourceType - Enum in io.agora.recording
Video source types definition.
Constants.VideoStreamType - Enum in io.agora.recording
Video stream types.
Constants.WatermarkFitMode - Enum in io.agora.recording
The adaptation mode of the watermark.
Constants.WatermarkSourceType - Enum in io.agora.recording
The definition of the WatermarkSourceType enum.
containerFormat - Variable in class io.agora.recording.MediaRecorderConfiguration
The format of the recording file.
context - Variable in class io.agora.recording.AgoraServiceConfiguration
The user context.
convertPath(String) - Method in class io.agora.recording.AgoraParameter
Converts a file path to a platform-specific format.
createAgoraMediaComponentFactory() - Method in class io.agora.recording.AgoraService
Creates and returns an AgoraMediaComponentFactory object for creating media
createMediaRtcRecorder() - Method in class io.agora.recording.AgoraMediaComponentFactory
Creates a new instance of AgoraMediaRtcRecorder.

D

decoderOutputFrameRate - Variable in class io.agora.recording.RemoteVideoStatistics
The frame rate of the decoded video output.
DEFAULT_LOG_SIZE_IN_KB - Static variable in class io.agora.recording.Constants
Default log file size in KB
delay - Variable in class io.agora.recording.RemoteVideoStatistics
The delay in milliseconds.
deleteAllFile(String) - Static method in class io.agora.recording.utils.Utils
Deletes all files in the directory that start with the specified file name
disableAut - Variable in class io.agora.recording.LocalAccessPointConfiguration
Whether to disable vos-aut: true: (Default) disable vos-aut. false: not disable vos-aut
disableVideoWatermarks() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Disable the watermark for the stream
disableVideoWatermarksByUid(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Disable the watermark for the stream by uid
domainLimit - Variable in class io.agora.recording.AgoraServiceConfiguration
Determines whether to enable domain limit.
domainList - Variable in class io.agora.recording.LocalAccessPointConfiguration
Local access point domain list.
domainListSize - Variable in class io.agora.recording.LocalAccessPointConfiguration
The number of local access point domain.
durationMs - Variable in class io.agora.recording.RecorderInfo
The recording duration, in milliseconds.

E

enableAndUpdateVideoWatermarks(WatermarkConfig[]) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Add the watermark for the stream
enableAndUpdateVideoWatermarksByUid(WatermarkConfig[], String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Add the watermark for the stream by uid
enableAudioDevice - Variable in class io.agora.recording.AgoraServiceConfiguration
Whether to enable the audio device module.
enableAudioProcessor - Variable in class io.agora.recording.AgoraServiceConfiguration
Whether to enable the audio processing module.
enableEncryption(boolean, EncryptionConfig) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Enables or disables the built-in encryption.
enableVideo - Variable in class io.agora.recording.AgoraServiceConfiguration
Whether to enable video.
encodedFrameOnly - Variable in class io.agora.recording.VideoSubscriptionOptions
Whether to subscribe to encoded video data only: - `true`: Subscribe to encoded video data only.
EncryptionConfig - Class in io.agora.recording
The EncryptionConfig class provides the configuration for encryption in the Agora recording SDK.
EncryptionConfig() - Constructor for class io.agora.recording.EncryptionConfig
Constructs an EncryptionConfig object with default values.
EncryptionErrorType(int) - Constructor for enum io.agora.recording.Constants.EncryptionErrorType
 
encryptionKdfSalt - Variable in class io.agora.recording.EncryptionConfig
The salt for the encryption key.
encryptionKey - Variable in class io.agora.recording.EncryptionConfig
The encryption key in the string format.
EncryptionMode(int) - Constructor for enum io.agora.recording.Constants.EncryptionMode
 
encryptionMode - Variable in class io.agora.recording.EncryptionConfig
The encryption mode.
ErrorCodeType(int) - Constructor for enum io.agora.recording.Constants.ErrorCodeType
 

F

fileName - Variable in class io.agora.recording.RecorderInfo
The absolute path of the recording file.
filePath - Variable in class io.agora.recording.LogConfig
The log file path.
fileSize - Variable in class io.agora.recording.RecorderInfo
The size in bytes of the recording file.
fileSizeInKB - Variable in class io.agora.recording.LogConfig
The log file size in KB.
fontFilePath - Variable in class io.agora.recording.WatermarkLitera
The path of the font file for the litera.
fontFilePath - Variable in class io.agora.recording.WatermarkTimestamp
The path of the font file for the timestamp.
fontSize - Variable in class io.agora.recording.WatermarkLitera
The font size of the litera.
fontSize - Variable in class io.agora.recording.WatermarkTimestamp
The font size of the timestamp.
formatTimestamp(long, String) - Static method in class io.agora.recording.utils.Utils
Formats a timestamp into a string based on the given pattern
fps - Variable in class io.agora.recording.MediaRecorderConfiguration
The frame rate of the recorded video in frames per second.
fromInt(int) - Static method in enum io.agora.recording.Constants.AreaCode
 
fromInt(int) - Static method in enum io.agora.recording.Constants.AudioScenarioType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.ChannelProfileType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.ConnectionChangedReasonType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.EncryptionErrorType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.EncryptionMode
 
fromInt(int) - Static method in enum io.agora.recording.Constants.ErrorCodeType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.LocalProxyMode
 
fromInt(int) - Static method in enum io.agora.recording.Constants.LogLevel
 
fromInt(int) - Static method in enum io.agora.recording.Constants.MediaRecorderContainerFormat
 
fromInt(int) - Static method in enum io.agora.recording.Constants.MediaRecorderStreamType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RecorderReasonCode
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RecorderState
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RemoteAudioState
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RemoteAudioStateReason
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RemoteVideoState
 
fromInt(int) - Static method in enum io.agora.recording.Constants.RemoteVideoStateReason
 
fromInt(int) - Static method in enum io.agora.recording.Constants.UserOfflineReasonType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.VideoSourceType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.VideoStreamType
 
fromInt(int) - Static method in enum io.agora.recording.Constants.WatermarkFitMode
 
fromInt(int) - Static method in enum io.agora.recording.Constants.WatermarkSourceType
 

G

getAdvancedConfig() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get advanced config info.
getAgoraParameter() - Method in class io.agora.recording.AgoraService
Creates and returns an AgoraParameter object for parameter management.
getAlpha() - Method in class io.agora.recording.MixerLayoutConfig
Gets the transparency level of the layout.
getAppId() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the App ID.
getAreaCode() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the area code.
getArray(String, String) - Method in class io.agora.recording.AgoraParameter
Retrieves an array parameter value as a JSON string.
getAudioLossRate() - Method in class io.agora.recording.RemoteAudioStatistics
Gets the audio loss rate in percentage.
getAudioScenario() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the audio scenario.
getBackgroundColor() - Method in class io.agora.recording.VideoMixingLayout
Gets the background color of the canvas.
getBackgroundImage() - Method in class io.agora.recording.VideoMixingLayout
Gets the background image of the canvas.
getBool(String) - Method in class io.agora.recording.AgoraParameter
Retrieves a boolean parameter value.
getCanvasFps() - Method in class io.agora.recording.VideoMixingLayout
Gets the frame rate of the canvas.
getCanvasHeight() - Method in class io.agora.recording.VideoMixingLayout
Gets the height of the canvas.
getCanvasWidth() - Method in class io.agora.recording.VideoMixingLayout
Gets the width of the canvas.
getChannelNum() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the number of audio channels.
getChannelProfile() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the channel profile.
getConfig() - Method in class io.agora.recording.UserMixerLayout
Gets the layout configuration for the user.
getContainerFormat() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the container format of the recording file.
getContext() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the context object.
getDecoderOutputFrameRate() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the frame rate of the decoded video output.
getDelay() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the delay in milliseconds.
getDomainList() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get local access point domain list.
getDomainListSize() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get the number of local access point domain.
getDurationMs() - Method in class io.agora.recording.RecorderInfo
Gets the recording duration in milliseconds.
getEncryptionKdfSalt() - Method in class io.agora.recording.EncryptionConfig
Gets the encryption salt.
getEncryptionKey() - Method in class io.agora.recording.EncryptionConfig
Gets the encryption key.
getEncryptionMode() - Method in class io.agora.recording.EncryptionConfig
Gets the encryption mode.
getEncryptionString() - Method in class io.agora.recording.EncryptionConfig
Gets the encryption mode as a string.
getFileName() - Method in class io.agora.recording.RecorderInfo
Gets the absolute path of the recording file.
getFilePath() - Method in class io.agora.recording.LogConfig
Gets the log file path.
getFileSize() - Method in class io.agora.recording.RecorderInfo
Gets the size in bytes of the recording file.
getFileSizeInKB() - Method in class io.agora.recording.LogConfig
Gets the log file size in KB.
getFontFilePath() - Method in class io.agora.recording.WatermarkLitera
 
getFontFilePath() - Method in class io.agora.recording.WatermarkTimestamp
 
getFontSize() - Method in class io.agora.recording.WatermarkLitera
 
getFontSize() - Method in class io.agora.recording.WatermarkTimestamp
 
getFps() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the frame rate of the recorded video.
getHeight() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the height of the recorded video.
getHeight() - Method in class io.agora.recording.MixerLayoutConfig
Gets the height of the layout.
getHeight() - Method in class io.agora.recording.Rectangle
 
getHeight() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the height of the video frame.
getImagePath() - Method in class io.agora.recording.MixerLayoutConfig
Gets the file path of the background image for the layout.
getImageUrl() - Method in class io.agora.recording.WatermarkConfig
 
getIndex() - Method in class io.agora.recording.WatermarkConfig
 
getInt(String) - Method in class io.agora.recording.AgoraParameter
Retrieves an integer parameter value.
getIpList() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get local access point IP address list.
getIpListSize() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get the number of local access point IP address.
getJitterBufferDelay() - Method in class io.agora.recording.RemoteAudioStatistics
Gets the jitter buffer delay in milliseconds.
getLevel() - Method in class io.agora.recording.LogConfig
Gets the log level.
getLicense() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the license string.
getLiteraSource() - Method in class io.agora.recording.WatermarkConfig
 
getLogConfig() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets the log configuration.
getLogUploadServer() - Method in class io.agora.recording.AdvancedConfigInfo
 
getMaxDurationMs() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the maximum recording duration in milliseconds.
getMode() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get local proxy connection mode.
getMode() - Method in class io.agora.recording.WatermarkOptions
 
getNativeHandle() - Method in class io.agora.recording.AgoraService
Gets the native handle associated with this AgoraService instance.
getNetworkTransportDelay() - Method in class io.agora.recording.RemoteAudioStatistics
Gets the network transport delay in milliseconds.
getNumber(String) - Method in class io.agora.recording.AgoraParameter
Retrieves a floating-point number parameter value.
getObject(String) - Method in class io.agora.recording.AgoraParameter
Retrieves an object parameter value as a JSON string.
getOptions() - Method in class io.agora.recording.WatermarkConfig
 
getPositionInLandscapeMode() - Method in class io.agora.recording.WatermarkOptions
 
getPositionInPortraitMode() - Method in class io.agora.recording.WatermarkOptions
 
getQuality() - Method in class io.agora.recording.RemoteAudioStatistics
Gets the quality of the audio stream.
getReceivedBitrate() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the received bitrate in Kbps.
getRecorderInfoUpdateInterval() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the interval for updating the recording information in milliseconds.
getRotation() - Method in class io.agora.recording.MixerLayoutConfig
Gets the rotation of the layout.
getRxStreamType() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the type of the received video stream.
getSampleRate() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the audio sample rate.
getSdkVersion() - Static method in class io.agora.recording.AgoraService
Gets the SDK version.
getServerDomain() - Method in class io.agora.recording.LogUploadServerInfo
Get log upload server domain.
getServerPath() - Method in class io.agora.recording.LogUploadServerInfo
Get log upload server path.
getServerPort() - Method in class io.agora.recording.LogUploadServerInfo
Get log upload server port.
getStoragePath() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the storage path of the recording file.
getStreamType() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the stream type of the recording content.
getString(String) - Method in class io.agora.recording.AgoraParameter
Retrieves a string parameter value.
getTimestampSource() - Method in class io.agora.recording.WatermarkConfig
 
getType() - Method in class io.agora.recording.VideoSubscriptionOptions
Gets the type of the video stream to subscribe to.
getType() - Method in class io.agora.recording.WatermarkConfig
 
getUInt(String) - Method in class io.agora.recording.AgoraParameter
Retrieves an unsigned integer parameter value.
getUserId() - Method in class io.agora.recording.SpeakVolumeInfo
 
getUserId() - Method in class io.agora.recording.UserMixerLayout
Gets the ID of the user.
getUserLayoutConfigs() - Method in class io.agora.recording.VideoMixingLayout
Gets the layout configurations for the users.
getValue() - Method in enum io.agora.recording.Constants.AreaCode
 
getValue() - Method in enum io.agora.recording.Constants.AudioScenarioType
 
getValue() - Method in enum io.agora.recording.Constants.ChannelProfileType
 
getValue() - Method in enum io.agora.recording.Constants.ConnectionChangedReasonType
 
getValue() - Method in enum io.agora.recording.Constants.EncryptionErrorType
 
getValue() - Method in enum io.agora.recording.Constants.EncryptionMode
 
getValue() - Method in enum io.agora.recording.Constants.ErrorCodeType
 
getValue() - Method in enum io.agora.recording.Constants.LocalProxyMode
 
getValue() - Method in enum io.agora.recording.Constants.LogLevel
 
getValue() - Method in enum io.agora.recording.Constants.MediaRecorderContainerFormat
 
getValue() - Method in enum io.agora.recording.Constants.MediaRecorderStreamType
 
getValue() - Method in enum io.agora.recording.Constants.RecorderReasonCode
 
getValue() - Method in enum io.agora.recording.Constants.RecorderState
 
getValue() - Method in enum io.agora.recording.Constants.RemoteAudioState
 
getValue() - Method in enum io.agora.recording.Constants.RemoteAudioStateReason
 
getValue() - Method in enum io.agora.recording.Constants.RemoteVideoState
 
getValue() - Method in enum io.agora.recording.Constants.RemoteVideoStateReason
 
getValue() - Method in enum io.agora.recording.Constants.UserOfflineReasonType
 
getValue() - Method in enum io.agora.recording.Constants.VideoSourceType
 
getValue() - Method in enum io.agora.recording.Constants.VideoStreamType
 
getValue() - Method in enum io.agora.recording.Constants.WatermarkFitMode
 
getValue() - Method in enum io.agora.recording.Constants.WatermarkSourceType
 
getVerifyDomainName() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get certificate domain name installed on specific local access point.
getVideoSourceType() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the video source type.
getVolume() - Method in class io.agora.recording.SpeakVolumeInfo
 
getWatermarkRatio() - Method in class io.agora.recording.WatermarkOptions
 
getWidth() - Method in class io.agora.recording.MediaRecorderConfiguration
Gets the width of the recorded video.
getWidth() - Method in class io.agora.recording.MixerLayoutConfig
Gets the width of the layout.
getWidth() - Method in class io.agora.recording.Rectangle
 
getWidth() - Method in class io.agora.recording.RemoteVideoStatistics
Gets the width of the video frame.
getWidthRatio() - Method in class io.agora.recording.WatermarkRatio
 
getWmLitera() - Method in class io.agora.recording.WatermarkLitera
 
getX() - Method in class io.agora.recording.MixerLayoutConfig
Gets the x-coordinate of the top-left corner of the layout.
getX() - Method in class io.agora.recording.Rectangle
 
getXRatio() - Method in class io.agora.recording.WatermarkRatio
 
getY() - Method in class io.agora.recording.MixerLayoutConfig
Gets the y-coordinate of the top-left corner of the layout.
getY() - Method in class io.agora.recording.Rectangle
 
getYRatio() - Method in class io.agora.recording.WatermarkRatio
 
getZOrder() - Method in class io.agora.recording.MixerLayoutConfig
Gets the z-order of the layout.
getZOrder() - Method in class io.agora.recording.WatermarkOptions
 

H

height - Variable in class io.agora.recording.MediaRecorderConfiguration
The height of the recorded video in pixels.
height - Variable in class io.agora.recording.MixerLayoutConfig
The height of the layout.
height - Variable in class io.agora.recording.Rectangle
The height of the region.
height - Variable in class io.agora.recording.RemoteVideoStatistics
The height of the video frame.
hexStringToByteArray(String) - Static method in class io.agora.recording.utils.Utils
Converts a hexadecimal string to a byte array

I

IAgoraMediaRtcRecorderEventHandler - Interface in io.agora.recording
The IAgoraMediaRtcRecorderEventHandler interface, which contains callback events of the media recorder.
imagePath - Variable in class io.agora.recording.MixerLayoutConfig
The file path of the background image for the layout.
imageUrl - Variable in class io.agora.recording.WatermarkConfig
The URL of the image file for the watermark.
index - Variable in class io.agora.recording.WatermarkConfig
The watermark index.
initialize(AgoraService, boolean) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Initializes the recorder with specified service and mixing settings.
initialize(AgoraServiceConfiguration) - Method in class io.agora.recording.AgoraService
Initializes the AgoraService object with the specified configuration.
io.agora.recording - package io.agora.recording
 
io.agora.recording.utils - package io.agora.recording.utils
 
ipList - Variable in class io.agora.recording.LocalAccessPointConfiguration
Local access point IP address list.
ipListSize - Variable in class io.agora.recording.LocalAccessPointConfiguration
The number of local access point IP address.
isDisableAut() - Method in class io.agora.recording.LocalAccessPointConfiguration
Get whether to disable vos-aut.
isDomainLimit() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether domain limiting is enabled.
isEnableAudioDevice() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether the audio device is enabled.
isEnableAudioProcessor() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether the audio processor is enabled.
isEnableVideo() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether video is enabled.
isEncodedFrameOnly() - Method in class io.agora.recording.VideoSubscriptionOptions
Checks whether to subscribe to encoded video data only.
isLoaded - Static variable in class io.agora.recording.AgoraService
 
isMirror() - Method in class io.agora.recording.MixerLayoutConfig
Gets whether the layout is mirrored horizontally.
isNullOrEmpty(String) - Static method in class io.agora.recording.utils.Utils
Checks if a string is null or empty
isServerHttps() - Method in class io.agora.recording.LogUploadServerInfo
Get whether to use HTTPS request.
isUseExternalEglContext() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether external EGL context is used (Android only).
isUseStringUid() - Method in class io.agora.recording.AgoraServiceConfiguration
Gets whether string user IDs are enabled.
isVisibleInPreview() - Method in class io.agora.recording.WatermarkOptions
 

J

jitterBufferDelay - Variable in class io.agora.recording.RemoteAudioStatistics
The jitter buffer delay in milliseconds.
joinChannel(String, String, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Joins an Agora RTC channel.

L

leaveChannel() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Leaves the current channel.
level - Variable in class io.agora.recording.LogConfig
The log level.
license - Variable in class io.agora.recording.AgoraServiceConfiguration
The license used for verification when connecting channel.
literaSource - Variable in class io.agora.recording.WatermarkConfig
The watermark litera.
LocalAccessPointConfiguration - Class in io.agora.recording
The definition of the LocalAccessPointConfiguration class.
LocalAccessPointConfiguration() - Constructor for class io.agora.recording.LocalAccessPointConfiguration
Default constructor.
LocalAccessPointConfiguration(String[], int, String[], int, String, Constants.LocalProxyMode, AdvancedConfigInfo, boolean) - Constructor for class io.agora.recording.LocalAccessPointConfiguration
Parameterized constructor.
LocalProxyMode(int) - Constructor for enum io.agora.recording.Constants.LocalProxyMode
 
logConfig - Variable in class io.agora.recording.AgoraServiceConfiguration
The config for customer set log path, log size and log level.
LogConfig - Class in io.agora.recording
The LogConfig class provides the configuration for logging in the Agora recording SDK.
LogConfig() - Constructor for class io.agora.recording.LogConfig
Constructs a LogConfig object with default values.
LogConfig(String, int, Constants.LogLevel) - Constructor for class io.agora.recording.LogConfig
Constructs a LogConfig object with specified values.
LogLevel(int) - Constructor for enum io.agora.recording.Constants.LogLevel
 
logUploadServer - Variable in class io.agora.recording.AdvancedConfigInfo
Log upload server.
LogUploadServerInfo - Class in io.agora.recording
The definition of the LogUploadServerInfo class.
LogUploadServerInfo() - Constructor for class io.agora.recording.LogUploadServerInfo
Constructs a LogUploadServerInfo class with default values.
LogUploadServerInfo(String, String, int, boolean) - Constructor for class io.agora.recording.LogUploadServerInfo
Parameterized constructor.

M

MAX_LOG_SIZE - Static variable in class io.agora.recording.Constants
 
maxDurationMs - Variable in class io.agora.recording.MediaRecorderConfiguration
The maximum recording duration, in milliseconds.
MediaRecorderConfiguration - Class in io.agora.recording
The MediaRecorderConfiguration class provides the configuration for media recording in the Agora SDK.
MediaRecorderConfiguration() - Constructor for class io.agora.recording.MediaRecorderConfiguration
Constructs a MediaRecorderConfiguration object with default values.
MediaRecorderConfiguration(String, Constants.MediaRecorderContainerFormat, Constants.MediaRecorderStreamType, int, int, int, int, int, int, int, Constants.VideoSourceType) - Constructor for class io.agora.recording.MediaRecorderConfiguration
Constructs a MediaRecorderConfiguration object with specified values.
MediaRecorderContainerFormat(int) - Constructor for enum io.agora.recording.Constants.MediaRecorderContainerFormat
 
MediaRecorderStreamType(int) - Constructor for enum io.agora.recording.Constants.MediaRecorderStreamType
 
MIN_LOG_SIZE - Static variable in class io.agora.recording.Constants
 
mirror - Variable in class io.agora.recording.MixerLayoutConfig
Whether the layout is mirrored horizontally.
MixerLayoutConfig - Class in io.agora.recording
The MixerLayoutConfig class provides the configuration for the layout of a mixer in the Agora SDK.
MixerLayoutConfig() - Constructor for class io.agora.recording.MixerLayoutConfig
Constructs a MixerLayoutConfig object with default values.
MixerLayoutConfig(int, int, int, int, int) - Constructor for class io.agora.recording.MixerLayoutConfig
Constructs a MixerLayoutConfig object with specified position, size, and z-order.
MixerLayoutConfig(int, int, int, int, int, float, boolean, String) - Constructor for class io.agora.recording.MixerLayoutConfig
Constructs a MixerLayoutConfig object with specified values.
mode - Variable in class io.agora.recording.LocalAccessPointConfiguration
Local proxy connection mode, connectivity first or local only.
mode - Variable in class io.agora.recording.WatermarkOptions
The adaptation mode of the watermark.

N

nativeConvertPath(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeCreateAgoraMediaComponentFactory(long) - Method in class io.agora.recording.AgoraService
 
nativeCreateMediaRtcRecorder(long) - Method in class io.agora.recording.AgoraMediaComponentFactory
Native method to create a media RTC recorder.
nativeDisableVideoWatermarks(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeDisableVideoWatermarksByUid(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeEnableAndUpdateVideoWatermarks(long, WatermarkConfig[]) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeEnableAndUpdateVideoWatermarksByUid(long, WatermarkConfig[], String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeEnableEncryption(long, boolean, EncryptionConfig) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeGetAgoraParameter(long) - Method in class io.agora.recording.AgoraService
 
nativeGetArray(long, String, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetBool(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetInt(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetNumber(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetObject(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetSdkVersion() - Static method in class io.agora.recording.AgoraService
 
nativeGetString(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeGetUInt(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeHandle - Variable in class io.agora.recording.AgoraMediaComponentFactory
The native handle used for internal native operations.
nativeHandle - Variable in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeHandle - Variable in class io.agora.recording.AgoraParameter
 
nativeHandle - Variable in class io.agora.recording.AgoraService
 
nativeInit() - Method in class io.agora.recording.AgoraService
 
nativeInitialize(long, long, boolean) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeInitialize(long, AgoraServiceConfiguration) - Method in class io.agora.recording.AgoraService
 
nativeJoinChannel(long, String, String, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeLeaveChannel(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeRegisterRecorderEventHandler(long, IAgoraMediaRtcRecorderEventHandler) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeRelease(long) - Method in class io.agora.recording.AgoraMediaComponentFactory
Native method to release the native resources associated with the factory.
nativeRelease(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeRelease(long) - Method in class io.agora.recording.AgoraParameter
 
nativeRelease(long) - Method in class io.agora.recording.AgoraService
 
nativeRenewToken(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSetArray(long, String, String) - Method in class io.agora.recording.AgoraParameter
 
nativeSetAudioVolumeIndicationParameters(long, int) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSetBool(long, String, boolean) - Method in class io.agora.recording.AgoraParameter
 
nativeSetGlobalLocalAccessPoint(long, LocalAccessPointConfiguration) - Method in class io.agora.recording.AgoraService
 
nativeSetInt(long, String, int) - Method in class io.agora.recording.AgoraParameter
 
nativeSetLogFile(long, String, int) - Method in class io.agora.recording.AgoraService
 
nativeSetLogLevel(long, int) - Method in class io.agora.recording.AgoraService
 
nativeSetNumber(long, String, double) - Method in class io.agora.recording.AgoraParameter
 
nativeSetObject(long, String, String) - Method in class io.agora.recording.AgoraParameter
 
nativeSetParameters(long, String) - Method in class io.agora.recording.AgoraParameter
 
nativeSetRecorderConfig(long, MediaRecorderConfiguration) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSetRecorderConfigByUid(long, MediaRecorderConfiguration, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSetString(long, String, String) - Method in class io.agora.recording.AgoraParameter
 
nativeSetUInt(long, String, int) - Method in class io.agora.recording.AgoraParameter
 
nativeSetVideoMixingLayout(long, VideoMixingLayout) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeStartRecording(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeStartSingleRecordingByUid(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeStopRecording(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeStopSingleRecordingByUid(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSubscribeAllAudio(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSubscribeAllVideo(long, VideoSubscriptionOptions) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSubscribeAudio(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeSubscribeVideo(long, String, VideoSubscriptionOptions) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeUnregisterRecorderEventHandler(long, IAgoraMediaRtcRecorderEventHandler) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeUnsubscribeAllAudio(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeUnsubscribeAllVideo(long) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeUnsubscribeAudio(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
nativeUnsubscribeVideo(long, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
 
networkTransportDelay - Variable in class io.agora.recording.RemoteAudioStatistics
The network transport delay in milliseconds.

O

onActiveSpeaker(String, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when an active speaker is detected.
onAudioVolumeIndication(String, SpeakVolumeInfo[], int) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Reports which users are speaking, the speakers' volumes, and whether the local user is speaking.
onConnected(String, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the connection state between the SDK and the Agora channel changes to `CONNECTION_STATE_CONNECTED(3)`.
onConnectionLost(String, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the SDK loses connection with the Agora channel.
onDisconnected(String, String, Constants.ConnectionChangedReasonType) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the connection state between the SDK and the Agora channel changes to `CONNECTION_STATE_DISCONNECTED(1)`.
onEncryptionError(String, Constants.EncryptionErrorType) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the encryption error occurs.
onError(String, Constants.ErrorCodeType, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Reports the error code and error message.
onFirstRemoteAudioDecoded(String, String, int) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the SDK decodes the first remote audio frame for recorder.
onFirstRemoteVideoDecoded(String, String, int, int, int) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the SDK decodes the first remote video frame for recorder.
onReconnected(String, String, Constants.ConnectionChangedReasonType) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the connection state between the SDK and the Agora channel changes to `CONNECTION_STATE_CONNECTED(3) ` again.
onRecorderInfoUpdated(String, String, RecorderInfo) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the recording information is updated.
onRecorderStateChanged(String, String, Constants.RecorderState, Constants.RecorderReasonCode, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the recording state changes.
onRemoteAudioStats(String, String, RemoteAudioStatistics) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Reports the statistics of a remote audio.
onRemoteVideoStats(String, String, RemoteVideoStatistics) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Reports the statistics of a remote video.
onTokenPrivilegeDidExpire(String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the token has expired.
onTokenPrivilegeWillExpire(String, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the token privilege is about to expire in 30 seconds.
onUserAudioStateChanged(String, String, Constants.RemoteAudioState, Constants.RemoteAudioStateReason, int) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the state of audio changes.
onUserJoined(String, String) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when a remote user joins the channel.
onUserLeft(String, String, Constants.UserOfflineReasonType) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when a remote user leaves the channel.
onUserVideoStateChanged(String, String, Constants.RemoteVideoState, Constants.RemoteVideoStateReason, int) - Method in interface io.agora.recording.IAgoraMediaRtcRecorderEventHandler
Occurs when the state of video changes.
options - Variable in class io.agora.recording.WatermarkConfig
The options of the watermark.

P

positionInLandscapeMode - Variable in class io.agora.recording.WatermarkOptions
When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in landscape mode.
positionInPortraitMode - Variable in class io.agora.recording.WatermarkOptions
When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in portrait mode.

Q

quality - Variable in class io.agora.recording.RemoteAudioStatistics
The quality of the audio stream.

R

readFile(String) - Static method in class io.agora.recording.utils.Utils
Reads the content of a file into a string
receivedBitrate - Variable in class io.agora.recording.RemoteVideoStatistics
The received bitrate in Kbps.
RecorderInfo - Class in io.agora.recording
The RecorderInfo class provides information about a recording file in the Agora SDK.
RecorderInfo(String, int, int) - Constructor for class io.agora.recording.RecorderInfo
Constructs a RecorderInfo object with specified values.
recorderInfoUpdateInterval - Variable in class io.agora.recording.MediaRecorderConfiguration
The interval (in milliseconds) for updating the recording information.
RecorderReasonCode(int) - Constructor for enum io.agora.recording.Constants.RecorderReasonCode
 
RecorderState(int) - Constructor for enum io.agora.recording.Constants.RecorderState
 
Rectangle - Class in io.agora.recording
The definition of the Rectangle class.
Rectangle() - Constructor for class io.agora.recording.Rectangle
Constructs a Rectangle class with default values.
Rectangle(int, int, int, int) - Constructor for class io.agora.recording.Rectangle
 
registerRecorderEventHandler(IAgoraMediaRtcRecorderEventHandler) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Registers an event handler for recording events.
release() - Method in class io.agora.recording.AgoraMediaComponentFactory
Releases the native resources associated with the factory.
release() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Releases the native resources associated with the recorder.
release() - Method in class io.agora.recording.AgoraParameter
Releases all resources associated with this parameter instance.
release() - Method in class io.agora.recording.AgoraService
Releases the AgoraService object and its associated resources.
RemoteAudioState(int) - Constructor for enum io.agora.recording.Constants.RemoteAudioState
 
RemoteAudioStateReason(int) - Constructor for enum io.agora.recording.Constants.RemoteAudioStateReason
 
RemoteAudioStatistics - Class in io.agora.recording
The RemoteAudioStatistics class provides statistics for remote audio streams in the Agora SDK.
RemoteAudioStatistics(int, int, int, int) - Constructor for class io.agora.recording.RemoteAudioStatistics
Constructs a RemoteAudioStatistics object with specified values.
RemoteVideoState(int) - Constructor for enum io.agora.recording.Constants.RemoteVideoState
 
RemoteVideoStateReason(int) - Constructor for enum io.agora.recording.Constants.RemoteVideoStateReason
 
RemoteVideoStatistics - Class in io.agora.recording
The RemoteVideoStatistics class provides statistics for remote video streams in the Agora SDK.
RemoteVideoStatistics(int, int, int, int, int, Constants.VideoStreamType) - Constructor for class io.agora.recording.RemoteVideoStatistics
Constructs a RemoteVideoStatistics object with specified values.
renewToken(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Renews the token for the current session.
rotation - Variable in class io.agora.recording.MixerLayoutConfig
 
rxStreamType - Variable in class io.agora.recording.RemoteVideoStatistics
The type of the received video stream.

S

sampleRate - Variable in class io.agora.recording.MediaRecorderConfiguration
The sample rate of the recorded audio in Hz.
serverDomain - Variable in class io.agora.recording.LogUploadServerInfo
Log upload server domain
serverHttps - Variable in class io.agora.recording.LogUploadServerInfo
Whether to use HTTPS request: - true: Use HTTPS request - false: Use HTTP request
serverPath - Variable in class io.agora.recording.LogUploadServerInfo
Log upload server path
serverPort - Variable in class io.agora.recording.LogUploadServerInfo
Log upload server port
setAdvancedConfig(AdvancedConfigInfo) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set advanced config info.
setAlpha(float) - Method in class io.agora.recording.MixerLayoutConfig
Sets the transparency level of the layout.
setAppId(String) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the App ID.
setAreaCode(Constants.AreaCode) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the area code.
setArray(String, String) - Method in class io.agora.recording.AgoraParameter
Sets an array parameter value in JSON format.
setAudioLossRate(int) - Method in class io.agora.recording.RemoteAudioStatistics
Sets the audio loss rate in percentage.
setAudioScenario(Constants.AudioScenarioType) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the audio scenario.
setAudioVolumeIndicationParameters(int) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Sets the time interval of the onAudioVolumeIndication callback.
setBackgroundColor(long) - Method in class io.agora.recording.VideoMixingLayout
Sets the background color of the canvas.
setBackgroundImage(String) - Method in class io.agora.recording.VideoMixingLayout
Sets the background image of the canvas.
setBool(String, boolean) - Method in class io.agora.recording.AgoraParameter
Sets a boolean parameter value.
setCanvasFps(int) - Method in class io.agora.recording.VideoMixingLayout
Sets the frame rate of the canvas.
setCanvasHeight(int) - Method in class io.agora.recording.VideoMixingLayout
Sets the height of the canvas.
setCanvasWidth(int) - Method in class io.agora.recording.VideoMixingLayout
Sets the width of the canvas.
setChannelNum(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the number of audio channels.
setChannelProfile(Constants.ChannelProfileType) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the channel profile.
setConfig(MixerLayoutConfig) - Method in class io.agora.recording.UserMixerLayout
Sets the layout configuration for the user.
setContainerFormat(Constants.MediaRecorderContainerFormat) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the container format of the recording file.
setContext(Object) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the context object.
setDecoderOutputFrameRate(int) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the frame rate of the decoded video output.
setDelay(int) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the delay in milliseconds.
setDisableAut(boolean) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set whether to disable vos-aut.
setDomainLimit(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to enable domain limiting.
setDomainList(String[]) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set local access point domain list.
setDomainListSize(int) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set the number of local access point domain.
setDurationMs(int) - Method in class io.agora.recording.RecorderInfo
Sets the recording duration in milliseconds.
setEnableAudioDevice(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to enable the audio device.
setEnableAudioProcessor(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to enable the audio processor.
setEnableVideo(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to enable video.
setEncodedFrameOnly(boolean) - Method in class io.agora.recording.VideoSubscriptionOptions
Sets whether to subscribe to encoded video data only.
setEncryptionKdfSalt(byte[]) - Method in class io.agora.recording.EncryptionConfig
Sets the encryption salt.
setEncryptionKey(String) - Method in class io.agora.recording.EncryptionConfig
Sets the encryption key.
setEncryptionMode(Constants.EncryptionMode) - Method in class io.agora.recording.EncryptionConfig
Sets the encryption mode.
setFileName(String) - Method in class io.agora.recording.RecorderInfo
Sets the absolute path of the recording file.
setFilePath(String) - Method in class io.agora.recording.LogConfig
Sets the log file path.
setFileSize(int) - Method in class io.agora.recording.RecorderInfo
Sets the size in bytes of the recording file.
setFileSizeInKB(int) - Method in class io.agora.recording.LogConfig
Sets the log file size in KB.
setFontFilePath(String) - Method in class io.agora.recording.WatermarkLitera
 
setFontFilePath(String) - Method in class io.agora.recording.WatermarkTimestamp
 
setFontSize(int) - Method in class io.agora.recording.WatermarkLitera
 
setFontSize(int) - Method in class io.agora.recording.WatermarkTimestamp
 
setFps(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the frame rate of the recorded video.
setGlobalLocalAccessPoint(LocalAccessPointConfiguration) - Method in class io.agora.recording.AgoraService
Set Global local access point addresses in local Ap mode (which also calls local proxy).
setHeight(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the height of the recorded video.
setHeight(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the height of the layout.
setHeight(int) - Method in class io.agora.recording.Rectangle
 
setHeight(int) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the height of the video frame.
setImagePath(String) - Method in class io.agora.recording.MixerLayoutConfig
Sets the file path of the background image for the layout.
setImageUrl(String) - Method in class io.agora.recording.WatermarkConfig
 
setIndex(int) - Method in class io.agora.recording.WatermarkConfig
 
setInt(String, int) - Method in class io.agora.recording.AgoraParameter
Sets an integer parameter value.
setIpList(String[]) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set local access point IP address list.
setIpListSize(int) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set the number of local access point IP address.
setJitterBufferDelay(int) - Method in class io.agora.recording.RemoteAudioStatistics
Sets the jitter buffer delay in milliseconds.
setLevel(Constants.LogLevel) - Method in class io.agora.recording.LogConfig
Sets the log level.
setLicense(String) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the license string.
setLiteraSource(WatermarkLitera) - Method in class io.agora.recording.WatermarkConfig
 
setLogConfig(LogConfig) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets the log configuration.
setLogFile(String, int) - Method in class io.agora.recording.AgoraService
Sets the path and size of the SDK log files.
setLogLevel(Constants.LogLevel) - Method in class io.agora.recording.AgoraService
Sets the SDK log output level.
setLogUploadServer(LogUploadServerInfo) - Method in class io.agora.recording.AdvancedConfigInfo
 
setMaxDurationMs(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the maximum recording duration in milliseconds.
setMirror(boolean) - Method in class io.agora.recording.MixerLayoutConfig
Sets whether the layout is mirrored horizontally.
setMode(Constants.LocalProxyMode) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set local proxy connection mode.
setMode(Constants.WatermarkFitMode) - Method in class io.agora.recording.WatermarkOptions
 
setNetworkTransportDelay(int) - Method in class io.agora.recording.RemoteAudioStatistics
Sets the network transport delay in milliseconds.
setNumber(String, double) - Method in class io.agora.recording.AgoraParameter
Sets a floating-point number parameter value.
setObject(String, String) - Method in class io.agora.recording.AgoraParameter
Sets an object parameter value in JSON format.
setOptions(WatermarkOptions) - Method in class io.agora.recording.WatermarkConfig
 
setParameters(String) - Method in class io.agora.recording.AgoraParameter
Sets multiple parameters at once using a JSON string.
setPositionInLandscapeMode(Rectangle) - Method in class io.agora.recording.WatermarkOptions
 
setPositionInPortraitMode(Rectangle) - Method in class io.agora.recording.WatermarkOptions
 
setQuality(int) - Method in class io.agora.recording.RemoteAudioStatistics
Sets the quality of the audio stream.
setReceivedBitrate(int) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the received bitrate in Kbps.
setRecorderConfig(MediaRecorderConfiguration) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Configures the recorder settings.
setRecorderConfigByUid(MediaRecorderConfiguration, String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Configures the recorder settings for a specified user.
setRecorderInfoUpdateInterval(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the interval for updating the recording information in milliseconds.
setRotation(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the rotation of the layout.
setRxStreamType(Constants.VideoStreamType) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the type of the received video stream.
setSampleRate(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the audio sample rate.
setServerDomain(String) - Method in class io.agora.recording.LogUploadServerInfo
Set log upload server domain.
setServerHttps(boolean) - Method in class io.agora.recording.LogUploadServerInfo
Set whether to use HTTPS request.
setServerPath(String) - Method in class io.agora.recording.LogUploadServerInfo
Set log upload server path.
setServerPort(int) - Method in class io.agora.recording.LogUploadServerInfo
Set log upload server port.
setStoragePath(String) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the storage path of the recording file.
setStreamType(Constants.MediaRecorderStreamType) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the stream type of the recording content.
setString(String, String) - Method in class io.agora.recording.AgoraParameter
Sets a string parameter value.
setTimestampSource(WatermarkTimestamp) - Method in class io.agora.recording.WatermarkConfig
 
setType(Constants.VideoStreamType) - Method in class io.agora.recording.VideoSubscriptionOptions
Sets the type of the video stream to subscribe to.
setType(Constants.WatermarkSourceType) - Method in class io.agora.recording.WatermarkConfig
 
setUInt(String, int) - Method in class io.agora.recording.AgoraParameter
Sets an unsigned integer parameter value.
setUseExternalEglContext(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to use external EGL context (Android only).
setUserId(String) - Method in class io.agora.recording.SpeakVolumeInfo
 
setUserId(String) - Method in class io.agora.recording.UserMixerLayout
Sets the ID of the user.
setUserLayoutConfigs(UserMixerLayout[]) - Method in class io.agora.recording.VideoMixingLayout
Sets the layout configurations for the users.
setUseStringUid(boolean) - Method in class io.agora.recording.AgoraServiceConfiguration
Sets whether to use string user IDs.
setVerifyDomainName(String) - Method in class io.agora.recording.LocalAccessPointConfiguration
Set certificate domain name installed on specific local access point.
setVideoMixingLayout(VideoMixingLayout) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Sets the layout for mixed video streams.
setVideoSourceType(Constants.VideoSourceType) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the video source type.
setVisibleInPreview(boolean) - Method in class io.agora.recording.WatermarkOptions
 
setVolume(int) - Method in class io.agora.recording.SpeakVolumeInfo
 
setWatermarkRatio(WatermarkRatio) - Method in class io.agora.recording.WatermarkOptions
 
setWidth(int) - Method in class io.agora.recording.MediaRecorderConfiguration
Sets the width of the recorded video.
setWidth(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the width of the layout.
setWidth(int) - Method in class io.agora.recording.Rectangle
 
setWidth(int) - Method in class io.agora.recording.RemoteVideoStatistics
Sets the width of the video frame.
setWidthRatio(float) - Method in class io.agora.recording.WatermarkRatio
 
setWmLitera(String) - Method in class io.agora.recording.WatermarkLitera
 
setX(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the x-coordinate of the top-left corner of the layout.
setX(int) - Method in class io.agora.recording.Rectangle
 
setXRatio(float) - Method in class io.agora.recording.WatermarkRatio
 
setY(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the y-coordinate of the top-left corner of the layout.
setY(int) - Method in class io.agora.recording.Rectangle
 
setYRatio(float) - Method in class io.agora.recording.WatermarkRatio
 
setZOrder(int) - Method in class io.agora.recording.MixerLayoutConfig
Sets the z-order of the layout.
setZOrder(int) - Method in class io.agora.recording.WatermarkOptions
 
SpeakVolumeInfo - Class in io.agora.recording
The definition of the SpeakVolumeInfo class.
SpeakVolumeInfo(String, int) - Constructor for class io.agora.recording.SpeakVolumeInfo
 
startRecording() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Starts the recording process.
startSingleRecordingByUid(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Starts the recording process for a specified user.
stopRecording() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops the recording process.
stopSingleRecordingByUid(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops the recording process for a specified user.
storagePath - Variable in class io.agora.recording.MediaRecorderConfiguration
The absolute path (including the filename extensions) of the recording file.
streamType - Variable in class io.agora.recording.MediaRecorderConfiguration
The recording content.
subscribeAllAudio() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Subscribes to the audio streams of all remote users in the channel.
subscribeAllVideo(VideoSubscriptionOptions) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Subscribes to the video streams of all remote users in the channel.
subscribeAudio(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Subscribes to the audio stream of a specified remote user.
subscribeVideo(String, VideoSubscriptionOptions) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Subscribes to the video stream of a specified remote user.

T

timestampSource - Variable in class io.agora.recording.WatermarkConfig
The watermark timestamp.
toString() - Method in class io.agora.recording.AdvancedConfigInfo
 
toString() - Method in class io.agora.recording.AgoraServiceConfiguration
Returns a string representation of this configuration object.
toString() - Method in class io.agora.recording.EncryptionConfig
Returns a string representation of the EncryptionConfig object.
toString() - Method in class io.agora.recording.LocalAccessPointConfiguration
 
toString() - Method in class io.agora.recording.LogConfig
Returns a string representation of the LogConfig object.
toString() - Method in class io.agora.recording.LogUploadServerInfo
 
toString() - Method in class io.agora.recording.MediaRecorderConfiguration
Returns a string representation of the MediaRecorderConfiguration object.
toString() - Method in class io.agora.recording.MixerLayoutConfig
Returns a string representation of the MixerLayoutConfig object.
toString() - Method in class io.agora.recording.RecorderInfo
Returns a string representation of the RecorderInfo object.
toString() - Method in class io.agora.recording.Rectangle
 
toString() - Method in class io.agora.recording.RemoteAudioStatistics
Returns a string representation of the RemoteAudioStatistics object.
toString() - Method in class io.agora.recording.RemoteVideoStatistics
Returns a string representation of the RemoteVideoStatistics object.
toString() - Method in class io.agora.recording.SpeakVolumeInfo
 
toString() - Method in class io.agora.recording.UserMixerLayout
Returns a string representation of the UserMixerLayout object.
toString() - Method in class io.agora.recording.VideoMixingLayout
Returns a string representation of the VideoMixingLayout object.
toString() - Method in class io.agora.recording.VideoSubscriptionOptions
Returns a string representation of the VideoSubscriptionOptions object.
toString() - Method in class io.agora.recording.WatermarkConfig
 
toString() - Method in class io.agora.recording.WatermarkLitera
 
toString() - Method in class io.agora.recording.WatermarkOptions
 
toString() - Method in class io.agora.recording.WatermarkRatio
 
toString() - Method in class io.agora.recording.WatermarkTimestamp
 
type - Variable in class io.agora.recording.VideoSubscriptionOptions
The type of the video stream to subscribe to.
type - Variable in class io.agora.recording.WatermarkConfig
The watermark source type.

U

unregisterRecorderEventHandler(IAgoraMediaRtcRecorderEventHandler) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Unregisters a previously registered event handler.
unsubscribeAllAudio() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops subscribing to the audio streams of all remote users.
unsubscribeAllVideo() - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops subscribing to the video streams of all remote users.
unsubscribeAudio(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops subscribing to the audio stream of a specified remote user.
unsubscribeVideo(String) - Method in class io.agora.recording.AgoraMediaRtcRecorder
Stops subscribing to the video stream of a specified remote user.
useExternalEglContext - Variable in class io.agora.recording.AgoraServiceConfiguration
Whether use egl context in current thread as sdk's root egl context which shared by all egl related modules.
userId - Variable in class io.agora.recording.SpeakVolumeInfo
User ID of the speaker.
userId - Variable in class io.agora.recording.UserMixerLayout
The ID of the user.
userLayoutConfigs - Variable in class io.agora.recording.VideoMixingLayout
The layout configurations for the users.
UserMixerLayout - Class in io.agora.recording
The UserMixerLayout class represents the layout configuration for a user in a mixed stream.
UserMixerLayout() - Constructor for class io.agora.recording.UserMixerLayout
 
UserMixerLayout(String, MixerLayoutConfig) - Constructor for class io.agora.recording.UserMixerLayout
Constructs a UserMixerLayout object with specified user ID and layout configuration.
UserOfflineReasonType(int) - Constructor for enum io.agora.recording.Constants.UserOfflineReasonType
 
useStringUid - Variable in class io.agora.recording.AgoraServiceConfiguration
Whether to enable string uid.
Utils - Class in io.agora.recording.utils
 
Utils() - Constructor for class io.agora.recording.utils.Utils
 

V

value - Variable in enum io.agora.recording.Constants.AreaCode
 
value - Variable in enum io.agora.recording.Constants.AudioScenarioType
 
value - Variable in enum io.agora.recording.Constants.ChannelProfileType
 
value - Variable in enum io.agora.recording.Constants.ConnectionChangedReasonType
 
value - Variable in enum io.agora.recording.Constants.EncryptionErrorType
 
value - Variable in enum io.agora.recording.Constants.EncryptionMode
 
value - Variable in enum io.agora.recording.Constants.ErrorCodeType
 
value - Variable in enum io.agora.recording.Constants.LocalProxyMode
 
value - Variable in enum io.agora.recording.Constants.LogLevel
 
value - Variable in enum io.agora.recording.Constants.MediaRecorderContainerFormat
 
value - Variable in enum io.agora.recording.Constants.MediaRecorderStreamType
 
value - Variable in enum io.agora.recording.Constants.RecorderReasonCode
 
value - Variable in enum io.agora.recording.Constants.RecorderState
 
value - Variable in enum io.agora.recording.Constants.RemoteAudioState
 
value - Variable in enum io.agora.recording.Constants.RemoteAudioStateReason
 
value - Variable in enum io.agora.recording.Constants.RemoteVideoState
 
value - Variable in enum io.agora.recording.Constants.RemoteVideoStateReason
 
value - Variable in enum io.agora.recording.Constants.UserOfflineReasonType
 
value - Variable in enum io.agora.recording.Constants.VideoSourceType
 
value - Variable in enum io.agora.recording.Constants.VideoStreamType
 
value - Variable in enum io.agora.recording.Constants.WatermarkFitMode
 
value - Variable in enum io.agora.recording.Constants.WatermarkSourceType
 
valueOf(String) - Static method in enum io.agora.recording.Constants.AreaCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.AudioScenarioType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.ChannelProfileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.ConnectionChangedReasonType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.EncryptionErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.EncryptionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.ErrorCodeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.LocalProxyMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.MediaRecorderContainerFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.MediaRecorderStreamType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RecorderReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RecorderState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RemoteAudioState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RemoteAudioStateReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RemoteVideoState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.RemoteVideoStateReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.UserOfflineReasonType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.VideoSourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.VideoStreamType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.WatermarkFitMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.recording.Constants.WatermarkSourceType
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.agora.recording.Constants.AreaCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.AudioScenarioType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.ChannelProfileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.ConnectionChangedReasonType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.EncryptionErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.EncryptionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.ErrorCodeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.LocalProxyMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.MediaRecorderContainerFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.MediaRecorderStreamType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RecorderReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RecorderState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RemoteAudioState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RemoteAudioStateReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RemoteVideoState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.RemoteVideoStateReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.UserOfflineReasonType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.VideoSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.VideoStreamType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.WatermarkFitMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.recording.Constants.WatermarkSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
verifyDomainName - Variable in class io.agora.recording.LocalAccessPointConfiguration
Certificate domain name installed on specific local access point.
VideoMixingLayout - Class in io.agora.recording
The VideoMixingLayout class represents the layout configuration for video mixing in the Agora SDK.
VideoMixingLayout() - Constructor for class io.agora.recording.VideoMixingLayout
Constructs the VideoMixingLayout class with default values.
VideoMixingLayout(int, int, int, long, String, UserMixerLayout[]) - Constructor for class io.agora.recording.VideoMixingLayout
Constructs a VideoMixingLayout object with specified values.
VideoSourceType(int) - Constructor for enum io.agora.recording.Constants.VideoSourceType
 
videoSourceType - Variable in class io.agora.recording.MediaRecorderConfiguration
The video source type for out channel recorder.
VideoStreamType(int) - Constructor for enum io.agora.recording.Constants.VideoStreamType
 
VideoSubscriptionOptions - Class in io.agora.recording
The VideoSubscriptionOptions class represents the options for subscribing to a video stream in the Agora SDK.
VideoSubscriptionOptions() - Constructor for class io.agora.recording.VideoSubscriptionOptions
Constructs a VideoSubscriptionOptions object with default values.
VideoSubscriptionOptions(Constants.VideoStreamType) - Constructor for class io.agora.recording.VideoSubscriptionOptions
Constructs a VideoSubscriptionOptions object with the specified video stream type.
VideoSubscriptionOptions(Constants.VideoStreamType, boolean) - Constructor for class io.agora.recording.VideoSubscriptionOptions
Constructs a VideoSubscriptionOptions object with the specified video stream type and encoded frame option.
visibleInPreview - Variable in class io.agora.recording.WatermarkOptions
Whether or not the watermark image is visible in the local video preview.
volume - Variable in class io.agora.recording.SpeakVolumeInfo
The volume of the speaker that ranges from 0 to 255.

W

WatermarkConfig - Class in io.agora.recording
The definition of the WatermarkConfig class.
WatermarkConfig() - Constructor for class io.agora.recording.WatermarkConfig
Default constructor initializing default values.
WatermarkFitMode(int) - Constructor for enum io.agora.recording.Constants.WatermarkFitMode
 
WatermarkLitera - Class in io.agora.recording
The definition of the WatermarkLitera class.
WatermarkLitera() - Constructor for class io.agora.recording.WatermarkLitera
Constructs the WatermarkLitera class with default values.
WatermarkOptions - Class in io.agora.recording
The definition of the WatermarkOptions class.
WatermarkOptions() - Constructor for class io.agora.recording.WatermarkOptions
 
watermarkRatio - Variable in class io.agora.recording.WatermarkOptions
When the watermark adaptation mode is FIT_MODE_USE_IMAGE_RATIO, this parameter is used to set the watermark coordinates.
WatermarkRatio - Class in io.agora.recording
The definition of the WatermarkRatio class.
WatermarkRatio() - Constructor for class io.agora.recording.WatermarkRatio
 
WatermarkRatio(float, float, float) - Constructor for class io.agora.recording.WatermarkRatio
 
WatermarkSourceType(int) - Constructor for enum io.agora.recording.Constants.WatermarkSourceType
 
WatermarkTimestamp - Class in io.agora.recording
The definition of the WatermarkTimestamp class.
WatermarkTimestamp() - Constructor for class io.agora.recording.WatermarkTimestamp
Constructs the WatermarkTimestamp class with default values.
width - Variable in class io.agora.recording.MediaRecorderConfiguration
The width of the recorded video in pixels.
width - Variable in class io.agora.recording.MixerLayoutConfig
The width of the layout.
width - Variable in class io.agora.recording.Rectangle
The width of the region.
width - Variable in class io.agora.recording.RemoteVideoStatistics
The width of the video frame.
widthRatio - Variable in class io.agora.recording.WatermarkRatio
The width of the watermark.
wmLitera - Variable in class io.agora.recording.WatermarkLitera
The litera content of the watermark.

X

x - Variable in class io.agora.recording.MixerLayoutConfig
The x-coordinate of the top-left corner of the layout.
x - Variable in class io.agora.recording.Rectangle
The horizontal offset from the top-left corner.
xRatio - Variable in class io.agora.recording.WatermarkRatio
The x-coordinate of the upper left corner of the watermark.

Y

y - Variable in class io.agora.recording.MixerLayoutConfig
The y-coordinate of the top-left corner of the layout.
y - Variable in class io.agora.recording.Rectangle
The vertical offset from the top-left corner.
yRatio - Variable in class io.agora.recording.WatermarkRatio
The y-coordinate of the upper left corner of the watermark.

Z

zOrder - Variable in class io.agora.recording.MixerLayoutConfig
The z-order of the layout.
zOrder - Variable in class io.agora.recording.WatermarkOptions
The z-order of the watermark image.
A B C D E F G H I J L M N O P Q R S T U V W X Y Z 
Skip navigation links