AgoraRtcEngineKit Class Reference

Discussion

Call this method to initialize the service before using AgoraRtcEngineKit.

Discussion

This method is useful for apps that occasionally make voice or video calls, to free up resources for other operations when not making calls.

Once the app calls this method to release the created RtcEngine instance, no other methods in the SDK can be used and no callbacks can occur. To start communications again, initialize sharedEngineWithappId to establish a new AgoraRtcEngineKit instance.

Note:

• Call this method in the subthread.
• This method call is synchronous. The result returns after the AgoraRtcEngineKit object resources are released. The app should not call this interface in the callback generated by the SDK. Otherwise, the SDK must wait for the callback to return before it can reclaim the related object resources, causing a deadlock.

Discussion

The SDK needs to know the application scenario to set the appropriate channel profile to apply different optimization methods.

The Agora Native SDK supports the following channel profiles:

• Communication
• Live Broadcast
• Gaming (for the Agora Gaming SDK only)

Note:

• Users in the same channel must use the same channel profile.
• Before calling this method to set a new channel profile, destroy the current engine and create a new engine using sharedEngineWithAppId.
• Call this method before a user joins a channel because you cannot configure the channel profile when the channel is in use.
• In the communication profile, the Agora SDK supports encoding only in raw data, not in texture.

Discussion

This method is applicable only to live broadcast profile.

Sets the role of the user such as a host or an audience (default), before joining a channel.

This method can be used to switch the user role after the user joins a channel.

Discussion

Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other even if they join the same channel.

You must call the leaveChannel method to exit the current call before entering another channel. This method call is asynchronous; therefore, you can call this method in the main user interface thread.

The SDK uses the OS X’s AVAudioSession shared object for audio recording and playback, so using this object may affect the SDK’s audio functions. If the joinChannelByToken method call is successful, the joinSuccessBlock callback is triggered. If you implement both joinSuccessBlock and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. If you want to use didJoinChannel, set joinSuccessBlock as nil.

Note:

A channel does not accept duplicate uids, such as two users with the same uid. If you set uid as 0, the system automatically assigns a uid.

Discussion

After joining a channel, the user must call the leaveChannel method to end the call before joining another channel.

This method returns 0 if the user leaves the channel and releases all resources related to the call.

This method call is asynchronous, and the user has not exited the channel when the method call returns. Once the user leaves the channel, the SDK triggers the didLeaveChannelWithStats callback.

Note:

• If you call destroy immediately after leaveChannel, the leaveChannel process interrupts, and the didLeaveChannelWithStats callback is not triggered.

• If you call this method during a CDN live streaming, the removePublishStreamUrl method is triggered.

• When you call this method, the SDK deactivates the audio session on iOS by default, and may affect other apps. If you do not want this default behavior, use setAudioSessionOperationRestriction to set AgoraAudioSessionOperationRestrictionDeactivateSession so that when you call leaveChannel, the SDK does not deactivate the audio session.

Discussion

The token expires after a period of time once the token schema is enabled when:

• The tokenPrivilegeWillExpire callback is triggered, or
• The didOccurError callback reports the AgoraErrorCodeTokenExpired(-109) error, or
• The rtcEngineRequestToken callback reports the AgoraErrorCodeTokenExpired(-109) error.

Note:

Agora recommends using the rtcEngineRequestToken callback to report the AgoraErrorCodeTokenExpired(-109) error, not using the didOccurError callback.

The app should call this method to get the token. Failure to do so results in the SDK disconnecting from the server.

Discussion

This method is applicable to the live broadcast profile only. In the communication profile, the SDK is interoperable with the Web SDK by default.

Discussion

The audio module is enabled by default.

Note:

• This method affects the internal engine and can be called after leaveChannel. You can call this method either before or after joining a channel.

• This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio engine modules separately:

  • enableLocalAudio: Whether to enable the microphone to create the local audio stream.
  • muteLocalAudioStream: Whether to publish the local audio stream.
  • muteRemoteAudioStream: Whether to subscribe to and play the remote audio stream.
  • muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.

Discussion

Note:

• This method affects the internal engine and can be called after leaveChannel. You can call this method either before or after joining a channel.

