rtc_engine library

Classes

AgoraImage
Agora image properties. A class for setting the properties of the watermark and background images.
AudioVolumeInfo
Properties of the audio volume information. Contains the user ID and volume information for each speaker.
BeautyOptions
Sets the image enhancement options.
CameraCapturerConfiguration
The definition of CameraCapturerConfiguration.
ChannelMediaInfo
The ChannelMediaInfo class.
ChannelMediaOptions
The channel media options.
ChannelMediaRelayConfiguration
The ChannelMediaRelayConfiguration class.
Color
The background color in RGB hex. Value only. Do not include a preceding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).
EncryptionConfig
Definition of EncryptionConfig. [...]
FacePositionInfo
The information of the detected human face.
LastmileProbeConfig
Lastmile probe configuration.
LastmileProbeOneWayResult
The one-way last-mile probe result.
LastmileProbeResult
Statistics of the lastmile probe.
LiveInjectStreamConfig
Configuration of the imported live broadcast voice or video stream.
LiveTranscoding
A class for managing user-specific CDN live audio/video transcoding settings.
LocalAudioStats
Statistics of the local audio stream.
LocalVideoStats
Statistics of the local video.
Rect
Integer coordinates for a rectangle.
Rectangle
The position and size of the watermark image.
RemoteAudioStats
Statistics of the remote audio.
RemoteVideoStats
Statistics of the remote video.
RtcEngine
RtcEngine is the main class of the Agora SDK.
RtcEngineEventHandler
The SDK uses the RtcEngineEventHandler class to send callbacks to the application, and the application inherits the methods of this class to retrieve these callbacks. [...]
RtcStats
Statistics of RTCEngine.
TranscodingUser
The transcodingUser class, which defines the audio and video properties in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN live streaming channel.
UserInfo
The UserInfo class.
VideoDimensions
The video resolution.
VideoEncoderConfiguration
Definition of VideoEncoderConfiguration.
WatermarkOptions
Agora watermark options. A class for setting the properties of watermark.

Enums

AreaCode
The area of connection.
AudioChannel
The audio channel of the sound.
AudioCodecProfileType
Self-defined audio codec profile.
AudioEqualizationBandFrequency
Audio equalization band frequency.
AudioLocalError
The error information of the local audio.
AudioLocalState
The state of the local audio.
AudioMixingErrorCode
The error code of the audio mixing file.
AudioMixingStateCode
The state of the audio mixing file.
AudioOutputRouting
Audio output routing.
AudioProfile
Audio profile.
AudioRecordingQuality
Audio recording quality.
AudioRemoteState
The state of the remote audio.
AudioRemoteStateReason
The reason of the remote audio state change.
AudioReverbPreset
The preset local voice reverberation option.
AudioReverbType
Audio reverberation type.
AudioSampleRateType
Audio sample rate.
AudioScenario
Audio scenario.
AudioSessionOperationRestriction
Audio session restriction.
AudioVoiceChanger
The preset audio voice configuration used to change the voice effect.
BitRate
Sets the video bitrate (Kbps). Refer to the table below and set your bitrate. Video Bitrate Table [...]
CameraCaptureOutputPreference
The camera capturer configuration.
CameraDirection
The camera direction.
ChannelMediaRelayError
The error code in of channel media relay.
ChannelMediaRelayEvent
The event code in of channel media relay event.
ChannelMediaRelayState
The state code in channel media relay state.
ChannelProfile
Channel profile.
ClientRole
Client role in a live broadcast.
ConnectionChangedReason
Reasons for the connection state change.
ConnectionStateType
Connection states.
DegradationPreference
The video encoding degradation preference under limited bandwidth.
EncryptionMode
Encryption mode
ErrorCode
Error codes occur when the SDK encounters an error that cannot be recovered automatically without any app intervention.
InjectStreamStatus
State of importing an external video stream in a live broadcast.
LastmileProbeResultState
The state of the probe test result.
LighteningContrastLevel
The lightening contrast level.
LocalVideoStreamError
The detailed error information of the local video.
LocalVideoStreamState
The state of the local video stream.
LogFilter
Output log filter level.
NetworkQuality
Network quality.
NetworkType
Network type.
RtmpStreamingErrorCode
The detailed error information for streaming.
RtmpStreamingEvent
Events during the RTMP streaming.
RtmpStreamingState
The RTMP streaming state.
StreamFallbackOptions
Stream fallback option.
StreamPublishState
The publishing state. [...]
StreamSubscribeState
The subscribing state. [...]
UserOfflineReason
Reason for the user being offline.
UserPriority
The priority of the remote user.
VideoCodecProfileType
Self-defined video codec profile.
VideoCodecType
Video codec types.
VideoFrameRate
Video frame rate.
VideoMirrorMode
Video mirror mode.
VideoOutputOrientationMode
Video output orientation mode.
VideoQualityAdaptIndication
Quality change of the local video in terms of target frame rate and target bit rate since last count.
VideoRemoteState
The state of the remote video.
VideoRemoteStateReason
The reason of the remote video state change.
VideoRenderMode
Video display mode.
VideoStreamType
Video stream type.
WarningCode
Warning codes occur when the SDK encounters an error that may be recovered automatically. These are only notifications, and can generally be ignored. For example, when the SDK loses connection to the server, the SDK reports the OpenChannelTimeout(106) warning and tries to reconnect automatically. See WarningCode.OpenChannelTimeout.