Functions | |
delegate void | OnJoinChannelSuccessHandler (string channelName, uint uid, int elapsed) |
delegate void | OnLeaveChannelHandler (RtcStats stats) |
delegate void | OnReJoinChannelSuccessHandler (string channelName, uint uid, int elapsed) |
delegate void | OnConnectionLostHandler () |
delegate void | OnConnectionInterruptedHandler () |
delegate void | OnRequestTokenHandler () |
delegate void | OnUserJoinedHandler (uint uid, int elapsed) |
delegate void | OnUserOfflineHandler (uint uid, USER_OFFLINE_REASON reason) |
delegate void | OnVolumeIndicationHandler (AudioVolumeInfo[] speakers, int speakerNumber, int totalVolume) |
delegate void | OnLocalVoicePitchInHzHandler (int pitchInHz) |
delegate void | OnUserMutedAudioHandler (uint uid, bool muted) |
delegate void | OnSDKWarningHandler (int warn, string msg) |
delegate void | OnSDKErrorHandler (int error, string msg) |
delegate void | OnRtcStatsHandler (RtcStats stats) |
delegate void | OnAudioMixingFinishedHandler () |
delegate void | OnAudioRouteChangedHandler (AUDIO_ROUTE route) |
delegate void | OnFirstRemoteVideoDecodedHandler (uint uid, int width, int height, int elapsed) |
delegate void | OnVideoSizeChangedHandler (uint uid, int width, int height, int rotation) |
delegate void | OnClientRoleChangedHandler (CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
delegate void | OnUserMuteVideoHandler (uint uid, bool muted) |
delegate void | OnMicrophoneEnabledHandler (bool isEnabled) |
delegate void | OnApiExecutedHandler (int err, string api, string result) |
delegate void | OnLastmileQualityHandler (int quality) |
delegate void | OnFirstLocalAudioFrameHandler (int elapsed) |
delegate void | OnFirstRemoteAudioFrameHandler (uint userId, int elapsed) |
delegate void | OnAudioQualityHandler (uint userId, int quality, ushort delay, ushort lost) |
delegate void | OnStreamInjectedStatusHandler (string url, uint userId, int status) |
delegate void | OnStreamUnpublishedHandler (string url) |
delegate void | OnStreamPublishedHandler (string url, int error) |
delegate void | OnStreamMessageErrorHandler (uint userId, int streamId, int code, int missed, int cached) |
delegate void | OnStreamMessageHandler (uint userId, int streamId, byte[] data, int length) |
delegate void | OnConnectionBannedHandler () |
delegate void | OnConnectionStateChangedHandler (CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
delegate void | OnTokenPrivilegeWillExpireHandler (string token) |
delegate void | OnActiveSpeakerHandler (uint uid) |
delegate void | OnVideoStoppedHandler () |
delegate void | OnFirstLocalVideoFrameHandler (int width, int height, int elapsed) |
delegate void | OnFirstRemoteVideoFrameHandler (uint uid, int width, int height, int elapsed) |
delegate void | OnUserEnableVideoHandler (uint uid, bool enabled) |
delegate void | OnUserEnableLocalVideoHandler (uint uid, bool enabled) |
delegate void | OnRemoteVideoStateChangedHandler (uint uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
delegate void | OnLocalPublishFallbackToAudioOnlyHandler (bool isFallbackOrRecover) |
delegate void | OnRemoteSubscribeFallbackToAudioOnlyHandler (uint uid, bool isFallbackOrRecover) |
delegate void | OnNetworkQualityHandler (uint uid, int txQuality, int rxQuality) |
delegate void | OnLocalVideoStatsHandler (LocalVideoStats localVideoStats) |
delegate void | OnRemoteVideoStatsHandler (RemoteVideoStats remoteVideoStats) |
delegate void | OnRemoteAudioStatsHandler (RemoteAudioStats remoteAudioStats) |
delegate void | OnAudioDeviceStateChangedHandler (string deviceId, int deviceType, int deviceState) |
delegate void | OnCameraReadyHandler () |
delegate void | OnCameraFocusAreaChangedHandler (int x, int y, int width, int height) |
delegate void | OnCameraExposureAreaChangedHandler (int x, int y, int width, int height) |
delegate void | OnRemoteAudioMixingBeginHandler () |
delegate void | OnRemoteAudioMixingEndHandler () |
delegate void | OnAudioEffectFinishedHandler (int soundId) |
delegate void | OnVideoDeviceStateChangedHandler (string deviceId, int deviceType, int deviceState) |
delegate void | OnRemoteVideoTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate) |
delegate void | OnRemoteAudioTransportStatsHandler (uint uid, ushort delay, ushort lost, ushort rxKBitRate) |
delegate void | OnTranscodingUpdatedHandler () |
delegate void | OnAudioDeviceVolumeChangedHandler (MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) |
delegate void | OnMediaEngineStartCallSuccessHandler () |
delegate void | OnMediaEngineLoadSuccessHandler () |
delegate void | OnAudioMixingStateChangedHandler (AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) |
delegate void | OnFirstRemoteAudioDecodedHandler (uint uid, int elapsed) |
delegate void | OnLocalVideoStateChangedHandler (LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error) |
delegate void | OnRtmpStreamingStateChangedHandler (string url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) |
delegate void | OnNetworkTypeChangedHandler (NETWORK_TYPE type) |
delegate void | OnLastmileProbeResultHandler (LastmileProbeResult result) |
delegate void | OnLocalUserRegisteredHandler (uint uid, string userAccount) |
delegate void | OnUserInfoUpdatedHandler (uint uid, UserInfo userInfo) |
delegate void | OnLocalAudioStateChangedHandler (LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) |
delegate void | OnRemoteAudioStateChangedHandler (uint uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
delegate void | OnLocalAudioStatsHandler (LocalAudioStats localAudioStats) |
delegate void | OnChannelMediaRelayStateChangedHandler (CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code) |
delegate void | OnChannelMediaRelayEventHandler (CHANNEL_MEDIA_RELAY_EVENT events) |
delegate void | OnFacePositionChangedHandler (int imageWidth, int imageHeight, Rectangle vecRectangle, int vecDistance, int numFaces) |
delegate void | OnRtmpStreamingEventHandler (string url, RTMP_STREAMING_EVENT eventCode) |
delegate void | OnAudioPublishStateChangedHandler (string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
delegate void | OnVideoPublishStateChangedHandler (string channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
delegate void | OnAudioSubscribeStateChangedHandler (string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
delegate void | OnVideoSubscribeStateChangedHandler (string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
delegate void | OnFirstLocalAudioFramePublishedHandler (int elapsed) |
delegate void | OnFirstLocalVideoFramePublishedHandler (int elapsed) |
delegate void | OnUserSuperResolutionEnabledHandler (uint uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) |
delegate void | OnVirtualBackgroundSourceEnabledHandler (bool enabled, VIRTUAL_BACKGROUND_SOURCE_STATE_REASON reason) |
delegate void | OnRequestAudioFileInfoHandler (AudioFileInfo info, AUDIO_FILE_INFO_ERROR error) |
delegate void | OnSnapshotTakenHandler (string channel, uint uid, string filePath, int width, int height, int errCode) |
delegate void | OnClientRoleChangeFailedHandler (CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) |
delegate void | OnAudioDeviceTestVolumeIndicationHandler (AudioDeviceTestVolumeType volumeType, int volume) |
delegate void | OnProxyConnectedHandler (string channel, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed) |
delegate void | OnScreenCaptureInfoUpdatedHandler (ScreenCaptureInfo info) |
delegate void | ChannelOnWarningHandler (string channelId, int warn, string message) |
delegate void | ChannelOnErrorHandler (string channelId, int err, string message) |
delegate void | ChannelOnJoinChannelSuccessHandler (string channelId, uint uid, int elapsed) |
delegate void | ChannelOnReJoinChannelSuccessHandler (string channelId, uint uid, int elapsed) |
delegate void | ChannelOnLeaveChannelHandler (string channelId, RtcStats rtcStats) |
delegate void | ChannelOnClientRoleChangedHandler (string channelId, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
delegate void | ChannelOnUserJoinedHandler (string channelId, uint uid, int elapsed) |
delegate void | ChannelOnUserOffLineHandler (string channelId, uint uid, USER_OFFLINE_REASON reason) |
delegate void | ChannelOnConnectionLostHandler (string channelId) |
delegate void | ChannelOnRequestTokenHandler (string channelId) |
delegate void | ChannelOnTokenPrivilegeWillExpireHandler (string channelId, string token) |
delegate void | ChannelOnRtcStatsHandler (string channelId, RtcStats rtcStats) |
delegate void | ChannelOnNetworkQualityHandler (string channelId, uint uid, int txQuality, int rxQuality) |
delegate void | ChannelOnRemoteVideoStatsHandler (string channelId, RemoteVideoStats remoteVideoStats) |
delegate void | ChannelOnRemoteAudioStatsHandler (string channelId, RemoteAudioStats remoteAudioStats) |
delegate void | ChannelOnRemoteAudioStateChangedHandler (string channelId, uint uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
delegate void | ChannelOnActiveSpeakerHandler (string channelId, uint uid) |
delegate void | ChannelOnVideoSizeChangedHandler (string channelId, uint uid, int width, int height, int rotation) |
delegate void | ChannelOnRemoteVideoStateChangedHandler (string channelId, uint uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
delegate void | ChannelOnStreamMessageHandler (string channelId, uint uid, int streamId, string data, int length) |
delegate void | ChannelOnStreamMessageErrorHandler (string channelId, uint uid, int streamId, int code, int missed, int cached) |
delegate void | ChannelOnMediaRelayStateChangedHandler (string channelId, CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code) |
delegate void | ChannelOnMediaRelayEventHandler (string channelId, CHANNEL_MEDIA_RELAY_EVENT events) |
delegate void | ChannelOnRtmpStreamingStateChangedHandler (string channelId, string url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) |
delegate void | ChannelOnTranscodingUpdatedHandler (string channelId) |
delegate void | ChannelOnStreamInjectedStatusHandler (string channelId, string url, uint uid, int status) |
delegate void | ChannelOnRemoteSubscribeFallbackToAudioOnlyHandler (string channelId, uint uid, bool isFallbackOrRecover) |
delegate void | ChannelOnConnectionStateChangedHandler (string channelId, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
delegate void | ChannelOnLocalPublishFallbackToAudioOnlyHandler (string channelId, bool isFallbackOrRecover) |
delegate void | ChannelOnRtmpStreamingEventHandler (string channelId, string url, RTMP_STREAMING_EVENT eventCode) |
delegate void | ChannelOnAudioPublishStateChangedHandler (string channelId, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
delegate void | ChannelOnVideoPublishStateChangedHandler (string channelId, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
delegate void | ChannelOnAudioSubscribeStateChangedHandler (string channelId, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
delegate void | ChannelOnVideoSubscribeStateChangedHandler (string channelId, uint uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
delegate void | ChannelOnUserSuperResolutionEnabledHandler (string channelId, uint uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) |
delegate void | ChannelOnClientRoleChangeFailedHandler (string channelId, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) |
delegate void | ChannelOnFirstRemoteVideoFrameHandler (string channelId, uint uid, int width, int height, int elapsed) |
delegate void | ChannelOnChannelProxyConnectedHandler (string channelId, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed) |
|
strong |
|
strong |
|
strong |
|
strong |
Audio codec profile types. The default value is LC_ACC.
|
strong |
The options for SDK preset audio effects.
Enumerator | |
---|---|
AUDIO_EFFECT_OFF | Turn off audio effects and use the original voice. |
ROOM_ACOUSTICS_KTV | An audio effect typical of a KTV venue.
|
ROOM_ACOUSTICS_VOCAL_CONCERT | An audio effect typical of a concert hall.
|
ROOM_ACOUSTICS_STUDIO | An audio effect typical of a recording studio.
|
ROOM_ACOUSTICS_PHONOGRAPH | An audio effect typical of a vintage phonograph.
|
ROOM_ACOUSTICS_VIRTUAL_STEREO | A virtual stereo effect that renders monophonic audio as stereo audio.
|
ROOM_ACOUSTICS_SPACIAL | A more spatial audio effect.
|
ROOM_ACOUSTICS_ETHEREAL | A more ethereal audio effect.
|
ROOM_ACOUSTICS_3D_VOICE | A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D voice effect is 10 seconds. To change the cycle period, call SetAudioEffectParameters after this method.
|
VOICE_CHANGER_EFFECT_UNCLE | The voice of an uncle.
|
VOICE_CHANGER_EFFECT_OLDMAN | The voice of an old man.
|
VOICE_CHANGER_EFFECT_BOY | The voice of a boy.
|
VOICE_CHANGER_EFFECT_SISTER | The voice of a young woman.
|
VOICE_CHANGER_EFFECT_GIRL | The voice of a girl.
|
VOICE_CHANGER_EFFECT_PIGKING | The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
|
VOICE_CHANGER_EFFECT_HULK | The voice of Hulk.
|
STYLE_TRANSFORMATION_RNB | An audio effect typical of R&B music.
|
STYLE_TRANSFORMATION_POPULAR | An audio effect typical of popular music.
|
PITCH_CORRECTION | A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. To change the basic mode and tonic pitch, call SetAudioEffectParameters after this method.
|
Audio equalization band frequencies.
|
strong |
The information acquisition state. This enum is reported in OnRequestAudioFileInfoHandler.
Enumerator | |
---|---|
AUDIO_FILE_INFO_ERROR_OK | 0: Successfully get the information of an audio file. |
AUDIO_FILE_INFO_ERROR_FAILURE | 1: Fail to get the information of an audio file. |
|
strong |
|
strong |
The channel mode. Set in SetAudioMixingDualMonoMode.
|
strong |
The error codes of the local user's audio mixing file.
|
strong |
The reason of audio mixing state change.
|
strong |
The states of the local user's audio mixing file.
Enumerator | |
---|---|
AUDIO_MIXING_STATE_PLAYING | 710: The audio mixing file is playing. This state indicates that the SDK is in the following stages:
|
AUDIO_MIXING_STATE_PAUSED | 711: The audio mixing file pauses playing. This state indicates that the SDK calls PauseAudioMixing successfully. |
AUDIO_MIXING_STATE_STOPPED | 713: The audio mixing file stops playing. This state indicates that the SDK calls StopAudioMixing successfully. |
AUDIO_MIXING_STATE_FAILED | 714: An exception occurs during the playback of the audio mixing file. See error types in the |
|
strong |
Audio profiles.
Sets the sample rate, bitrate, encoding mode, and the number of channels.
|
strong |
The reording content, set in StartAudioRecording.
|
strong |
The audio recording quality, which is set in StartAudioRecording.
|
strong |
Local voice reverberation presets.
|
strong |
Audio reverberation types.
|
strong |
Audio output routing.
|
strong |
|
strong |
Audio application scenarios.
Audio session restriction.
|
strong |
|
strong |
|
strong |
The degree of blurring applied to the custom background image.
|
strong |
|
strong |
|
strong |
The brightness level of the video image captured by the local camera.
|
strong |
Camera capturer configuration.
Enumerator | |
---|---|
CAPTURER_OUTPUT_PREFERENCE_AUTO | 0: (Default) self-adapts the camera output parameters to the system performance and network conditions to balance CPU consumption and video preview quality. |
CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE | 1: Prioritizes the system performance. The SDK chooses the dimension and frame rate of the local camera capture closest to those set by SetVideoEncoderConfiguration. |
CAPTURER_OUTPUT_PREFERENCE_PREVIEW | 2: Prioritizes the local preview quality. The SDK chooses higher camera output parameters to improve the local video preview quality. This option requires extra CPU and RAM usage for video pre-processing. |
CAPTURER_OUTPUT_PREFERENCE_MANUAL | 3: Allows you to customize the width and height of the video image captured by the local camera. @since v3.3.1 |
|
strong |
The definition of CHANNEL_MEDIA_RELAY_ERROR.
Enumerator | |
---|---|
RELAY_OK | 0: The state is normal. |
RELAY_ERROR_SERVER_ERROR_RESPONSE | 1: An error occurs in the server response. |
RELAY_ERROR_SERVER_NO_RESPONSE | 2: No server response. You can call the LeaveChannel method to leave the channel. This error can also occur if your project has not enabled co-host token authentication. Contact suppo to enable the co-host token authentication service before starting a channel media relay. rt@a gora. io |
RELAY_ERROR_NO_RESOURCE_AVAILABLE | 3: The SDK fails to access the service, probably due to limited resources of the server. |
RELAY_ERROR_FAILED_JOIN_SRC | 4: Fails to send the relay request. |
RELAY_ERROR_FAILED_JOIN_DEST | 5: Fails to accept the relay request. |
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC | 6: The server fails to receive the media stream. |
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST | 7: The server fails to send the media stream. |
RELAY_ERROR_SERVER_CONNECTION_LOST | 8: The SDK disconnects from the server due to poor network connections. You can call the LeaveChannel method to leave the channel. |
RELAY_ERROR_INTERNAL_ERROR | 9: An internal error occurs in the server. |
RELAY_ERROR_SRC_TOKEN_EXPIRED | 10: The token of the source channel has expired. |
RELAY_ERROR_DEST_TOKEN_EXPIRED | 11: The token of the destination channel has expired. |
|
strong |
The event code in CHANNEL_MEDIA_RELAY_EVENT.
|
strong |
The state code in CHANNEL_MEDIA_RELAY_STATE.
Enumerator | |
---|---|
RELAY_STATE_IDLE | 0: The initial state. After you successfully stop the channel media relay by calling StopChannelMediaRelay, the OnChannelMediaRelayStateChangedHandler callback returns this state. |
RELAY_STATE_CONNECTING | 1: The SDK tries to relay the media stream to the destination channel. |
RELAY_STATE_RUNNING | 2: The SDK successfully relays the media stream to the destination channel. |
RELAY_STATE_FAILURE | 3: A failure occurs. See the details in code. |
|
strong |
The channel profile.
Reasons for a user role switch failure, reported in OnClientRoleChangeFailedHandler.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Reasons for a connection state change.
Enumerator | |
---|---|
CONNECTION_CHANGED_CONNECTING | 0: The SDK is connecting to Agora's edge server. |
CONNECTION_CHANGED_JOIN_SUCCESS | 1: The SDK has joined the channel successfully. |
CONNECTION_CHANGED_INTERRUPTED | 2: The connection between the SDK and Agora's edge server is interrupted. |
CONNECTION_CHANGED_BANNED_BY_SERVER | 3: The user is banned by the server. This error occurs when the user is kicked out the channel from the server. |
CONNECTION_CHANGED_JOIN_FAILED | 4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel. |
CONNECTION_CHANGED_LEAVE_CHANNEL | 5: The SDK has left the channel. |
CONNECTION_CHANGED_INVALID_APP_ID | 6: The connection failed since Appid is not valid. |
CONNECTION_CHANGED_INVALID_CHANNEL_NAME | 7: The connection failed since channel name is not valid. |
CONNECTION_CHANGED_INVALID_TOKEN | 8: The connection failed since token is not valid, possibly because:
|
CONNECTION_CHANGED_TOKEN_EXPIRED | 9: The connection failed since token is expired. |
CONNECTION_CHANGED_REJECTED_BY_SERVER | 10: The connection is rejected by server. This error usually occurs in the following situations:
|
CONNECTION_CHANGED_SETTING_PROXY_SERVER | 11: The connection changed to reconnecting since SDK has set a proxy server. |
CONNECTION_CHANGED_RENEW_TOKEN | 12: When SDK is in connection failed, the renew token operation will make it connecting. |
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED | 13: The IP Address of SDK client has changed. i.e., Network type or IP/Port changed by network operator might change client IP address. |
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT | 14: Timeout for the keep-alive of the connection between the SDK and Agora's edge server. The connection state changes to |
CONNECTION_CHANGED_SAME_UID_LOGIN | 19: Join the same channel from different devices using the same user ID. |
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS | 20: The number of hosts in the channel is already at the upper limit.
|
|
strong |
Connection states.
Enumerator | |
---|---|
CONNECTION_STATE_DISCONNECTED | 1: The SDK is disconnected from Agora's edge server.
|
CONNECTION_STATE_CONNECTING | 2: The SDK is connecting to Agora's edge server.
|
CONNECTION_STATE_CONNECTED | 3: The SDK is connected to Agora's edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, if the network is down or switched, the SDK automatically tries to reconnect and triggers:
|
CONNECTION_STATE_RECONNECTING | 4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
|
CONNECTION_STATE_FAILED | 5: The SDK fails to connect to Agora's edge server or join the channel. You must call the LeaveChannel method to leave this state, and call the JoinChannelByKey method again to rejoin the channel. If the SDK is banned from joining the channel by Agora's edge server (through the RESTful API), the SDK triggers the OnConnectionBannedHandler (deprecated) and OnConnectionStateChangedHandler callbacks. |
|
strong |
Video degradation preferences when the bandwidth is a constraint.
|
strong |
Encryption mode.
|
strong |
Error code, see more in Error Code.
|
strong |
|
strong |
The reason for poor QoE of the local user when receiving a remote audio stream.
|
strong |
|
strong |
|
strong |
States of importing an external video stream in the interactive live streaming.
|
strong |
States of the last-mile network probe test.
|
strong |
Local audio state error codes.
|
strong |
Local audio state types.
|
strong |
Local video state error codes
Enumerator | |
---|---|
LOCAL_VIDEO_STREAM_ERROR_OK | 0: The local video is normal. |
LOCAL_VIDEO_STREAM_ERROR_FAILURE | 1: No specified reason for the local video failure. |
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION | 2: No permission to use the local video capturing device. |
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY | 3: The local video capturing device is in use. |
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE | 4: The local video capture fails. Check whether the capturing device is working properly. |
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE | 5: The local video encoding fails. |
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND | 6: (iOS only) The application is in the background. @since v3.3.0 |
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS | 7: (iOS only) The application is running in Slide Over, Split View, or Picture in Picture mode. @since v3.3.0 |
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND | 8:capture not found |
LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED | 9: (macOS only) The external camera currently in use is disconnected (such as being unplugged).
|
LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID | 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
|
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED | 11: The shared window is minimized when you call StartScreenCaptureByWindowId to share a window. |
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED | 12: The error code indicates that a window shared by the window ID has been closed, or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios for reporting this error code:
|
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED | 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
|
LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED | 20: (Windows only) The SDK does not support sharing this type of window.
|
|
strong |
Local video state types.
Enumerator | |
---|---|
LOCAL_VIDEO_STREAM_STATE_STOPPED | 0: Initial state. |
LOCAL_VIDEO_STREAM_STATE_CAPTURING | 1: The local video capturing device starts successfully. The SDK also reports this state when you share a maximized window by calling StartScreenCaptureByWindowId. |
LOCAL_VIDEO_STREAM_STATE_ENCODING | 2: The first video frame is successfully encoded. |
LOCAL_VIDEO_STREAM_STATE_FAILED | 3: The local video fails to start. |
|
strong |
Output log filter level.
|
strong |
The output log level of the SDK.
|
strong |
The low-light enhancement level.
|
strong |
The low-light enhancement mode.
|
strong |
Media device states.
|
strong |
Media device types.
|
strong |
Enumerator | |
---|---|
AUDIO_PLAYOUT_SOURCE | 0: Audio playback device. |
AUDIO_RECORDING_SOURCE | 1: Microphone. |
|
strong |
|
strong |
|
strong |
Metadata type of the observer.
Enumerator | |
---|---|
UNKNOWN_METADATA | -1: The metadata type is unknown. |
VIDEO_METADATA | 0: The metadata type is video. |
|
strong |
Network type.
|
strong |
Video output orientation modes.
|
strong |
|
strong |
The proxy type.
|
strong |
Quality change of the local video in terms of target frame rate and target bit rate since last count.
|
strong |
Network quality types.
|
strong |
Use modes of the OnRecordAudioFrameHandler and OnPlaybackAudioFrameHandler callbacks.
Enumerator | |
---|---|
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY | 0: Read-only mode: Users only read the AudioFrame data without modifying anything. For example, when users acquire the data with the Agora RTC SDK, then push the RTMP or RTMPS streams. |
RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY | 1: Write-only mode: Users replace the AudioFrame data with their own data and pass the data to the SDK for encoding. For example, when users acquire the data. |
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE | 2: Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own sound-effect processing module and perform some voice pre-processing, such as a voice change. |
|
strong |
The reason for the state change.
|
strong |
The current recording state.
Enumerator | |
---|---|
RECORDER_STATE_ERROR | An error occurs during the recording. See RecorderErrorCode for the reason. |
RECORDER_STATE_START | The audio and video recording is started. |
RECORDER_STATE_STOP | The audio and video recording is stopped. |
|
strong |
Remote audio states.
|
strong |
Remote audio state reasons.
|
strong |
The state of the remote video.
|
strong |
The reason of the remote video state change.
|
strong |
|
strong |
Video display modes.
Enumerator | |
---|---|
RENDER_MODE_HIDDEN | 1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. |
RENDER_MODE_FIT | 2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to disparity in the aspect ratio are filled with black. |
RENDER_MODE_ADAPTIVE |
|
|
strong |
Error codes of the RTMP or RTMPS streaming.
Enumerator | |
---|---|
RTMP_STREAM_PUBLISH_ERROR_OK | The RTMP or RTMPS streaming publishes successfully. |
RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT | Invalid argument used. If, for example, you do not call the |
RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED | The RTMP or RTMPS streaming is encrypted and cannot be published. |
RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT | Timeout for the RTMP or RTMPS streaming. Call the |
RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR | An error occurs in Agora's streaming server. Call the |
RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR | An error occurs in the CDN server. |
RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN | The RTMP or RTMPS streaming publishes too frequently. |
RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT | The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. |
RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED | The host manipulates other hosts' URLs. Check your app logic. |
RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND | Agora's server fails to find the RTMP or RTMPS streaming. |
RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED | The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct. |
RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER | 11: The user role is not host, so the user cannot use the CDN live streaming function. Check your application code logic.
|
RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM | 13: UpdateRtmpTranscoding or SetLiveTranscoding method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
|
RTMP_STREAM_PUBLISH_ERROR_NET_DOWN | 14: Errors occurred in the host's network.
|
RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID | 15: Your App ID does not have permission to use the CDN live streaming function. Refer to Prerequisites to enable the CDN live streaming permission.
|
RTMP_STREAM_UNPUBLISH_ERROR_OK | 100: The streaming has been stopped normally. After you call RemovePublishStreamUrl to stop streaming, the SDK returns this value.
|
|
strong |
States of the RTMP or RTMPS streaming.
Enumerator | |
---|---|
RTMP_STREAM_PUBLISH_STATE_IDLE | 0: The RTMP or RTMPS streaming has not started or has ended. |
RTMP_STREAM_PUBLISH_STATE_CONNECTING | 1: The SDK is connecting to Agora's streaming server and the RTMP server. This state is triggered after you call the AddPublishStreamUrl method. |
RTMP_STREAM_PUBLISH_STATE_RUNNING | 2: The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state. |
RTMP_STREAM_PUBLISH_STATE_RECOVERING | 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.
|
RTMP_STREAM_PUBLISH_STATE_FAILURE | 4: The RTMP or RTMPS streaming fails. See the errCode parameter for the detailed error information. You can also call the AddPublishStreamUrl method to publish the RTMP or RTMPS streaming again. |
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING | 5: The SDK is disconnecting from the Agora streaming server and CDN. When you call
|
|
strong |
Events during the RTMP or RTMPS streaming.
|
strong |
The screen sharing scenario, set in SetScreenCaptureScenario.
|
strong |
The type of the shared target.
|
strong |
Stream fallback options.
Enumerator | |
---|---|
STREAM_FALLBACK_OPTION_DISABLED | 0: No fallback behavior for the local/remote video stream when the uplink/downlink network conditions are poor. The quality of the stream is not guaranteed. |
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW | 1: Under poor downlink network conditions, the remote video stream, to which you subscribe, falls back to the low-stream (low resolution and low bitrate) video. You can set this option only in the SetRemoteSubscribeFallbackOption method. Nothing happens when you set this in the SetLocalPublishFallbackOption method. |
STREAM_FALLBACK_OPTION_AUDIO_ONLY | 2: Under poor uplink network conditions, the locally published video stream falls back to audio only. Under poor downlink network conditions, the remote video stream, to which you subscribe, first falls back to the low-stream (low resolution and low bitrate) video; and then to an audio-only stream if the network conditions worsen. |
|
strong |
The publishing state.
Enumerator | |
---|---|
PUB_STATE_IDLE | 0: The initial publishing state after joining the channel. |
PUB_STATE_NO_PUBLISHED | 1: Fails to publish the local stream. Possible reasons:
|
PUB_STATE_PUBLISHING | 2: Publishing. |
PUB_STATE_PUBLISHED | 3: Publishes successfully. |
|
strong |
The subscribing state.
Enumerator | |
---|---|
SUB_STATE_IDLE | 0: The initial subscribing state after joining the channel. |
SUB_STATE_NO_SUBSCRIBED | 1: Fails to subscribe to the remote stream. Possible reasons:
|
SUB_STATE_SUBSCRIBING | 2: Subscribing. |
SUB_STATE_SUBSCRIBED | 3: Subscribes to and receives the remote stream successfully. |
|
strong |
The reason why super resolution is not successfully enabled or the message that confirms success.
|
strong |
Reasons for a user being offline.
|
strong |
Video codec profile types.
|
strong |
|
strong |
The video noise reduction level.
|
strong |
The video noise reduction mode.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Content hints for screen sharing.
The reason why the virtual background is not successfully enabled or the message that confirms success.
Enumerator | |
---|---|
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_SUCCESS | 0: The virtual background is successfully enabled. |
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_IMAGE_NOT_EXIST | 1: The custom background image does not exist. Please check the value of |
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_COLOR_FORMAT_NOT_SUPPORTED | 2: The color format of the custom background image is invalid. Please check the value of |
VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_DEVICE_NOT_SUPPORTED | 3: The device does not support using the virtual background. |
|
strong |
The options for SDK preset voice beautifier effects.
Enumerator | |
---|---|
VOICE_BEAUTIFIER_OFF | Turn off voice beautifier effects and use the original voice. |
CHAT_BEAUTIFIER_MAGNETIC | A more magnetic voice.
|
CHAT_BEAUTIFIER_FRESH | A fresher voice.
|
CHAT_BEAUTIFIER_VITALITY | A more vital voice.
|
SINGING_BEAUTIFIER |
Singing beautifier effect.
|
TIMBRE_TRANSFORMATION_VIGOROUS | A more vigorous voice. |
TIMBRE_TRANSFORMATION_DEEP | A deeper voice. |
TIMBRE_TRANSFORMATION_MELLOW | A mellower voice. |
TIMBRE_TRANSFORMATION_FALSETTO | A falsetto voice. |
TIMBRE_TRANSFORMATION_FULL | A fuller voice. |
TIMBRE_TRANSFORMATION_CLEAR | A clearer voice. |
TIMBRE_TRANSFORMATION_RESOUNDING | A more resounding voice. |
TIMBRE_TRANSFORMATION_RINGING | A more ringing voice. |
|
strong |
Local voice beautifier options.
|
strong |
The options for SDK preset voice conversion effects.
|
strong |
|
strong |
Suggest an action for the user.
delegate void agora_gaming_rtc.ChannelOnActiveSpeakerHandler | ( | string | channelId, |
uint | uid | ||
) |
Reports which user is the loudest speaker.
If the user enables the audio volume indication by calling the EnableAudioVolumeIndication method, this callback returns the uid
of the active speaker detected by the audio volume detection module of the SDK.
EnableAudioVolumeIndication
method.channelId | The name of the channel that you join. |
uid | The user ID of the active speaker. A uid of 0 represents the local user. |
delegate void agora_gaming_rtc.ChannelOnAudioPublishStateChangedHandler | ( | string | channelId, |
STREAM_PUBLISH_STATE | oldState, | ||
STREAM_PUBLISH_STATE | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the audio publishing state changes.
This callback indicates the publishing state change of the local audio stream.
channelId | The name of the channel that you join. |
oldState | The previous publishing state. For details, see STREAM_PUBLISH_STATE. |
newState | The current publishing state. For details, see STREAM_PUBLISH_STATE. |
elapseSinceLastState | The time elapsed (ms) from the previous state to the current state. |
delegate void agora_gaming_rtc.ChannelOnAudioSubscribeStateChangedHandler | ( | string | channelId, |
uint | uid, | ||
STREAM_SUBSCRIBE_STATE | oldState, | ||
STREAM_SUBSCRIBE_STATE | newState, | ||
int | elapseSinceLastState | ||
) |
Occurs when the audio subscribing state changes.
This callback indicates the subscribing state change of a remote audio stream.
channelId | The name of the channel that you join. |
uid | The ID of the remote user. |
oldState | The previous subscribing state. For details, see STREAM_SUBSCRIBE_STATE. |
newState | The current subscribing state. For details, see STREAM_SUBSCRIBE_STATE. |
elapseSinceLastState | The time elapsed (ms) from the previous state to the current state. |
delegate void agora_gaming_rtc.ChannelOnChannelProxyConnectedHandler | ( | string | channelId, |
uint | uid, | ||
PROXY_TYPE | proxyType, | ||
string | localProxyIp, | ||
int | elapsed | ||
) |
Reports the proxy connection state.
You can use this callback to listen for the state of the SDK connecting to a proxy. For example, when a user calls SetCloudProxy and joins a channel successfully, the SDK triggers this callback to report the user ID, the proxy type connected, and the time elapsed from the user calling joinChannel
until this callback is triggered.
channelId | The channel name. |
uid | The user ID. |
proxyType | The proxy type. See PROXY_TYPE. |
localProxyIp | Reserved for future use. |
elapsed | The time elapsed (ms) from the user calling joinChannel until this callback is triggered. |
delegate void agora_gaming_rtc.ChannelOnClientRoleChangedHandler | ( | string | channelId, |
CLIENT_ROLE_TYPE | oldRole, | ||
CLIENT_ROLE_TYPE | newRole | ||
) |
Occurs when the user role switches in the interactive live streaming. For example, from a host to an audience or vice versa.
This callback notifies the application of a user role switch when the application calls the SetClientRole method.
The SDK triggers this callback when the local user switches the user role by calling the SetClientRole
method after joining the channel.
channelId | The name of the channel that you join. |
oldRole | Role that the user switches from: CLIENT_ROLE_TYPE. |
newRole | Role that the user switches to: CLIENT_ROLE_TYPE. |
delegate void agora_gaming_rtc.ChannelOnClientRoleChangeFailedHandler | ( | string | channelId, |
CLIENT_ROLE_CHANGE_FAILED_REASON | reason, | ||
CLIENT_ROLE_TYPE | currentRole | ||
) |
Occurs when the user role switch fails in the interactive live streaming.
In the LIVE_BROADCASTING
channel profile, when the local user calls SetClientRole
to switch their user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
channelId | The channel name. |
reason | The reason for the user role switch failure. See CLIENT_ROLE_CHANGE_FAILED_REASON. |
currentRole | The current user role. See CLIENT_ROLE_TYPE. |
delegate void agora_gaming_rtc.ChannelOnConnectionLostHandler | ( | string | channelId | ) |
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the JoinChannel method, whether or not it is in the channel.
This callback is different from OnConnectionInterruptedHandler:
OnConnectionInterruptedHandler
callback when it loses connection with the server for more than four seconds after it successfully joins the channel.ChannelOnConnectionLostHandler
callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel.If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel.
channelId | The name of the channel that you join. |
delegate void agora_gaming_rtc.ChannelOnConnectionStateChangedHandler | ( | string | channelId, |
CONNECTION_STATE_TYPE | state, | ||
CONNECTION_CHANGED_REASON_TYPE | reason | ||
) |
Occurs when the connection state between the SDK and the server changes.
channelId | The name of the channel that you join. |
state | See CONNECTION_STATE_TYPE. |
reason | See CONNECTION_CHANGED_REASON_TYPE. |
delegate void agora_gaming_rtc.ChannelOnErrorHandler | ( | string | channelId, |
int | er |