• This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio engine modules separately:

  • enableLocalAudio: Whether to enable the microphone to create the local audio stream.
  • muteLocalAudioStream: Whether to publish the local audio stream.
  • muteRemoteAudioStream: Whether to subscribe to and play the remote audio stream.
  • muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.

Discussion

Note:

• You must call setAudioProfile before joinChannelByToken.
• In the communication profile, you can set the profile but not the scenario.
• In the communication and live-broadcast profile, the bitrate may be different from your settings due to network self-adaptation.
• In scenarios involving music education, Agora recommends setting profile as AgoraAudioProfileMusicHighQuality(4) and scenario as AgoraAudioScenarioGameStreaming(3) in AgoraAudioScenario.

Discussion

When an app joins a channel, the audio module is enabled by default. This method disables or re-enables the local audio capture, that is, to stop or restart local audio capturing and processing.

This method does not affect receiving or playing the remote audio streams, and is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

The didMicrophoneEnabled callback is triggered once the local audio module is disabled or re-enabled.

Note:

Call this method after joinChannelByToken.

This method is different from muteLocalAudioStream:

• enableLocalAudio: Disables/Re-enables the local audio capturing and processing.
• muteLocalAudioStream: Stops/Continues sending the local audio streams.

Discussion

Use this method to stop/start sending the local audio stream.

Note:

When set to YES, this method does not disable the microphone and thus does not affect any ongoing recording.

Discussion

Note:

If you have called muteAllRemoteAudioStreams(YES) to mute all remote audio streams, please call muteAllRemoteAudioStreams(NO) before calling this method. muteAllRemoteAudioStreams sets all the remote streams, while muteRemoteAudioStream sets a specified stream.

Discussion

This method can be called either before or after joining the channel. If you call this method after joining the channel, then the audio streams of all the users joining after this are not received.

Discussion

The app can call this method either before entering a channel or during a call. If this method is called before entering a channel, the service starts in the video mode. If this method is called during an audio call, the audio mode switches to the video mode.

To disable the video, call the disableVideo method.

Note:

• This method affects the internal engine and can be called after leaveChannel.

• This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately:

  • enableLocalVideo: Whether to enable the camera to create the local video stream.
  • muteLocalVideoStream: Whether to publish the local video stream.
  • muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
  • muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.

Discussion

The app may call this method before entering a channel or during a call. If this method is called before entering a channel, the service starts in the audio mode. If this method is called during a video call, the video mode switches to the audio mode. To enable the video module, call the enableVideo method.

Note:

• This method affects the internal engine and can be called after leaveChannel.

• This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately:

  • enableLocalVideo: Whether to enable the camera to create the local video stream.
  • muteLocalVideoStream: Whether to publish the local video stream.
  • muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
  • muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.

Discussion

Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation.

The parameters specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.

If you do not need to set the video encoder configuration after joining the channel, you can call this method before enableVideo to reduce the render time of the first video frame.

Note:

Since v2.3.0, the following API methods are deprecated:

• setVideoProfile
• setVideoResolution

Discussion

The app calls this method to bind each video window (view) of the local video streams and configures the video display settings. Call this method after initialization to configure the local video display settings before entering a channel. The binding is still valid after the user leaves the channel, which means the window still displays. To unbind the view, set the view in AgoraRtcVideoCanvas to nil.

Discussion

This method binds the remote user to the video display window (sets the view for the user of the specified uid).

The app specifies the uid of the remote video in the method call before the user joins a channel.

If the remote uid is unknown to the app, set it after the app receives the userJoinedBlock event.

If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the didJoinedOfUid event. Do not bind the dummy client to the app view because the dummy client does not send any video streams. If your app does not recognize the dummy client, bind the remote user to the view when the firstRemoteVideoDecodedOfUid callback is triggered.

To unbind the remote user from the view, set the view in AgoraRtcVideoCanvas to nil. Once the remote user leaves the channel, the SDK unbinds the remote user.

Discussion

This method may be invoked multiple times during a call to change the display mode.

Discussion

This method can be invoked multiple times during a call to change the display mode.

Discussion

Before calling this method, you must:

• Call setupLocalVideo to set up the local preview window and configure the attributes.
• Call enableVideo to enable video.

Note:

Once startPreview is called to start the local video preview, if you leave the channel by calling leaveChannel, the local video preview remains until you call stopPreview to disable it.

Discussion

