public class AgoraRtcConn
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
(package private) class |
AgoraRtcConn.InternalCapabilitesObserver
Internal capabilities observer.
|
| Modifier and Type | Field and Description |
|---|---|
private AgoraParameter |
agoraParameter |
private AgoraService |
agoraService |
private AgoraAudioEncodedFrameSender |
audioEncodedFrameSender |
private AudioFrame |
audioFrame |
private AgoraAudioPcmDataSender |
audioFrameSender |
private ICapabilitesObserver |
capabilitiesObserver |
private long |
cptr |
private AgoraLocalAudioTrack |
customAudioTrack |
private AgoraVideoEncodedImageSender |
customEncodedImageSender |
private AgoraLocalVideoTrack |
customVideoTrack |
private int |
dataStreamId |
private AgoraLocalUser |
localUser |
private AgoraMediaNodeFactory |
mediaNodeFactory |
private INetworkObserver |
networkObserver |
private PcmConsumeStateUtils |
pcmConsumeStateUtils |
private IRtcConnObserver |
rtcConnObserver |
private RtcConnPublishConfig |
rtcConnPublishConfig |
private AgoraVideoFrameSender |
videoFrameSender |
| Constructor and Description |
|---|
AgoraRtcConn(long cptr)
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
int |
adjustLocalAudioTrackPublishVolume(int volume)
Adjusts the publish volume of the local audio track.
|
int |
connect(java.lang.String token,
java.lang.String channelId,
java.lang.String userId)
Connects to a channel
|
(package private) int |
createDataStream(Out streamId,
int reliable,
int ordered)
Creates data stream
|
void |
destroy()
Destroys the RtcConnection instance
|
void |
destroyConnInfo(RtcConnInfo info)
Destroys connection information object
|
void |
destroyLocalAudioTrackStats(LocalAudioTrackStats stats)
Destroys the provided LocalAudioTrackStats object.
|
void |
destroyLocalVideoTrackStatistics(LocalVideoTrackStats stats)
Destroys the provided LocalVideoTrackStats object.
|
void |
destroyTransportStats(RtcStats stats)
Destroys transport statistics object
|
void |
destroyUserInfo(UserInfo info)
Destroys user information object
|
int |
disconnect()
Disconnects from current channel
|
int |
enableEncryption(int enabled,
EncryptionConfig config)
Enables/disables encryption
|
int |
enableLocalAudioTrackEarMonitor(int enable,
int includeAudiFilter)
Enables or disables ear monitoring.
|
int |
enableLocalAudioTrackPlayback(int enable)
Enables or disables local playback of the audio track.
|
int |
enableSimulcastStream(int enabled,
SimulcastStreamConfig config)
Enables or disables the simulcast stream.
|
AgoraParameter |
getAgoraParameter()
Gets Agora parameter object
|
int |
getConnId()
Gets connection ID
|
RtcConnInfo |
getConnInfo()
Gets connection information
|
int |
getCurrentAudioScenario()
Gets the current audio scenario.
|
int |
getLocalAudioTrackPublishVolume(Out volume)
Gets the current publish volume of the local audio track.
|
int |
getLocalAudioTrackState()
Gets the current state of the local audio track.
|
LocalAudioTrackStats |
getLocalAudioTrackStats()
Retrieves the statistics of the local audio track.
|
AgoraLocalUser |
getLocalUser()
Gets local user object
|
int |
getLocalVideoTrackState()
Gets the current state of the local audio track.
|
LocalVideoTrackStats |
getLocalVideoTrackStatistics()
Retrieves the statistics of the local video track.
|
RtcStats |
getTransportStats()
Gets transport statistics
|
UserInfo |
getUserInfo(java.lang.String userId)
Gets user information by user ID
|
AccountInfo |
getUserInfoByUid(java.lang.String userId)
Gets user information by UID
|
AccountInfo |
getUserInfoByUserAccount(java.lang.String userAccount)
Gets user information by user account
|
private void |
initDataStream() |
(package private) int |
initRtcConn(AgoraService agoraService,
AgoraMediaNodeFactory mediaNodeFactory,
RtcConnPublishConfig rtcConnPublishConfig)
Initializes the RTC connection.
|
int |
interruptAudio()
Interrupts the audio track.
|
boolean |
isPushToRtcCompleted() |
private int |
nativeConnect(long cptr,
java.lang.String token,
java.lang.String channelId,
java.lang.String userId) |
private int |
nativeCreateDataStream(long cptr,
Out streamId,
int reliable,
int ordered) |
private void |
nativeDestroy(long cptr) |
private void |
nativeDestroyConnInfo(long cptr,
RtcConnInfo info) |
private void |
nativeDestroyTransportStats(long cptr,
RtcStats stats) |
private void |
nativeDestroyUserInfo(long cptr,
UserInfo info) |
private int |
nativeDisconnect(long cptr) |
private int |
nativeEnableEncryption(long cptr,
int enabled,
EncryptionConfig config) |
private AgoraParameter |
nativeGetAgoraParameter(long cptr) |
private int |
nativeGetConnId(long cptr) |
private RtcConnInfo |
nativeGetConnInfo(long cptr) |
private AgoraLocalUser |
nativeGetLocalUser(long cptr) |
private RtcStats |
nativeGetTransportStats(long cptr) |
private UserInfo |
nativeGetUserInfo(long cptr,
java.lang.String userId) |
private AccountInfo |
nativeGetUserInfoByUid(long cptr,
java.lang.String userId) |
private AccountInfo |
nativeGetUserInfoByUserAccount(long cptr,
java.lang.String userAccount) |
private int |
nativeRegisterNetworkObserver(long cptr,
INetworkObserver observer) |
private int |
nativeRegisterObserver(long cptr,
IRtcConnObserver observer) |
private int |
nativeRenewToken(long cptr,
java.lang.String token) |
private int |
nativeSendCustomReportMessage(long cptr,
java.lang.String id,
java.lang.String category,
java.lang.String event,
java.lang.String label,
int value) |
private int |
nativeSendStreamMessage(long cptr,
int streamId,
byte[] messageData) |
private int |
nativeStartLastmileProbeTest(long cptr,
LastmileProbeConfig config) |
private int |
nativeStopLastmileProbeTest(long cptr) |
private int |
nativeUnregisterNetworkObserver(long cptr) |
private int |
nativeUnregisterObserver(long cptr) |
int |
publishAudio()
Publishes the audio track.
|
int |
publishVideo()
Publishes the video track.
|
int |
pushAudioEncodedData(byte[] data,
EncodedAudioFrameInfo info)
Pushes audio encoded data.
|
int |
pushAudioPcmData(byte[] data,
int sampleRate,
int channels)
Pushes audio PCM data.
|
int |
pushAudioPcmData(byte[] data,
int sampleRate,
int channels,
long presentationMs)
Pushes audio PCM data.
|
int |
pushVideoEncodedData(byte[] data,
EncodedVideoFrameInfo info)
Pushes video encoded data.
|
int |
pushVideoFrame(ExternalVideoFrame frame)
Pushes video frame.
|
int |
registerAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
Registers an audio encoded frame observer.
|
int |
registerAudioFrameObserver(IAudioFrameObserver observer,
boolean enableVad,
AgoraAudioVadConfigV2 vadConfig)
Registers an audio frame observer with VAD (Voice Activity Detection)
enabled.
|
int |
registerLocalUserObserver(ILocalUserObserver observer)
Registers a local user observer.
|
int |
registerNetworkObserver(INetworkObserver observer)
Registers a network observer
|
int |
registerObserver(IRtcConnObserver observer)
Registers an RTC connection observer
|
int |
registerVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
Registers a video encoded frame observer.
|
int |
registerVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
Registers a video frame observer.
|
int |
renewToken(java.lang.String token)
Renews the token
|
int |
sendAudioMetaData(byte[] metaData)
Sends audio metadata.
|
int |
sendCustomReportMessage(java.lang.String id,
java.lang.String category,
java.lang.String event,
java.lang.String label,
int value)
Sends custom report message
|
int |
sendStreamMessage(byte[] messageData)
Sends data stream message
|
int |
setVideoEncoderConfig(VideoEncoderConfig config)
Sets the video encoder configuration.
|
int |
startLastmileProbeTest(LastmileProbeConfig config)
Starts last-mile network probe test
|
int |
stopLastmileProbeTest()
Stops last-mile network probe test
|
int |
unpublishAudio()
Unpublishes the audio track.
|
int |
unpublishVideo()
Unpublishes the video track.
|
(package private) int |
unregisterNetworkObserver()
Unregisters the network observer
|
(package private) int |
unregisterObserver()
Unregisters the RTC connection observer
|
int |
updateAudioSenario(int scenario)
Updates the audio scenario.
|
private long cptr
private AgoraService agoraService
private AgoraMediaNodeFactory mediaNodeFactory
private RtcConnPublishConfig rtcConnPublishConfig
private AgoraLocalUser localUser
private AgoraParameter agoraParameter
private volatile AgoraAudioPcmDataSender audioFrameSender
private volatile AgoraAudioEncodedFrameSender audioEncodedFrameSender
private volatile AgoraLocalAudioTrack customAudioTrack
private volatile AgoraVideoFrameSender videoFrameSender
private volatile AgoraVideoEncodedImageSender customEncodedImageSender
private volatile AgoraLocalVideoTrack customVideoTrack
private IRtcConnObserver rtcConnObserver
private INetworkObserver networkObserver
private ICapabilitesObserver capabilitiesObserver
private AudioFrame audioFrame
private int dataStreamId
private PcmConsumeStateUtils pcmConsumeStateUtils
AgoraRtcConn(long cptr)
cptr - Native pointerint initRtcConn(AgoraService agoraService, AgoraMediaNodeFactory mediaNodeFactory, RtcConnPublishConfig rtcConnPublishConfig)
agoraService - The Agora service.mediaNodeFactory - The media node factory.rtcConnPublishConfig - The RTC connection publish configuration.private void initDataStream()
public int getCurrentAudioScenario()
public void destroy()
public int registerObserver(IRtcConnObserver observer)
observer - The observer to registerint unregisterObserver()
public int registerNetworkObserver(INetworkObserver observer)
observer - The observer to registerint unregisterNetworkObserver()
public int registerAudioFrameObserver(IAudioFrameObserver observer, boolean enableVad, AgoraAudioVadConfigV2 vadConfig)
observer - The audio frame observer to register.enableVad - Whether to enable VAD.vadConfig - The VAD configuration.public int registerAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
observer - The audio encoded frame observer to register.public int registerLocalUserObserver(ILocalUserObserver observer)
observer - The local user observer to register.public int registerVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
agoraVideoFrameObserver2 - The video frame observer to register.public int registerVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
agoraVideoEncodedFrameObserver - The video encoded frame observer to
register.public int publishAudio()
public int unpublishAudio()
public int publishVideo()
public int unpublishVideo()
public int interruptAudio()
public int pushAudioPcmData(byte[] data,
int sampleRate,
int channels,
long presentationMs)
data - The audio data.sampleRate - The sample rate.channels - The number of channels.presentationMs - The presentation timestamp.and it can pass to
onPlaybackBeforeMixing's audioframe.presentationMspublic int pushAudioPcmData(byte[] data,
int sampleRate,
int channels)
data - The audio data.sampleRate - The sample rate.channels - The number of channels.public int pushAudioEncodedData(byte[] data,
EncodedAudioFrameInfo info)
data - The audio data.info - The audio frame info.public int pushVideoFrame(ExternalVideoFrame frame)
frame - The video frame.public int pushVideoEncodedData(byte[] data,
EncodedVideoFrameInfo info)
data - The video data.info - The video frame info.public int updateAudioSenario(int scenario)
scenario - The audio scenario.public int sendStreamMessage(byte[] messageData)
messageData - Message content in bytespublic int connect(java.lang.String token,
java.lang.String channelId,
java.lang.String userId)
token - Authentication tokenchannelId - Channel ID to joinuserId - User IDpublic int disconnect()
public int startLastmileProbeTest(LastmileProbeConfig config)
config - Configuration for the probe testpublic int stopLastmileProbeTest()
public int renewToken(java.lang.String token)
token - New token to usepublic RtcConnInfo getConnInfo()
public void destroyConnInfo(RtcConnInfo info)
info - RtcConnInfo object to destroypublic AgoraLocalUser getLocalUser()
public UserInfo getUserInfo(java.lang.String userId)
userId - User ID to querypublic AccountInfo getUserInfoByUserAccount(java.lang.String userAccount)
userAccount - User account to querypublic AccountInfo getUserInfoByUid(java.lang.String userId)
userId - User ID to querypublic void destroyUserInfo(UserInfo info)
info - UserInfo object to destroypublic int getConnId()
public RtcStats getTransportStats()
public void destroyTransportStats(RtcStats stats)
stats - RtcStats object to destroypublic AgoraParameter getAgoraParameter()
int createDataStream(Out streamId, int reliable, int ordered)
streamId - Output parameter to receive stream IDreliable - Whether the stream is reliableordered - Whether the stream is orderedpublic int enableEncryption(int enabled,
EncryptionConfig config)
enabled - Whether to enable encryption (1: Enable, 0: Disable)config - Encryption configurationpublic int sendCustomReportMessage(java.lang.String id,
java.lang.String category,
java.lang.String event,
java.lang.String label,
int value)
id - Report IDcategory - Report categoryevent - Report eventlabel - Report labelvalue - Report valuepublic int setVideoEncoderConfig(VideoEncoderConfig config)
config - The video encoder configuration to set.public int enableSimulcastStream(int enabled,
SimulcastStreamConfig config)
enabled - 1 to enable, 0 to disable.config - The simulcast stream configuration.public int getLocalVideoTrackState()
public LocalVideoTrackStats getLocalVideoTrackStatistics()
public void destroyLocalVideoTrackStatistics(LocalVideoTrackStats stats)
stats - The LocalVideoTrackStats object to be destroyed.public int getLocalAudioTrackState()
public LocalAudioTrackStats getLocalAudioTrackStats()
public void destroyLocalAudioTrackStats(LocalAudioTrackStats stats)
stats - The LocalAudioTrackStats object to be destroyed.public int adjustLocalAudioTrackPublishVolume(int volume)
volume - The volume level to set.public int getLocalAudioTrackPublishVolume(Out volume)
volume - An Out object to store the volume level.public int enableLocalAudioTrackPlayback(int enable)
enable - 1 to enable, 0 to disable.public int enableLocalAudioTrackEarMonitor(int enable,
int includeAudiFilter)
enable - 1 to enable, 0 to disable.includeAudiFilter - 1 to include audio filter, 0 to exclude.public int sendAudioMetaData(byte[] metaData)
metaData - The audio metadata to send.public boolean isPushToRtcCompleted()
private void nativeDestroy(long cptr)
private int nativeRegisterObserver(long cptr,
IRtcConnObserver observer)
private int nativeUnregisterObserver(long cptr)
private int nativeRegisterNetworkObserver(long cptr,
INetworkObserver observer)
private int nativeUnregisterNetworkObserver(long cptr)
private int nativeSendStreamMessage(long cptr,
int streamId,
byte[] messageData)
private int nativeConnect(long cptr,
java.lang.String token,
java.lang.String channelId,
java.lang.String userId)
private int nativeDisconnect(long cptr)
private int nativeStartLastmileProbeTest(long cptr,
LastmileProbeConfig config)
private int nativeStopLastmileProbeTest(long cptr)
private int nativeRenewToken(long cptr,
java.lang.String token)
private RtcConnInfo nativeGetConnInfo(long cptr)
private void nativeDestroyConnInfo(long cptr,
RtcConnInfo info)
private AgoraLocalUser nativeGetLocalUser(long cptr)
private UserInfo nativeGetUserInfo(long cptr, java.lang.String userId)
private AccountInfo nativeGetUserInfoByUserAccount(long cptr, java.lang.String userAccount)
private AccountInfo nativeGetUserInfoByUid(long cptr, java.lang.String userId)
private void nativeDestroyUserInfo(long cptr,
UserInfo info)
private int nativeGetConnId(long cptr)
private RtcStats nativeGetTransportStats(long cptr)
private void nativeDestroyTransportStats(long cptr,
RtcStats stats)
private AgoraParameter nativeGetAgoraParameter(long cptr)
private int nativeCreateDataStream(long cptr,
Out streamId,
int reliable,
int ordered)
private int nativeEnableEncryption(long cptr,
int enabled,
EncryptionConfig config)
private int nativeSendCustomReportMessage(long cptr,
java.lang.String id,
java.lang.String category,
java.lang.String event,
java.lang.String label,
int value)