public abstract class RtcEngineEx extends RtcEngine
Constructor and Description |
---|
RtcEngineEx() |
Modifier and Type | Method and Description |
---|---|
abstract int |
addVideoWatermarkEx(java.lang.String watermarkUrl,
WatermarkOptions options,
RtcConnection connection)
Adds a watermark image to the local video.
|
abstract int |
clearVideoWatermarkEx(RtcConnection connection)
Removes the watermark image from the video stream added by
addVideoWatermarkEx . |
abstract int |
createDataStreamEx(boolean reliable,
boolean ordered,
RtcConnection connection)
Creates a data stream.
|
abstract int |
createDataStreamEx(DataStreamConfig config,
RtcConnection connection)
Creates a data stream.
|
abstract int |
enableAudioVolumeIndicationEx(int interval,
int smooth,
boolean reportVad,
RtcConnection connection)
Enables the `onAudioVolumeIndication` callback to report on which users are speaking
and the speakers' volume.
|
abstract int |
enableDualStreamModeEx(boolean enabled,
SimulcastStreamConfig streamConfig,
RtcConnection connection)
Enables or disables the dual video stream mode.
|
abstract int |
getConnectionStateEx(RtcConnection connection)
Gets the connection state of the SDK.
|
abstract int |
getUserInfoByUidEx(int uid,
UserInfo userInfo,
RtcConnection connection)
Gets the user information by passing in the user ID.
|
abstract int |
getUserInfoByUserAccountEx(java.lang.String userAccount,
UserInfo userInfo,
RtcConnection connection)
Gets the user information by passing in the user account.
|
abstract int |
joinChannelEx(java.lang.String token,
RtcConnection connection,
ChannelMediaOptions options,
IRtcEngineEventHandler eventHandler)
Joins a channel with the connection ID.
|
abstract int |
joinChannelWithUserAccountEx(java.lang.String token,
java.lang.String channelId,
java.lang.String userAccount,
ChannelMediaOptions options,
IRtcEngineEventHandler eventHandler)
Joins the channel with a user account.
|
abstract int |
leaveChannelEx(RtcConnection connection)
Leaves the channel with the specified connection ID.
|
abstract int |
muteAllRemoteAudioStreamsEx(boolean muted,
RtcConnection connection)
Stops or resumes receiving all remote audio stream with connection.
|
abstract int |
muteAllRemoteVideoStreamsEx(boolean muted,
RtcConnection connection)
Stops or resumes receiving all remote video stream with connection.
|
abstract int |
muteLocalAudioStreamEx(boolean muted,
RtcConnection connection)
Stops or resumes sending the local audio stream with connection.
|
abstract int |
muteLocalVideoStreamEx(boolean muted,
RtcConnection connection)
Stops or resumes sending the local video stream with connection.
|
abstract int |
muteRemoteAudioStreamEx(int uid,
boolean muted,
RtcConnection connection)
Stops or resumes receiving the audio stream of a specified user with specified connection.
|
abstract int |
muteRemoteVideoStreamEx(int uid,
boolean muted,
RtcConnection connection)
Stops or resumes receiving the video stream of a specified user with specified connection.
|
abstract int |
pauseAllChannelMediaRelayEx(RtcConnection connection)
pause the channels for media stream relay.
|
abstract int |
pushExternalEncodedVideoFrameEx(java.nio.ByteBuffer data,
EncodedVideoFrameInfo frameInfo,
int videoTrackId)
Pushes the encoded external video frame to the app with specified connection.
|
abstract int |
pushExternalVideoFrameEx(AgoraVideoFrame frame,
int videoTrackId)
Pushes the external video frame to the app with specified connection.
|
abstract int |
pushExternalVideoFrameEx(VideoFrame frame,
int videoTrackId)
Pushes the external video frame to the app.
|
abstract int |
resumeAllChannelMediaRelayEx(RtcConnection connection)
resume the channels for media stream relay.
|
abstract int |
sendCustomReportMessageEx(java.lang.String id,
java.lang.String category,
java.lang.String event,
java.lang.String label,
int value,
RtcConnection connection)
Report custom event to argus.
|
abstract int |
sendStreamMessageEx(int streamId,
byte[] message,
RtcConnection connection)
Sends data stream messages to all users in a channel.
|
abstract int |
setDualStreamModeEx(Constants.SimulcastStreamMode mode,
SimulcastStreamConfig streamConfig,
RtcConnection connection)
Enables, disables or auto enable the dual video stream mode.
|
abstract int |
setRemoteRenderModeEx(int uid,
int renderMode,
int mirrorMode,
RtcConnection connection)
Updates the display mode of the video view of a remote user with the specified connection.
|
abstract int |
setRemoteUserSpatialAudioParamsEx(int uid,
SpatialAudioParams params,
RtcConnection connection)
Sets the 3D sound position of a remote user.
|
abstract int |
setRemoteVideoStreamTypeEx(int uid,
int streamType,
RtcConnection connection)
Sets the remote video stream type.
|
abstract int |
setRemoteVideoSubscriptionOptionsEx(int uid,
VideoSubscriptionOptions options,
RtcConnection rtcConnection) |
abstract int |
setRemoteVoicePositionEx(int uid,
double pan,
double gain,
RtcConnection connection)
Sets the sound position and gain of a remote user.
|
abstract int |
setSubscribeAudioBlacklistEx(int[] uidList,
RtcConnection connection)
Sets the blacklist of subscribe remote stream audio.
|
abstract int |
setSubscribeAudioWhitelistEx(int[] uidList,
RtcConnection connection)
Sets the whitelist of subscribe remote stream audio.
|
abstract int |
setSubscribeVideoBlacklistEx(int[] uidList,
RtcConnection connection)
Sets the blacklist of subscribe remote stream video.
|
abstract int |
setSubscribeVideoWhitelistEx(int[] uidList,
RtcConnection connection)
Sets the whitelist of subscribe remote stream video.
|
abstract int |
setupRemoteVideoEx(VideoCanvas remote,
RtcConnection connection)
Initializes the video view of a remote user with a specified connection ID.
|
abstract int |
setVideoEncoderConfigurationEx(VideoEncoderConfiguration config,
RtcConnection connection)
Sets the video encoder configuration with specified connection.
|
abstract int |
startChannelMediaRelayEx(ChannelMediaRelayConfiguration channelMediaRelayConfiguration,
RtcConnection connection)
Starts to relay media streams across channels.
|
abstract int |
startRtmpStreamWithoutTranscodingEx(java.lang.String url,
RtcConnection connection)
Publishes the local stream without transcoding to a specified CDN live RTMP address.
|
abstract int |
startRtmpStreamWithTranscodingEx(java.lang.String url,
LiveTranscoding transcoding,
RtcConnection connection)
Publishes the local stream with transcoding to a specified CDN live RTMP address.
|
abstract int |
stopChannelMediaRelayEx(RtcConnection connection)
Stops the media stream relay.
|
abstract int |
stopRtmpStreamEx(java.lang.String url,
RtcConnection connection)
Stop an RTMP stream with transcoding or without transcoding from the CDN.
|
abstract int |
takeSnapshotEx(RtcConnection connection,
int uid,
java.lang.String filePath) |
abstract int |
updateChannelMediaOptionsEx(ChannelMediaOptions options,
RtcConnection connection)
Updates the media options after joining the channel with specified connection.
|
abstract int |
updateChannelMediaRelayEx(ChannelMediaRelayConfiguration channelMediaRelayConfiguration,
RtcConnection connection)
Updates the channels for media stream relay
|
abstract int |
updateRtmpTranscodingEx(LiveTranscoding transcoding,
RtcConnection connection)
Update the video layout and audio settings for CDN live.
|
addHandler, addVideoWatermark, addVideoWatermark, adjustAudioMixingPlayoutVolume, adjustAudioMixingPublishVolume, adjustAudioMixingVolume, adjustCustomAudioPlayoutVolume, adjustCustomAudioPublishVolume, adjustPlaybackSignalVolume, adjustRecordingSignalVolume, adjustUserPlaybackSignalVolume, clearVideoWatermarks, complain, configRhythmPlayer, create, create, createCustomEncodedVideoTrack, createCustomVideoTrack, createDataStream, createDataStream, createMediaPlayer, CreateRendererView, CreateTextureView, destroy, destroyCustomEncodedVideoTrack, destroyCustomVideoTrack, disableAudio, disableAudioSpectrumMonitor, disableVideo, enableAudio, enableAudioQualityIndication, enableAudioSpectrumMonitor, enableAudioVolumeIndication, enableContentInspect, enableCustomAudioLocalPlayback, enableDualStreamMode, enableDualStreamMode, enableEchoCancellationExternal, enableEncryption, enableExtension, enableExtension, enableExtension, enableExternalAudioSourceLocalPlayback, enableFaceDetection, enableHighPerfWifiMode, enableInEarMonitoring, enableInEarMonitoring, enableLocalAudio, enableLocalVideo, enableRemoteSuperResolution, enableSoundPositionIndication, enableSpatialAudio, enableVideo, enableVideoImageSource, enableVirtualBackground, enableWebSdkInteroperability, enableWirelessAccelerate, getAudioDeviceInfo, getAudioEffectManager, getAudioMixingCurrentPosition, getAudioMixingDuration, getAudioMixingPlayoutVolume, getAudioMixingPublishVolume, getAudioOptionParams, getAudioSessionParams, getAudioTrackCount, getCallId, getCameraMaxZoomFactor, getConnectionState, getCurrentMonotonicTimeInMs, getEffectCurrentPosition, getEffectDuration, getEffectsVolume, getErrorDescription, getExtensionProperty, getExtensionProperty, getExtensionProperty, getMediaEngineVersion, getMediaPlayerCacheManager, getNativeHandle, getNativeMediaPlayer, getNetworkType, getNtpTimeInMs, getParameter, getParameters, getRecommendedEncoderType, getSdkVersion, getUserInfoByUid, getUserInfoByUserAccount, getVolumeOfEffect, isCameraAutoFocusFaceModeSupported, isCameraExposurePositionSupported, isCameraFaceDetectSupported, isCameraFocusSupported, isCameraTorchSupported, isCameraZoomSupported, isSpeakerphoneEnabled, isTextureEncodeSupported, joinChannel, joinChannel, joinChannelWithUserAccount, joinChannelWithUserAccount, leaveChannel, leaveChannel, loadExtensionProvider, monitorBluetoothHeadsetEvent, monitorHeadsetEvent, muteAllRemoteAudioStreams, muteAllRemoteVideoStreams, muteLocalAudioStream, muteLocalVideoStream, muteRecordingSignal, muteRemoteAudioStream, muteRemoteVideoStream, pauseAllChannelMediaRelay, pauseAllEffects, pauseAudio, pauseAudioMixing, pauseEffect, playAllEffects, playEffect, playEffect, preloadEffect, preloadEffect, pullPlaybackAudioFrame, pullPlaybackAudioFrame, pushCaptureAudioFrame, pushCaptureAudioFrame, pushDirectAudioFrame, pushExternalAudioFrame, pushExternalAudioFrame, pushExternalEncodedVideoFrame, pushExternalVideoFrame, pushExternalVideoFrame, pushReverseAudioFrame, pushReverseAudioFrame, queryCodecCapability, rate, registerAudioEncodedFrameObserver, registerAudioFrameObserver, registerAudioSpectrumObserver, registerLocalUserAccount, registerMediaMetadataObserver, registerVideoEncodedFrameObserver, registerVideoFrameObserver, removeHandler, renewToken, resumeAllChannelMediaRelay, resumeAllEffects, resumeAudio, resumeAudioMixing, resumeEffect, selectAudioTrack, sendCustomReportMessage, sendStreamMessage, SetAdvancedAudioOptions, setAudioEffectParameters, setAudioEffectPreset, setAudioMixingDualMonoMode, setAudioMixingPitch, setAudioMixingPosition, setAudioOptionParams, setAudioProfile, setAudioProfile, setAudioScenario, setAudioSessionParams, setAVSyncSource, setBeautyEffectOptions, setCameraAutoFocusFaceModeEnabled, setCameraCapturerConfiguration, setCameraExposurePosition, setCameraFocusPositionInPreview, setCameraTorchOn, setCameraZoomFactor, setChannelProfile, setClientRole, setClientRole, setCloudProxy, setColorEnhanceOptions, setDefaultAudioRoutetoSpeakerphone, setDefaultMuteAllRemoteAudioStreams, setDefaultMuteAllRemoteVideoStreams, setDirectCdnStreamingAudioConfiguration, setDirectCdnStreamingVideoConfiguration, setDirectExternalAudioSource, setDirectExternalAudioSource, setDualStreamMode, setDualStreamMode, setEarMonitoringAudioFrameParameters, setEffectPosition, setEffectsVolume, setEnableSpeakerphone, setEncryptionMode, setEncryptionSecret, setExtensionProperty, setExtensionProperty, setExtensionProperty, setExtensionProviderProperty, setExternalAudioSink, setExternalAudioSource, setExternalAudioSource, setExternalVideoSource, setExternalVideoSource, setHeadphoneEQParameters, setHeadphoneEQPreset, setHighQualityAudioParameters, setInEarMonitoringVolume, setLocalAccessPoint, setLocalPublishFallbackOption, setLocalRenderMode, setLocalRenderMode, setLocalVideoMirrorMode, setLocalVoiceEqualization, setLocalVoicePitch, setLocalVoiceReverb, setLogFile, setLogFileSize, setLogFilter, setLogLevel, setLowlightEnhanceOptions, setMixedAudioFrameParameters, setParameters, setPlaybackAudioFrameBeforeMixingParameters, setPlaybackAudioFrameParameters, setPreferHeadset, setRecordingAudioFrameParameters, setRemoteDefaultVideoStreamType, setRemoteRenderMode, setRemoteRenderMode, setRemoteSubscribeFallbackOption, setRemoteUserPriority, setRemoteUserSpatialAudioParams, setRemoteVideoStreamType, setRemoteVideoSubscriptionOptions, setRemoteVoicePosition, setSubscribeAudioBlacklist, setSubscribeAudioWhitelist, setSubscribeVideoBlacklist, setSubscribeVideoWhitelist, setupLocalVideo, setupRemoteVideo, setVideoDenoiserOptions, setVideoEncoderConfiguration, setVideoProfile, setVideoQualityParameters, setVoiceBeautifierParameters, setVoiceBeautifierPreset, setVoiceConversionParameters, setVoiceConversionPreset, setVolumeOfEffect, startAudioMixing, startAudioMixing, startAudioRecording, startAudioRecording, startChannelMediaRelay, startDirectCdnStreaming, startEchoTest, startEchoTest, startEchoTest, startLastmileProbeTest, startPreview, startPreview, startRecordingDeviceTest, startRhythmPlayer, startRtmpStreamWithoutTranscoding, startRtmpStreamWithTranscoding, startScreenCapture, startSecondaryCameraCapture, stopAllEffects, stopAudioMixing, stopAudioRecording, stopChannelMediaRelay, stopDirectCdnStreaming, stopEchoTest, stopEffect, stopLastmileProbeTest, stopPreview, stopPreview, stopRecordingDeviceTest, stopRhythmPlayer, stopRtmpStream, stopScreenCapture, stopSecondaryCameraCapture, switchCamera, takeSnapshot, unloadAllEffects, unloadEffect, unRegisterAudioSpectrumObserver, unregisterMediaMetadataObserver, updateChannelMediaOptions, updateChannelMediaRelay, updateDirectCdnStreamingMediaOptions, updateRtmpTranscoding, updateScreenCaptureParameters, uploadLogFile, useExternalAudioDevice
public abstract int muteLocalAudioStreamEx(boolean muted, RtcConnection connection)
mute
- Determines whether to send or stop sending the local audio stream:
- true: Stop sending the local audio stream.
- false: Send the local audio stream.connection
- RtcConnection
is used to control different connection instances.public abstract int muteLocalVideoStreamEx(boolean muted, RtcConnection connection)
mute
- Determines whether to send or stop sending the local video stream:
- true: Stop sending the local video stream.
- false: Send the local video stream.connection
- RtcConnection
is used to control different connection instances.public abstract int muteAllRemoteAudioStreamsEx(boolean muted, RtcConnection connection)
mute
- Whether to stop receiving remote audio streams:
- true: Stop receiving any remote audio stream.
- false: Resume receiving all remote audio streams.connection
- RtcConnection
is used to control different connection instances.public abstract int muteAllRemoteVideoStreamsEx(boolean muted, RtcConnection connection)
mute
- Whether to stop receiving remote audio streams:
- true: Stop receiving any remote audio stream.
- false: Resume receiving all remote audio streams.connection
- RtcConnection
is used to control different connection instances.public abstract int muteRemoteAudioStreamEx(int uid, boolean muted, RtcConnection connection)
uid
- ID of the specified remote user.mute
- Determines whether to receive or stop receiving the specified audio stream:
- true: Stop receiving the specified audio stream.
- false: (Default) Receive the specified audio stream.connection
- RtcConnection
is used to control different connection instances.public abstract int muteRemoteVideoStreamEx(int uid, boolean muted, RtcConnection connection)
uid
- ID of the specified remote user.muted
- Determines whether to receive or stop receiving a specified video stream:
- true: Stop receiving the specified video stream.
- false: (Default) Receive the specified video stream.connection
- RtcConnection
is used to control different connection instances.public abstract int setRemoteVideoStreamTypeEx(int uid, int streamType, RtcConnection connection)
uid
- ID of the remote user sending the video stream.streamType
- Sets the video stream type:
- 0: High-stream video.
- 1: Low-stream video.connection
- RtcConnection
is used to control different connection instances.public abstract int setSubscribeAudioBlacklistEx(int[] uidList, RtcConnection connection)
uidList
- The id list of users who do not subscribe to audio.connection
- RtcConnection
is used to control different connection instances.public abstract int setSubscribeAudioWhitelistEx(int[] uidList, RtcConnection connection)
uidList
- The id list of users who do subscribe to audio.connection
- RtcConnection
is used to control different connection instances.public abstract int setSubscribeVideoBlacklistEx(int[] uidList, RtcConnection connection)
uidList
- The id list of users who do not subscribe to video.connection
- RtcConnection
is used to control different connection instances.public abstract int setSubscribeVideoWhitelistEx(int[] uidList, RtcConnection connection)
uidList
- The id list of users who do subscribe to video.connection
- RtcConnection
is used to control different connection instances.public abstract int setRemoteRenderModeEx(int uid, int renderMode, int mirrorMode, RtcConnection connection)
uid
- ID of the remote user.renderMode
- Sets the remote display mode:
- `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 the disparity in the aspect ratio will be
filled with black.mirrorMode
- Sets the remote video mirror mode:
- `VIDEO_MIRROR_MODE_ENABLED(1)`: Enable the mirror mode.
- `VIDEO_MIRROR_MODE_DISABLED(2)`: Disable the mirror mode.connection
- RtcConnection
is used to control different connection instances.public abstract int setupRemoteVideoEx(VideoCanvas remote, RtcConnection connection)
onUserJoined
callback.
To unbind the remote user from the view, set `view` in VideoCanvas as `null`.remote
- The remote video view settings: VideoCanvas
.connection
- RtcConnection
is used to control different connection instances.public abstract int setVideoEncoderConfigurationEx(VideoEncoderConfiguration config, RtcConnection connection)
config
- The local video encoder configuration: VideoEncoderConfiguration.connection
- RtcConnection
is used to control different connection instances.public abstract int updateChannelMediaOptionsEx(ChannelMediaOptions options, RtcConnection connection)
options
- The channel media options: ChannelMediaOptions.connection
- RtcConnection
is used to control different connection instances.public abstract int joinChannelEx(java.lang.String token, RtcConnection connection, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler)
token
- The token for authentication:
- In situations not requiring high security: You can use the temporary token
generated at Console. For details, see [Get a temporary
token](https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#temptoken).
- In situations requiring high security: Set it as the token generated at your
server. For details, see [Get a
token](https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#generatetoken).connection
- RtcConnection
is used to control different connection instances
* when you join the same channel multiple timesoptions
- The channel media options: ChannelMediaOptions.eventHandler
- The pointer to the IRtcEngine event handler: IRtcEngineEventHandler.public abstract int leaveChannelEx(RtcConnection connection)
connection
- RtcConnection
is used to control different connection instances
* when you join the same channel multiple timespublic abstract int pushExternalVideoFrameEx(VideoFrame frame, int videoTrackId)
frame
- The external video frame: VideoFrame
.videoTrackId
- The id of the video track.public abstract int pushExternalVideoFrameEx(AgoraVideoFrame frame, int videoTrackId)
frame
- The external video frame: ExternalVideoFrame
.videoTrackId
- The id of the video track.public abstract int enableDualStreamModeEx(boolean enabled, SimulcastStreamConfig streamConfig, RtcConnection connection)
setRemoteVideoStreamType
.enabled
- - true: Enable the dual-stream mode.
- false: (default) Disable the dual-stream mode.streamConfig
- - The minor stream configconnection
- - An output parameter which is used to control different connection instances.public abstract int setDualStreamModeEx(Constants.SimulcastStreamMode mode, SimulcastStreamConfig streamConfig, RtcConnection connection)
setRemoteVideoStreamType
.mode
- - The dual-stream modestreamConfig
- - The minor stream configpublic abstract int pushExternalEncodedVideoFrameEx(java.nio.ByteBuffer data, EncodedVideoFrameInfo frameInfo, int videoTrackId)
data
- The encoded external video data, which must be the direct buffer.frameInfo
- The encoded external video frame info: EncodedVideoFrameInfo
.videoTrackId
- The id of the video track.public abstract int getConnectionStateEx(RtcConnection connection)
connection
- RtcConnection
is used to control different connection instances.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
joined a channel and is connected to Agora's edge server. You can now publish or subscribe to a
media stream in the channel.
- 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
join the channel.public abstract int sendCustomReportMessageEx(java.lang.String id, java.lang.String category, java.lang.String event, java.lang.String label, int value, RtcConnection connection)
id
- Custom Event IDcategory
- Custom Event categoryevent
- Custom Event to reportlabel
- Custom Event labelvalue
- Custom Event valueconnection
- The connection ID.public abstract int sendStreamMessageEx(int streamId, byte[] message, RtcConnection connection)
streamId
- Stream IDmessage
- Data to be sent.connection
- Connection ID.public abstract int createDataStreamEx(boolean reliable, boolean ordered, RtcConnection connection)
reliable
- - True: The recipients will receive data from the sender
within 5 seconds. If the recipient does not receive the sent
data within 5 seconds, the data channel will report an error
to the application.
- False: The recipients will not receive any data, and it
will not report any error upon data missing.ordered
- - True: The recipients will receive data in the order of the sender.
- False: The recipients will not receive data in the order of the sender.public abstract int createDataStreamEx(DataStreamConfig config, RtcConnection connection)
config
- The config of data stream.Error Codes
. For example, if it returns -2, then it
indicates ERR_INVALID_ARGUMENT(-2)
in Error Codes
.public abstract int joinChannelWithUserAccountEx(java.lang.String token, java.lang.String channelId, java.lang.String userAccount, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler)
token
- The token generated at your server:
- For low-security requirements: You can use the temporary token generated at Console. For
details, see [Get a temporary
toke](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-temporary-token).
- For high-security requirements: Set it as the token generated at your server. For details,
see [Get a token](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-token).channelId
- The channel name. The maximum length of this parameter is 64 bytes. Supported
character scopes are:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- The space character.
- Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+",
"-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".userAccount
- The user account. The maximum length of this parameter is 255 bytes. Ensure
that you set this parameter and do not set it as null. Supported character scopes are:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- The space character.
- Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+",
"-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".options
- The channel media options: \ref
agora::rtc::ChannelMediaOptions::ChannelMediaOptions "ChannelMediaOptions"public abstract int getUserInfoByUserAccountEx(java.lang.String userAccount, UserInfo userInfo, RtcConnection connection)
userAccount
- The user account of the user. Ensure that you set this parameter.userInfo
- A userInfo object that identifies the userconnection
- RtcConnection
is used to control different connection instances.public abstract int getUserInfoByUidEx(int uid, UserInfo userInfo, RtcConnection connection)
uid
- The user ID of the remote user. Ensure that you set this parameter.userInfo
- A userInfo object that identifies the userconnection
- RtcConnection
is used to control different connection instances.public abstract int setRemoteVoicePositionEx(int uid, double pan, double gain, RtcConnection connection)
uid
- The ID of the remote user.pan
- The sound position of the remote user. The value ranges from -1.0 to 1.0:
- 0.0: the remote sound comes from the front.
- -1.0: the remote sound comes from the left.
- 1.0: the remote sound comes from the right.gain
- Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is
100.0 (the original gain of the remote user). The smaller the value, the less the gain.connection
- RtcConnection
is used to control different connection instances.public abstract int setRemoteVideoSubscriptionOptionsEx(int uid, VideoSubscriptionOptions options, RtcConnection rtcConnection)
public abstract int setRemoteUserSpatialAudioParamsEx(int uid, SpatialAudioParams params, RtcConnection connection)
uid
- The ID of the remote user.azimuth
- elevation
- distance
- connection
- RtcConnection
is used to control different connection instances.public abstract int addVideoWatermarkEx(java.lang.String watermarkUrl, WatermarkOptions options, RtcConnection connection)
watermarkUrl
- The local file path of the watermark image to be added. This method
supports adding a watermark image from either the local file path or the assets file path.
If you use the assets file path, you need to start with `/assets/` when filling in this
parameter.options
- The options of the watermark image to be added. See Watermark Options
.connection
- RtcConnection
is used to control different connection instances.addVideoWatermark
1.
This method adds a PNG watermark image to the local video stream in a live streaming. Once the
watermark image is added, all the audience in the channel (CDN audience included), and the
sampling device can see and capture it.
Agora supports adding only one watermark image onto the local video, and the newly watermark
image replaces the previous one.
The watermark position depends on the settings in the setVideoEncoderConfiguration
method:
- If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_LANDSCAPE, or the
landscape mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation.
- If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_PORTRAIT, or the
portrait mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation.
- When setting the watermark position, the region must be less than the dimensions set in the
setVideoEncoderConfiguration method. Otherwise, the watermark image will be cropped.public abstract int clearVideoWatermarkEx(RtcConnection connection)
addVideoWatermarkEx
.connection
- RtcConnection
is used to control different connection instances.public abstract int enableAudioVolumeIndicationEx(int interval, int smooth, boolean reportVad, RtcConnection connection)
onAudioVolumeIndication
callback is enabled, the SDK returns the volume indication in the at the time interval set
in `enableAudioVolumeIndication`, regardless of whether any user is speaking in the channel.interval
- Sets the time interval between two consecutive volume indications:
- <= 0: Disables the volume indication.
- > 0: Time interval (ms) between two consecutive volume indications,
and should be integral multiple of 200 (less than 200 will be set to 200).smooth
- The smoothing factor that sets the sensitivity of the audio volume
indicator. The value ranges is [0, 10]. The greater the value, the more sensitive the
indicator. The recommended value is 3.connection
- RtcConnection
is used to control different connection instances.public abstract int takeSnapshotEx(RtcConnection connection, int uid, java.lang.String filePath)
public abstract int startRtmpStreamWithoutTranscodingEx(java.lang.String url, RtcConnection connection)
url
- The CDN streaming URL in the RTMP format. The maximum length of this parameter is
1024 bytes.connection
- RtcConnection
is used to control different connection instances.public abstract int startRtmpStreamWithTranscodingEx(java.lang.String url, LiveTranscoding transcoding, RtcConnection connection)
url
- The CDN streaming URL in the RTMP format. The maximum length of this parameter is
1024 bytes.transcoding
- Sets the CDN live audio/video transcoding settings. See LiveTranscoding.connection
- RtcConnection
is used to control different connection instances.public abstract int updateRtmpTranscodingEx(LiveTranscoding transcoding, RtcConnection connection)
transcoding
- Sets the CDN live audio/video transcoding settings. See LiveTranscoding.connection
- RtcConnection
is used to control different connection instances.public abstract int stopRtmpStreamEx(java.lang.String url, RtcConnection connection)
url
- The RTMP URL address to be removed. The maximum length of this parameter is 1024
bytes.connection
- RtcConnection
is used to control different connection instances.public abstract int startChannelMediaRelayEx(ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection)
configuration
- The configuration of the media stream
relay:ChannelMediaRelayConfiguration.connection
- RtcConnection
is used to control different connection instances.public abstract int stopChannelMediaRelayEx(RtcConnection connection)
connection
- RtcConnection
is used to control different connection instances.public abstract int updateChannelMediaRelayEx(ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection)
configuration
- The media stream relay configuration: ChannelMediaRelayConfiguration.connection
- RtcConnection
is used to control different connection instances.public abstract int pauseAllChannelMediaRelayEx(RtcConnection connection)
connection
- RtcConnection
is used to control different connection instances.public abstract int resumeAllChannelMediaRelayEx(RtcConnection connection)
connection
- RtcConnection
is used to control different connection instances.