This method disables the local video and is only applicable when the user wants to watch the remote video without sending any video stream to the other user.

Call this method after enableVideo, otherwise, this method may not work properly.

After enableVideo is called, the local video is enabled by default. This method is used to disable the local video while the remote video remains unaffected.

Note:

This method enables the internal engine and can be called after leaveChannel.

Discussion

When set to YES, this method does not disable the camera, and thus does not affect the retrieval of the local video stream. This method responds faster compared to enableLocalVideo which controls the sending of local video streams.

Discussion

Note:

If you called muteAllRemoteVideoStreams and set to YES to stop receiving all remote video streams, ensure that muteAllRemoteVideoStreams is called and set to NO before calling this method.

Discussion

This method sets whether the received audio is routed to the earpiece or speakerphone by default before joining the channel. If the user does not call this method, the audio is routed to the earpiece by default.

If you need to change the default audio route after joining the channel, call setEnableSpeakerphone.

Note:

• This method only works in audio mode.
• Call this method before calling joinChannel.

The default settings for each mode:

• Voice: Earpiece.
• Video: Speakerphone. If the user in a communication channel calls disableVideo or if the user calls muteLocalVideoStream and muteAllRemoteVideoStreams, the default audio route is switched to the earpiece automatically.
• Live Broadcast: Speakerphone.
• Gaming Voice: Speakerphone.

Discussion

This method sets whether the audio is routed to the speakerphone.

Note:

• Ensure that you have successfully called the joinChannelByToken method before calling this method.
• The SDK calls setCategory(AVAudioSessionCategoryPlayAndRecord) with options to configure the headset/speakerphone, so this method applies to all audio playback in the system.
• After this method is called, the SDK returns the didAudioRouteChanged callback, indicating that the audio route changes.
• This method does not take effect when using a headset.

Discussion

This method mixes the specified local audio file with the audio stream from the microphone, or replaces the microphone’s audio stream with the specified local audio file. You can choose whether the other user can hear the local audio playback and specify the number of playback loops. This method also supports online music playback.

When the audio mixing file playback finishes after calling this method, the rtcEngineLocalAudioMixingDidFinish callback is triggered.

Note:

• To use this method, ensure that the iOS device version is 8.0+.
• Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

Call this method when you are in a channel.

Discussion

The value ranges between 0.0 and 100.0.

Discussion

You can use this method to add specific audio effects for specific scenarios, for example, gaming. When the audio effect file playback is finished, the rtcEngineDidAudioEffectFinish callback is triggered。

Discussion

To ensure smooth communication, limit the size of the audio effect file. Agora recommends using this method to preload the audio effect before calling joinChannelByToken.

Supported audio formats: mp3, aac, m4a, 3gp, and wav.

Discussion

The SDK allows recording during a call. Supported formats:

• .wav: Large file size with high fidelity
• .aac: Small file size with low fidelity

Ensure that the directory to save the recording file exists and is writable. This method is usually called after the joinChannelByToken method. The recording automatically stops when the leaveChannel method is called.

Discussion

Note:

You can call this method before calling leaveChannel else, the recording automatically stops when the leaveChannel method is called.

Discussion

If you enable loopback recording, the output of the sound card is mixed into the audio stream sent to the other end.

Note:

macOS does not support loopback of the default sound card. If you need to use this method, please use a virtual sound card and pass its name to the deviceName parameter. Agora has tested and recommends using soundflower.

Discussion

The SDK and the app can both configure the audio session by default. The app may occasionally use other applications or third-party components to manipulate the audio session and restrict the SDK from doing so. This method allows the app to restrict the SDK’s manipulation of the audio session.

You can call this method at any time to return the control of the audio sessions to the SDK.

Note:

This method restricts the SDK’s manipulation of the audio session. Any operation to the audio session relies solely on the app, other applications, or third-party components.

Discussion

This method launches an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly.

To conduct the test:

• The user speaks and the recording is played back within 10 seconds.
• If the user can hear the recording within 10 seconds, the audio devices and network connection are working properly.

Note:

• After calling this method, always call stopEchoTest to end the test. Otherwise, the app cannot run the next echo test, nor can it call the joinChannelByToken method to start a new call.
• In the live broadcast profile, only the hosts can call this method. If the user switches from a communication to live broadcast channel, the user must call setClientRole to change the user role from the audience (default) to the host before calling this method.

