Agora Java API Reference for Android

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2 3 4 5 6]

▼N io |
▼N agora |
►N base |
C AudioFrame | Raw audio data
►N mediaplayer |
►N data |
C CacheStatistics | Statistics about the media files being cached
C MediaPlayerSource | Information related to the media file to be played and the playback scenario configurations
C MediaStreamInfo | The detailed information of the media stream
C PlayerPlaybackStats | The information of the media file being played
C PlayerUpdatedInfo | Information related to the media player
C SrcInfo | Information about the video bitrate of the media resource being played
►N gl |
C PlayerTextureHelper |
C AssetsFileReader |
►C Constants |
C AudioDualMonoMode | The channel mode
C MediaPlayerEvent | Media player events
C MediaPlayerMetadataType | The type of media metadata
C MediaPlayerPreloadEvent | Events that occur when media resources are preloaded
C MediaPlayerReason | Reasons for the changes in the media player status
C MediaPlayerState | The playback state
C MediaStreamType | The type of the media stream
C ContentFileReader |
C IMediaPlayer |
C IMediaPlayerAudioFrameObserver |
C IMediaPlayerCacheManager |
C IMediaPlayerCustomDataProvider |
C IMediaPlayerObserver |
C IMediaPlayerVideoFrameObserver |
C IPlayerTextureHelper |
►N meta |
C AvatarModelInfo |
C EnterSceneConfig |
C ILocalUserAvatar |
C IMetaScene |
C IMetaSceneEventHandler |
C IMetaService |
►C IMetaServiceEventHandler |
C ConnectionChangedReason |
C ConnectionState |
C SceneDownloadState |
►C MetaBundleInfo |
C BundleType |
C MetaSceneAssetsInfo |
►C MetaSceneConfig |
C StateSyncMode |
C MetaServiceConfig |
C MetaUserInfo |
C MetaUserPositionInfo |
C SceneDisplayConfig |
►N musiccontentcenter |
C ClimaxSegment | The climax parts of the music
C IAgoraMusicContentCenter |
►C IAgoraMusicPlayer |
C MusicPlayMode | Playback modes for music resources
C IMusicContentCenterEventHandler |
C Music | Detailed information of the music resource
C MusicCacheInfo | Information about cached music resources
C MusicChartInfo | Detailed information about the music chart
C MusicContentCenterConfiguration | Settings for the music content center
C MvProperty |
►N rtc2 |
►N audio |
►C AdvancedAudioOptions | The advanced options for audio
C AudioProcessingChannelsEnum | The number of channels for audio preprocessing
C AgoraRhythmPlayerConfig | The metronome configuration
C AudioParams | Audio data format
C AudioSpectrumInfo | The audio spectrum data
C AudioTrackConfig | The configuration of custom audio tracks
C IAudioSpectrumObserver |
C UserAudioSpectrumInfo | Audio spectrum information of the remote user
►N live |
►C LiveInjectStreamConfig |
C AudioSampleRateType | The audio sampling rate of the stream to be pushed to the CDN
►C LiveTranscoding | Transcoding configurations for Media Push
C AudioCodecProfileType | Self-defined audio codec profile
C AudioSampleRateType |
C TranscodingUser | Transcoding configurations of each host
C VideoCodecProfileType | Video codec profile types
C VideoCodecType | The codec type of the output video
►N proxy |
►C LocalAccessPointConfiguration | Local Access Point configuration
C AdvancedConfigInfo | Advanced options for the Local Access Point
C LogUploadServerInfo | Configuration information of the log server
►N video |
C AgoraFocalLengthInfo | Focal length information supported by the camera, including the camera direction and focal length type
C AgoraImage | Image properties
C AgoraMetadata | Media metadata
C AgoraVideoFrame | The external video frame
C BeautyOptions | Image enhancement options
►C CameraCapturerConfiguration | The camera capturer preference
C CAMERA_DIRECTION | The camera direction
C CAMERA_FOCAL_LENGTH_TYPE | The camera focal length types
C CaptureFormat | The format of the video frame
C ChannelMediaInfo | Channel media information
C ChannelMediaRelayConfiguration | Configuration of cross channel media relay
C CodecCapInfo | The codec capability of the SDK
C CodecCapLevels | The level of the codec capability
C ColorEnhanceOptions | The color enhancement options
►C ContentInspectConfig | Screenshot and upload configuration
C ContentInspectModule | `ContentInspectModule` class, a structure used to configure the frequency of video screenshot and upload
C EncodedVideoFrameInfo | Information about externally encoded video frames
C FaceShapeAreaOptions | Filter effect options
C FaceShapeBeautyOptions | The facial enhancement style options
C FilterEffectOptions | Filter effect options
C IFaceInfoObserver |
C ImageTrackOptions | Image configurations
C IVideoEncodedFrameObserver |
C IVideoFrameObserver |
C LowLightEnhanceOptions | The low-light enhancement options
C MakeUpOptions | MakeUp options. This structure defines options for makeup
C SegmentationProperty | Processing properties for background images
C SnapshotConfig | The snapshot configuration
C VideoCanvas | Attributes of the video canvas object
►C VideoCompositingLayout |
C Builder |
C Canvas |
C Region |
C VideoDenoiserOptions | Video noise reduction options
►C VideoEncoderConfiguration | Video encoder configurations
C AdvanceOptions | Advanced options for video encoding
C CODEC_CAP_MASK |
C COMPRESSION_PREFERENCE | Compression preference for video encoding
C DEGRADATION_PREFERENCE | Video degradation preferences when the bandwidth is a constraint
C ENCODING_PREFERENCE | Video encoder preference
C FRAME_RATE | The video frame rate
C MIRROR_MODE_TYPE |
C ORIENTATION_MODE | Video output orientation mode
C VIDEO_CODEC_TYPE | Video codec types
C VideoDimensions | The video dimension
►C VideoSubscriptionOptions | Video subscription options
C REMOTE_VIDEO_STREAM_TYPE |
C VirtualBackgroundSource | The custom background
C WatermarkBuffer | Configures the format, size, and pixel buffer of the watermark image
C WatermarkConfig | Used to configure watermark-related information
►C WatermarkOptions | Watermark image configurations
C Rectangle | The location of the target area relative to the screen or window. If you do not set this
►C AgoraMediaRecorder |
C MediaRecorderConfiguration | Audio and video stream recording configuration
C ChannelMediaOptions | The channel media options
C ClientRoleOptions | Setting of user role properties
►C Constants |
C AUDIO_EQUALIZATION_BAND_FREQUENCY | The midrange frequency for audio equalization
C AUDIO_REVERB_TYPE | Audio reverberation types
C AudioMixingDualMonoMode | The channel mode
C AudioProfile | The audio profile
C AudioScenario |
C AudioSourceType | The audio source type
C AudioTrackType | The type of the audio track
C BytesPerSample |
C ExternalVideoSourceType | The external video frame encoding type
C LogLevel | The output log level of the SDK
C MEDIA_TRACE_EVENT | The rendering state of the media frame
C MediaSourceType | Media source type
C MediaType |
C MultipathMode | The transmission mode of data over multiple network paths
C MultipathType | Network path types used in multipath transmission
C QoEPreference |
C RenewTokenErrorCode | Represents the error codes after calling `renewToken`
C ScreenScenarioType | The screen sharing scenario
C SimulcastStreamMode | The mode in which the video stream is sent
C StreamFallbackOptions | Options for handling audio and video stream fallback when network conditions are weak
C ThreadPriorityType |
C VIDEO_MODULE_TYPE |
C VideoModulePosition | The frame position of the video observer
C VideoScenario | The video application scenarios
C VideoSourceType | The type of the video source
C VideoStreamType | The type of video streams
C VOICE_AI_TUNER_TYPE | Voice AI tuner sound types
C DataStreamConfig | The configurations for the data stream
C DeviceInfo | The audio device information
C DirectCdnStreamingMediaOptions | The media setting options for the host
C DirectCdnStreamingReason | Reasons for the changes in CDN streaming status
C DirectCdnStreamingState | The current CDN streaming state
C DirectCdnStreamingStats | The statistics of the current CDN streaming
C EchoTestConfiguration | The configuration of the audio and video call loop test
C EncodedVideoTrackOptions |
C ExtensionContext | The context information of the extension
C ExtensionInfo |
C IAudioEncodedFrameObserver |
C IAudioFrameObserver |
C IDirectCdnStreamingEventHandler |
C IH265Transcoder |
►C IH265TranscoderObserver |
C H265TranscodeResult |
C IMediaExtensionObserver |
C IMediaRecorderCallback |
C IMetadataObserver |
►C IRtcEngineEventHandler |
C AgoraFacePositionInfo | The information of the detected human face
C AudioVolumeInfo | The volume information of users
C ClientRole |
C DownlinkNetworkInfo |
C ErrorCode |
►C LastmileProbeResult | Results of the uplink and downlink last-mile network tests
C LastmileProbeOneWayResult | Results of the uplink or downlink last-mile network test
C LocalAudioStats | Local audio statistics
C LocalVideoStats | The statistics of the local video stream
C MultipathStats | Aggregates statistics of each network path in multipath transmission
C PathStats | Statistical information about a specific network path
C Quality |
C RemoteAudioStats | Audio statistics of the remote user
C RemoteVideoStats | Statistics of the remote video stream
C RtcStats | Statistics of a call session
C UplinkNetworkInfo | The uplink network information
C UserOfflineReason |
C VideoLayout | Layout information of a specific sub-video stream within the mixed stream
C VideoLayoutInfo | Detailed layout information of a mixed video stream
C VideoProfile |
C VideoRenderingTracingInfo | Indicators during video frame rendering progress
C WarnCode |
C IRtcEngineReleaseCallback | The class used for asynchronously destroying the engine
►C IVideoEffectObject | Provides methods to manage and configure video effects, such as beauty, style makeup, and filter
C VIDEO_EFFECT_ACTION | Actions that can be performed on video effect nodes
C VIDEO_EFFECT_NODE_ID | Types of applicable video effect nodes
C LeaveChannelOptions | The options for leaving a channel
►C LocalAudioMixerConfiguration | The configurations for mixing the local audio
C MixedAudioStream | The source of the audio streams that are mixed locally
►C LocalTranscoderConfiguration | The configuration of the video mixing on the local client
C TranscodingVideoStream | The video streams for local video mixing
►C PublisherConfiguration |
C Builder |
C PublisherParameters |
C RecorderInfo | Recording file information
C RecorderStreamInfo | Information about the audio and video streams to be recorded
►C RtcConnection | Contains connection information
C CONNECTION_STATE_TYPE |
C RtcEngine |
►C RtcEngineConfig | Configurations for the `RtcEngineConfig` instance
C AreaCode | The region for connection, which is the region where the server the SDK connects to is located
C LogConfig | Configuration of Agora SDK log files
C RtcEngineEx |
C RtcEngineInternal |
►C ScreenCaptureParameters | Screen sharing configurations
C AudioCaptureParameters | The audio configuration for the shared screen stream
C VideoCaptureParameters | The video configuration for the shared screen stream
►C SimulcastConfig | Configure video streams of different quality levels
C StreamLayerConfig | Configures the parameters of a specific layer in multi-quality video streams
C StreamLayerIndex | Index of video streams of different quality levels
C SimulcastStreamConfig | The configuration of the low-quality video stream
C SpatialAudioParams | The spatial audio parameters
C UserInfo | The information of the user
►N rte |
►N callback |
C AsyncCallback | Callback for asynchronous operation result
C PlayerGetStatsCallback |
►N exception |
C AuthenticationFailedException |
C NetworkErrorException |
C RteException | Rte exception information
C StreamNotFoundException |
C Canvas |
C CanvasConfig | This class provides methods for configuring video rendering of the player
C CanvasInitialConfig |
C Config | RTE configuration class, used to configure the `RTE` object
►C Constants |
C AbrFallbackLayer | The quality level for video stream fallback
C AbrSubscriptionLayer | The quality layer of the subscribed video stream
C ErrorCode | RTE-related status codes and error codes
C PlayerEvent | Media player event types
C PlayerMetadataType |
C PlayerState | The state of the media player
C VideoMirrorMode | Video mirror mode
C VideoRenderMode | Video rendering mode
C Error | This class provides methods to retrieve error codes and error messages
C InitialConfig |
C NativeLibsLoader |
C Observer |
C Player |
C PlayerConfig | This class provides methods related to Media player options
C PlayerCustomSourceProvider |
C PlayerInfo | Information about the player and media stream
C PlayerInitialConfig |
C PlayerObserver |
C PlayerStats | Statistics of the media resource being played
C Rect |
C Rte |
C Stream |
C VideoMirrorMode |
C VideoRenderMode |
C ViewConfig |
►N rtm |
C ChannelInfo |
C ErrorInfo |
C GetHistoryMessagesOptions |
C GetMessagesResult |
C GetOnlineUsersOptions |
C GetOnlineUsersResult |
C HistoryMessage |
C IntervalInfo |
C JoinChannelOptions |
C JoinTopicOptions |
C LinkStateEvent |
C LockDetail |
C LockEvent |
C MessageEvent |
C Metadata |
C MetadataItem |
C MetadataOptions |
C PresenceEvent |
C PresenceOptions |
C PublisherInfo |
C PublishOptions |
C ResultCallback |
C RtmClient |
►C RtmConfig |
C Builder |
►C RtmConstants |
C RtmAreaCode |
C RtmChannelType |
C RtmConnectionChangeReason |
C RtmConnectionState |
C RtmEncryptionMode |
C RtmErrorCode |
C RtmLinkOperation |
C RtmLinkState |
C RtmLinkStateChangeReason |
C RtmLockEventType |
C RtmLogLevel |
C RtmMessagePriority |
C RtmMessageQos |
C RtmMessageType |
C RtmPresenceEventType |
C RtmProtocolType |
C RtmProxyType |
C RtmServiceType |
C RtmStorageEventType |
C RtmStorageType |
C RtmTopicEventType |
C RtmEncryptionConfig |
C RtmEventListener |
C RtmHistory |
C RtmLock |
C RtmLogConfig |
C RtmMessage |
C RtmPresence |
C RtmPrivateConfig |
C RtmProxyConfig |
C RtmStorage |
C SnapshotInfo |
C StorageEvent |
C StreamChannel |
C SubscribeOptions |
C SubscribeTopicResult |
C TopicEvent |
C TopicInfo |
C TopicMessageOptions |
C TopicOptions |
C UserState |
C WhoNowResult |
►N spatialaudio |
C IBaseSpatialAudioEngine |
C ILocalSpatialAudioEngine |
C LocalSpatialAudioConfig | The configuration of `ILocalSpatialAudioEngine`
C RemoteVoicePositionInfo | The spatial position of the remote user or the media player
C SpatialAudioZone | Sound insulation area settings