Agora RTC Objective-C API Reference
Refactor
|
Go to the source code of this file.
enum AgoraChannelProfile |
The channel profile.
Enumerator | |
---|---|
AgoraChannelProfileCommunication | 0: Communication. This profile prioritizes smoothness and applies to the one-to-one scenario. |
AgoraChannelProfileLiveBroadcasting | 1: (Default) Live Broadcast. This profile prioritizes supporting a large audience in a live broadcast channel. |
AgoraChannelProfileGame |
|
AgoraChannelProfileCloudGaming |
|
AgoraChannelProfileCommunication_1v1 |
|
enum AgoraClientRole |
The brightness level of the video image captured by the local camera.
enum AgoraCloudProxyType |
Reason for the user being offline
enum AgoraLogFilter |
Output log filter level
enum AgoraAudioCodecType |
the audio encoding type of audio encoded frame delegate
enum AgoraNetworkQuality |
Network quality
The reason for poor QoE of the local user when receiving a remote audio stream.
The state of the probe test.
enum AgoraVideoStreamType |
Quality change of the local video in terms of target frame rate and target bit rate since last count.
enum AgoraVideoRenderMode |
Video display mode
Enumerator | |
---|---|
AgoraVideoRenderModeHidden | Hidden(1): Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. |
AgoraVideoRenderModeFit | Fit(2): Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black. |
AgoraVideoRenderModeAdaptive |
|
enum AgoraVideoLocalState |
States of the local video.
States of the local video.
Enumerator | |
---|---|
AgoraLocalVideoStreamErrorOK | 0: The local video is normal. |
AgoraLocalVideoStreamErrorFailure | 1: No specified reason for the local video failure. |
AgoraLocalVideoStreamErrorDeviceNoPermission | 2: The application does not have permission to start the local video capture device. Remind your user to grant permission and rejoin the channel. |
AgoraLocalVideoStreamErrorDeviceBusy | 3: The local video capture device is in use. Check whether the camera is occupied by another application or try to rejoin the channel. |
AgoraLocalVideoStreamErrorCaptureFailure | 4: The local video capture failed. Check whether the video capture device is working properly, check whether the camera is occupied by another application, or try to rejoin the channel. |
AgoraLocalVideoStreamErrorEncodeFailure | 5: The local video encoding fails. |
AgoraLocalVideoStreamErrorCaptureInBackGround | 6: (iOS only) The application is in the background. Remind your user that the application cannot capture video properly when the application is in the background. |
AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps | 7: (iOS only) The application is running in Slide Over, Split View, or Picture in Picture mode. Remind your user that the application cannot capture video properly when the application is running in Slide Over, Split View, or Picture in Picture mode. |
AgoraLocalVideoStreamErrorCaptureNoDeviceFound | 8: The SDK cannot find the local video capture device. Check whether the camera is connected to the device properly, check whether the camera is working properly, or try to rejoin the channel. |
AgoraLocalVideoStreamErrorCaptureDeviceDisconnected | 9: (macOS only) The external camera currently in use is disconnected (such as being unplugged). |
AgoraLocalVideoStreamErrorCaptureDeviceInvalidId | 10: The SDK cannot find the local video device id in device list, device id is invalid. |
AgoraLocalVideoStreamErrorScreenCaptureWindowMinimized | 11: (macOS only) The shared window is minimized when you call [startScreenCaptureByWindowId]([AgoraRtcEngineKit startScreenCaptureByWindowId:rectangle:parameters:]) to share a window. Remind your user that the window cannot be shared properly when the shared window is minimized. |
AgoraLocalVideoStreamErrorScreenCaptureWindowClosed | 12: (macOS only) 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: When the local user closes the shared window, the SDK reports this error code.t The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code. The local user watches web video or reads web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code. |
AgoraLocalVideoStreamErrorExtensionCaptureStarted | 13: (iOS only) The screen sharing extension process starts, i.e. Start the extension process capture |
AgoraLocalVideoStreamErrorExtensionCaptureStoped | 14: (iOS only) The screen sharing extension process ends. i.e. Stop the extension process capture |
AgoraLocalVideoStreamErrorExtensionCaptureDisconnected | 15: (iOS only) The screen sharing extension process quits unexpectedly. i.e. Disconnected with the extension process |
The reason of the remote video state change.
enum AgoraAudioLocalState |
The state of the local audio.
enum AgoraAudioLocalError |
The error information of the local audio.
The state of the remote audio.
Enumerator | |
---|---|
AgoraAudioRemoteStateStopped | 0: The remote audio stops (the default state). The following are possible reasons: |
AgoraAudioRemoteStateStarting | 1: The first remote audio packet is received. |
AgoraAudioRemoteStateDecoding | 2: The remote audio stream is decoded and plays normally. The following are possible reasons: |
AgoraAudioRemoteStateFrozen | 3: The remote audio is frozen. The possible reason is AgoraAudioRemoteReasonNetworkCongestion(1). |
AgoraAudioRemoteStateFailed | 4: The remote audio fails to start. The possible reason is AgoraAudioRemoteReasonInternal(0). |
The reason of the remote audio state change.
enum AgoraAudioProfile |
Audio profile types.
enum AgoraAudioScenario |
Audio application scenarios.
Use mode of the onRecordAudioFrame callback
The options for SDK preset voice beautifier effects.
The options for SDK preset voice conversion.
enum AgoraVideoFormat |
Video frame format
enum AgoraVideoFrameType |
Types of the video frame.
enum AgoraConnectionState |
The connection state of the SDK.
enum AgoraNetworkType |
The network type.
The video encoding degradation preference under limited bandwidth.
The video noise reduction mode.
The video noise reduction level.
The low-light enhancement mode.
The low-light enhancement level.
enum AgoraBlurDegree |
enum SegModelType |
enum AgoraMetadataType |
enum AgoraLogLevel |
Supported logging severities of SDK.
enum AgoraAreaCodeType |
The RTMP or RTMPS streaming state.
Enumerator | |
---|---|
AgoraRtmpStreamingStateIdle | The RTMP or RTMPS streaming has not started or has ended. This state is also triggered after you remove an RTMP or RTMPS stream from the CDN by calling [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:]). |
AgoraRtmpStreamingStateConnecting | The SDK is connecting to Agora's streaming server and the CDN server. This state is triggered after you call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method. |
AgoraRtmpStreamingStateRunning | The RTMP or RTMPS streaming is being published. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state. |
AgoraRtmpStreamingStateRecovering | The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK attempts to resume RTMP or RTMPS streaming and returns this state. If the SDK successfully resumes the streaming, |
AgoraRtmpStreamingStateFailure | The RTMP or RTMPS streaming fails. See the errorCode parameter for the detailed error information. You can also call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the RTMP or RTMPS streaming again. |
AgoraRtmpStreamingStateDisconnecting | The SDK is disconnecting to Agora's streaming server and the CDN server. This state is triggered after you call the [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:transcodingEnabled:]) method. |
The detailed error information for streaming.
Enumerator | |
---|---|
AgoraRtmpStreamingErrorCodeOK | The RTMP or RTMPS streaming publishes successfully. |
AgoraRtmpStreamingErrorCodeInvalidParameters | Invalid argument used. If, for example, you do not call the [setLiveTranscoding]([AgoraRtcEngineKit setLiveTranscoding:]) method to configure the LiveTranscoding parameters before calling the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly. |
AgoraRtmpStreamingErrorCodeEncryptedStreamNotAllowed | The RTMP or RTMPS streaming is encrypted and cannot be published. |
AgoraRtmpStreamingErrorCodeConnectionTimeout | Timeout for the RTMP or RTMPS streaming. Call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the streaming again. |
AgoraRtmpStreamingErrorCodeInternalServerError | An error occurs in Agora's streaming server. Call the [addPublishStreamUrl]([AgoraRtcEngineKit addPublishStreamUrl:transcodingEnabled:]) method to publish the streaming again. |
AgoraRtmpStreamingErrorCodeRtmpServerError | An error occurs in the CDN server. |
AgoraRtmpStreamingErrorCodeTooOften | The RTMP or RTMPS streaming publishes too frequently. |
AgoraRtmpStreamingErrorCodeReachLimit | The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. |
AgoraRtmpStreamingErrorCodeNotAuthorized | The host manipulates other hosts' URLs. Check your app logic. |
AgoraRtmpStreamingErrorCodeStreamNotFound | Agora's server fails to find the RTMP or RTMPS streaming. |
AgoraRtmpStreamingErrorCodeFormatNotSupported | The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct. |
AgoraRtmpStreamingErrorNotBroadcaster | Current role is not broadcaster. Check whether the role of the current channel. |
AgoraRtmpStreamingErrorTranscodingNoMixStream | Call updateTranscoding, but no mix stream. |
AgoraRtmpStreamingErrorNetDown | Network error. |
AgoraRtmpStreamingErrorInvalidAppId | User AppId have not authorized to push stream. |
AgoraRtmpStreamingErrorInvalidPrivilege | invalid privilege. |
AgoraRtmpStreamingErrorCodeUnpublishOK | The streaming has been stopped normally. After you call [removePublishStreamUrl]([AgoraRtcEngineKit removePublishStreamUrl:]) to stop streaming, the SDK returns this value.
|
Events during the RTMP or RTMPS streaming.
enum AgoraCameraDirection |
The state code in AgoraChannelMediaRelayState.
The event code in AgoraChannelMediaRelayEvent.
The error code in AgoraChannelMediaRelayError.
Enumerator | |
---|---|
AgoraChannelMediaRelayErrorNone | 0: The state is normal. |
AgoraChannelMediaRelayErrorServerErrorResponse | 1: An error occurs in the server response. |
AgoraChannelMediaRelayErrorServerNoResponse | 2: No server response. You can call the [leaveChannel]([AgoraRtcEngineKit leaveChannel:]) method to leave the channel. |
AgoraChannelMediaRelayErrorNoResourceAvailable | 3: The SDK fails to access the service, probably due to limited resources of the server. |
AgoraChannelMediaRelayErrorFailedJoinSourceChannel | 4: Fails to send the relay request. |
AgoraChannelMediaRelayErrorFailedJoinDestinationChannel | 5: Fails to accept the relay request. |
AgoraChannelMediaRelayErrorFailedPacketReceivedFromSource | 6: The server fails to receive the media stream. |
AgoraChannelMediaRelayErrorFailedPacketSentToDestination | 7: The server fails to send the media stream. |
AgoraChannelMediaRelayErrorServerConnectionLost | 8: The SDK disconnects from the server due to poor network connections. You can call the [leaveChannel]([AgoraRtcEngineKit leaveChannel:]) method to leave the channel. |
AgoraChannelMediaRelayErrorInternalError | 9: An internal error occurs in the server. |
AgoraChannelMediaRelayErrorSourceTokenExpired | 10: The token of the source channel has expired. |
AgoraChannelMediaRelayErrorDestinationTokenExpired | 11: The token of the destination channel has expired. |
The screen sharing scenario.
enum AgoraMediaSourceType |
Media source types definition.
enum AgoraVideoSourceType |
Video source types definition.
enum AgoraMediaStreamType |
AgoraMediaStreamType, reporting the type of the media stream.
Player state.
The video display mode.
AgoraMediaPlayerError, reporting the player's error code.
AgoraMediaPlayerEvent, reporting the result of the seek operation to the new playback position.
AgoraMediaPlayerMetaDataType, reporting the type of the media metadata.
enum AgoraPermissionType |
Streaming state.
The bit mask that controls the audio observation positions.
Enumerator | |
---|---|
AgoraAudioFramePositionPlayback | The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the [onPlaybackAudioFrame]([AgoraAudioFrameDelegate onPlaybackAudioFrame:]) callback. |
AgoraAudioFramePositionRecord | The position for observing the recorded audio of the local user, which enables the SDK to trigger the [onRecordAudioFrame]([AgoraAudioFrameDelegate onRecordAudioFrame:]) callback. |
AgoraAudioFramePositionMixed | The position for observing the mixed audio of the local user and all remote users, which enables the SDK to trigger the [onMixedAudioFrame]([AgoraAudioFrameDelegate onMixedAudioFrame:]) callback. |
AgoraAudioFramePositionBeforeMixing | The position for observing the audio of a single remote user before mixing, which enables the SDK to trigger the [onPlaybackAudioFrameBeforeMixing]([AgoraAudioFrameDelegate onPlaybackAudioFrameBeforeMixing:uid:]) callback. |
The content hint for screen sharing.
Thread priority type.
The states of the rhythm player.
The error codes of the rhythm player.
enum AgoraLocalProxyMode |
enum AgoraProxyType |
The proxy type.
The frame position of the video observer.
enum AgoraWlAccReason |
enum AgoraWlAccAction |
Suggest an action for the user.
Recorder error code.
The type of the shared target.