Discussion

This method tests the quality of the user’s network connection and is disabled by default.

Before users join a channel or before an audience switches to a host, call this method to check the uplink network quality.

This method consumes additional network traffic, which may affect the communication quality.

Call disableLastmileTest to disable the test immediately after receiving the lastmileQuality callback, and before the user joins the channel or switches the user role.

Note:

• Do not call any other methods before receiving the lastmileQuality callback. Otherwise, the callback may be interrupted by other methods and may not execute.

• In the Live Broadcast profile, a host should not call this method.

Discussion

In real-time communications, the Agora SDK uses the default video input source (the built-in camera) to publish streams. To use the external video source, call AgoraVideoSourceProtocol to set the custom video source and then use this method to add the external video source into the SDK.

Discussion

In real-time communications, the Agora SDK uses the default video renderer to render the video. To use the external video renderer, call AgoraVideoSinkProtocol to set the custom local video renderer and then use this method to add the external renderer into the SDK.

Discussion

This method sets the remote local renderer. In real-time communications, the Agora SDK uses the default video renderer to render the video. To use the external video renderer, call AgoraVideoSinkProtocol to set the custom remote video renderer and then use this method to add the external renderer into the SDK.

Discussion

If an external video source is used, call this method before enableVideo or startPreview.

Discussion

This method pushes the video frame using the AgoraVideoFrame class and passes the video frame to the Agora SDK with the input format found in AgoraVideoFrame. Call setExternalVideoSource and set the pushMode parameter as YES before calling this method. Otherwise, a failure returns after calling this method.

Note:

This method supports pushing textured video frames in the live-broadcast profile only, not in the communication profile.

Discussion

See Modify Raw Data for details.

Discussion

See Modify Raw Data for details.

Discussion

See Modify Raw Data for details.

Discussion

This method adds a PNG watermark to the local video stream for the recording device, channel audience, and CDN live audience to see and capture.

To add the PNG file onto a CDN live publishing stream only, see the setLiveTranscoding method.

Note:

• The URL descriptions are different for the local video and CDN live streams:
  • In a local video stream, url in AgoraImage refers to the absolute path of the added watermark image file in the local video stream.
  • In a CDN live stream, url in AgoraImage refers to the HTTP/HTTPS URL address of the added watermark image in the CDN live broadcast.
• The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file is cropped to conform to your settings.
• The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.
• If you set orientationMode as Adaptive in the setVideoEncoderConfiguration method, the watermark image rotates with the video frame and rotates around the upper left corner of the watermark image.

Discussion

The default setting for option is AgoraStreamFallbackOptionDisabled, where there is no fallback for the published video stream when the uplink network conditions are unreliable.

If option is set to AgoraStreamFallbackOptionAudioOnly, the SDK will:

• Disable the upstream video but enable audio only when the network conditions deteriorate and cannot support both video and audio.
• Re-enable the video when the network conditions improve.

When the published stream falls back to audio-only or when the audio stream switches back to the video, the didLocalPublishFallbackToAudioOnly callback is triggered.

Note:

Agora does not recommend using this method for CDN live streaming, because the remote CDN live user will have a noticeable lag when the published stream falls back to audio-only.

Discussion

The default setting for option is AgoraStreamFallbackOptionVideoStreamLow, where the remote stream falls back to the low-video stream (low resolution and low bitrate) under unreliable downlink network conditions.

If option is set to AgoraStreamFallbackOptionAudioOnly, the SDK automatically switches the video from a high stream to a low stream, or disable the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and re-enables the video stream when the network conditions improve. Once the published stream falls back to audio only, or the audio stream switches back to the video stream, the didRemoteSubscribeFallbackToAudioOnly callback is triggered.

Discussion

If dual-stream mode is enabled, the receiver can choose to receive the high stream (high-resolution high-bitrate video stream), or low stream (low-resolution low-bitrate video stream).

Discussion

This method allows the app to adjust the corresponding video-stream type based on the size of the video window to reduce the bandwidth and resources.

• If the remote user enables the dual-stream mode by calling enableDualStreamMode, the SDK receives the high-video stream by default. You can use this method to switch to the low-video stream type.
• If the dual-stream mode is not enabled, the SDK receives the high-video stream by default.

The method result returns in the didApiCallExecute callback. The Agora SDK receives the high-video stream by default to save the bandwidth. If needed, users may use this method to switch to the low-video stream.

By default, the aspect ratio of the low-video stream is the same as the high-video stream. Once the resolution of the high-video stream is set, the system automatically sets the resolution, frame rate, and bitrate for the low-video stream.

Discussion

All users in a channel must set the same encryption password. The encryption password is automatically cleared once a user leaves the channel.

If the encryption password is not specified or set to empty, the encryption functionality is disabled.

Note:

Do not use this method for CDN live streaming.

Discussion

The Agora SDK supports built-in encryption, which is set to the AgoraEncryptionModeAES128XTS mode by default. Call this method to use other encryption modes.

All users in the same channel must use the same encryption mode and password.

Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.

Note:

• Call setEncryptionSecret to enable the built-in encryption function before calling this method.
• Do not use this method for CDN live streaming.

Discussion

The streamPublishedWithUrl callback returns the inject stream status.

If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. This is applicable to scenarios where all the audience members in the channel can watch a live show and interact with each other.

The didJoinedOfUid and firstRemoteVideoDecodedOfUid callbacks are triggered and a stream uid of 666 is returned.

Discussion

This method removes the HTTP/HTTPS URL address (added by addInjectStreamUrl) from a live broadcast.

If this method call is successful, the didOfflineOfUid callback is triggered and a stream uid of 666 is returned.

Discussion

The host publishes the stream to the specified CDN live RTMP URL address. This method triggers the streamPublishedWithUrl callback.

Note:

• Ensure that the user joins the channel before calling this method.
• This method adds only one stream URL each time it is called.
• The URL must not contain special characters, such as Chinese language characters.

Discussion

This method removes the RTMP URL address added by addPublishStreamUrl from a CDN live stream.

Note:

• This method removes only one URL each time it is called.
• The URL must not contain special characters such as Chinese language characters.

Discussion

Each user can have up to five simultaneous data channels.

Note:

Set both the reliable and ordered parameters to YES or NO. Do not set one as YES and the other as NO.

Discussion

The SDK has the following restrictions on this method:

• Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB.
• Each client can send up to 6 kB of data per second.
• Each user can have up to five data streams simultaneously.

Note:

This method applies only to the communication profile or to the hosts in the live broadcast profile. If an audience in the live broadcast profile calls this method, the audience role may be changed to a host.

Discussion

Under unreliable network connections or the device’s CPU is overloaded, the video quality may be affected. You can use this method to choose the video smoothness (frame rate) over the image quality or vice versa.

Discussion

Use this method before startPreview, or the mirror mode does not take effect until you re-enable startPreview.

Discussion

Note:

The app generally enables the front camera by default. If your front camera flash is not supported, this method returns NO. If you want to check if the rear camera flash is supported, call switchCamera before calling this method.

Discussion

Use this method to monitor the plugging and swapping of external audio/video devices, for example, an external camera.

Discussion

Note:

Do not call this method in the main thread.

This method returns an NSArray object, including all the audio/video devices in the system. Your app can use the AgoraRtcDeviceInfo array object to enumerate the devices.

Discussion

This method tests whether the microphone works properly. Once the test starts, the SDK reports the volume information by using the reportAudioVolumeIndicationOfSpeakers callback.

Discussion

This method stops testing the microphone. You must call this method to stop the test after calling the startRecordingDeviceTest method.

Discussion

This method tests whether the audio playback device works properly with a specified playback audio file.

Discussion

This method stops testing the audio playback device. You must call this method to stop the test after calling startPlaybackDeviceTest.

Discussion

This method tests whether the current video capture device works properly. Ensure that you have called enableVideo before calling this method and that the parameter view window is valid.

Discussion

This method stops testing the capture device. You must call this method to stop the test after calling startCaptureDeviceTest.

Discussion

When a user joins a channel on a client, a callId is generated to identify the call from the client. Feedback methods, such as the rate and complain methods, must be called after the call ends to submit feedback to the SDK.

The rate and complain methods require the callId parameter retrieved from the getCallId method during a call. callId is passed as an argument into the rate and complain methods after the call ends.

Discussion

If disabled, the app should dispatch the UI operating to the main queue.

Discussion

This method returns the string of the version number.

Discussion

The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.

Note:

The default log file location is at Library/caches/agorasdk.log.

Discussion

You can use one or a combination of the filters. The log level follows the sequence of OFF, CRITICAL, ERROR, WARNING, INFO, and DEBUG. Choose a level to see the logs preceding that level.

For example, if you set the log level to WARNING, you see the logs within levels CRITICAL, ERROR, and WARNING.

Discussion

This interface is used to get the native C++ handler of the SDK engine used in special scenarios, such as registering the audio and video frame observer.

Discussion

The SDK uses the delegate to inform the app on engine runtime events. All methods defined in the delegate are optional implementation methods.

Discussion

Note:

The JSON options are not public by default. Agora is working on making commonly used JSON options public in a standard way. Contact support@agora.io for more information.

Discussion

Note:

This method is not public. Contact support@agora.io for more information.

Discussion

DEPRECATED from v2.3.

Discussion

DEPRECATED from v2.3

Discussion

DEPRECATED from v2.3

Discussion

Replaced with setAudioProfile.

DEPRECATED from v2.3.

Discussion

DEPRECATED from v2.3.

Discussion

DEPRECATED from v2.3.

Each video profile includes a set of parameters, such as the resolution, frame rate, and bitrate. If the camera device does not support the specified resolution, the SDK automatically chooses a suitable camera resolution, keeping the encoder resolution specified by setVideoProfile.

Note:

• Always set the video profile after calling the enableVideo method.
• Always set the video profile before calling the joinChannelByToken or startPreview method.
• If you do not need to set the video profile after joining the channel, call this method before enableVideo to reduce the render time of the first video frame.

Discussion

DEPRECATED from v2.3.

If you do not need to change the video profile after joining the channel, Agora recommends calling this method before enableVideo to reduce the render time of the first video frame.

Discussion

DEPRECATED

This method is deprecated. Agora recommends using the following methods instead:

• addPublishStreamUrl
• removePublishStreamUrl
• setLiveTranscoding

Discussion

DEPRECATED

This method is deprecated and Agora recommends using the setLiveTranscoding method.

This method sets the picture-in-picture layouts for live broadcasts. This method is only applicable when you want to push streams to the Agora server. When you push the stream to the server:

1. Define a canvas, its width and height (video resolution), background color, and the total number of video streams you want to display.
2. Define the position and size for each video stream on the canvas, and indicate whether the view is cropped or zoomed to fit.

The push stream application formats the information of the customized layouts as JSON and packages it in the Supplemental Enhancement Information (SEI) of each keyframe when generating the H.264 video stream and pushing it to the CDN live vendors through the RTMP protocol.

Note:

• Call this method after joining a channel.
• The app should only allow one user to call this method in the same channel. Call clearVideoCompositingLayout to remove the settings.

Discussion

DEPRECATED

Removes the picture-in-picture layout settings created by setVideoCompositingLayout.

Discussion

DEPRECATED from v2.3.

Discussion

DEPRECATED from v2.3.

Discussion

DEPRECATED from v2.3.

Discussion

DEPRECATED from v1.1.

This callback is disabled by default and can be enabled by the enableAudioVolumeIndication method.

In the returned speaker’s array:

• If the uid is 0 (the local user is the speaker), the returned volume is the totalVolume.
• If the uid is not 0 and the volume is 0, the specified user did not speak.
• If a uid is found in the previous speaker’s array but not in the current speaker’s array, the specified user did not speak.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

If there are other users in the channel when this user joins, the SDK also reports to the app on the existing users who are already in the channel.

Discussion

DEPRECATED from v1.1.

The SDK reads the timeout data to determine if a user leaves the channel (or goes offline). If no data packet is received from the user within 15 seconds, the SDK assumes the user is offline. Sometimes a weak network connection may lead to false detections; therefore, Agora recommends using signaling for reliable offline detection.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

When the client loses connection with the server because of network problems, the SDK automatically attempts to reconnect and triggers this callback upon reconnection.

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

When the app calls the leaveChannel method, the SDK uses this callback to notify the app that a user leaves the channel.

With this callback, the app retrieves information, such as the call duration and the statistics of the data received/transmitted by audioQualityOfUid.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.

Discussion

DEPRECATED from v1.1.