public class AgoraLocalUser
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
private AgoraAudioFrameObserverWrapper |
agoraAudioFrameObserver |
private AgoraVideoEncodedFrameObserver |
agoraVideoEncodedFrameObserver |
private AgoraVideoFrameObserver2 |
agoraVideoFrameObserver2 |
private IAudioEncodedFrameObserver |
audioEncodedFrameObserver |
private ICapabilitesObserver |
capabilitesObserver |
private long |
cptr |
private java.util.concurrent.atomic.AtomicBoolean |
isPublishedAudio |
private java.util.concurrent.atomic.AtomicBoolean |
isPublishedVideo |
private ILocalUserObserver |
localUserObserver |
| Constructor and Description |
|---|
AgoraLocalUser(long cptr) |
| Modifier and Type | Method and Description |
|---|---|
int |
adjustPlaybackSignalVolume(int volume)
Adjusts the playback signal volume.
|
(package private) void |
destroy()
Destroys the AgoraLocalUser instance and unregisters all observers.
|
void |
destroyLocalAudioStatistics(LocalAudioDetailedStats stats)
Destroys the local audio statistics.
|
LocalAudioDetailedStats |
getLocalAudioStatistics()
Gets the local audio statistics.
|
AgoraMediaCtrlPacketSender |
getMediaControlPacketSender()
Gets the media control packet sender.
|
int |
getPlaybackSignalVolume(Out volume)
Gets the playback signal volume.
|
int |
getUserRole()
Gets the user role.
|
private int |
nativeAdjustPlaybackSignalVolume(long cptr,
int volume) |
private int |
nativeDestroy(long cptr) |
private void |
nativeDestroyLocalAudioStatistics(long cptr,
LocalAudioDetailedStats stats) |
private LocalAudioDetailedStats |
nativeGetLocalAudioStatistics(long cptr) |
private AgoraMediaCtrlPacketSender |
nativeGetMediaControlPacketSender(long cptr) |
private int |
nativeGetPlaybackSignalVolume(long cptr,
Out volume) |
private int |
nativeGetUserRole(long cptr) |
private int |
nativePublishAudio(long cptr,
AgoraLocalAudioTrack agoraLocalAudioTrack) |
private int |
nativePublishVideo(long cptr,
AgoraLocalVideoTrack agoraLocalVideoTrack) |
private int |
nativeRegisterAudioEncodedFrameObserver(long cptr,
IAudioEncodedFrameObserver observer) |
private int |
nativeRegisterAudioFrameObserver(long cptr,
AgoraAudioFrameObserverWrapper observer) |
private int |
nativeRegisterCapabilitesObserver(long cptr,
ICapabilitesObserver observer) |
private int |
nativeRegisterMediaControlPacketReceiver(long cptr,
AgoraMediaPacketReceiver agoraMediaPacketReceiver) |
private int |
nativeRegisterObserver(long cptr,
ILocalUserObserver observer) |
private int |
nativeRegisterVideoEncodedFrameObserver(long cptr,
AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver) |
private int |
nativeRegisterVideoFrameObserver(long cptr,
AgoraVideoFrameObserver2 agoraVideoFrameObserver2) |
private int |
nativeSendAudioMetaData(long cptr,
byte[] metaData) |
private int |
nativeSendIntraRequest(long cptr,
java.lang.String userId) |
private int |
nativeSetAudioEncoderConfig(long cptr,
AudioEncoderConfig config) |
private int |
nativeSetAudioScenario(long cptr,
int scenarioType) |
private int |
nativeSetAudioVolumeIndicationParameters(long cptr,
int intervalInMs,
int smooth,
boolean reportVad) |
private int |
nativeSetMixedAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int samplesPerCall) |
private int |
nativeSetPlaybackAudioFrameBeforeMixingParameters(long cptr,
int channels,
int sampleRateHz) |
private int |
nativeSetPlaybackAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int mode,
int samplesPerCall) |
private int |
nativeSetRecordingAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int mode,
int samplesPerCall) |
private int |
nativeSetUserRole(long cptr,
int role) |
private int |
nativeSubscribeAllAudio(long cptr) |
private int |
nativeSubscribeAllVideo(long cptr,
VideoSubscriptionOptions options) |
private int |
nativeSubscribeAudio(long cptr,
java.lang.String userId) |
private int |
nativeSubscribeVideo(long cptr,
java.lang.String userId,
VideoSubscriptionOptions options) |
private int |
nativeUnpublishAudio(long cptr,
AgoraLocalAudioTrack agoraLocalAudioTrack) |
private int |
nativeUnpublishVideo(long cptr,
AgoraLocalVideoTrack agoraLocalVideoTrack) |
private int |
nativeUnregisterAudioEncodedFrameObserver(long cptr,
IAudioEncodedFrameObserver observer) |
private int |
nativeUnregisterAudioFrameObserver(long cptr) |
private int |
nativeUnregisterCapabilitesObserver(long cptr,
ICapabilitesObserver observer) |
private int |
nativeUnregisterMediaControlPacketReceiver(long cptr,
AgoraMediaPacketReceiver agoraMediaPacketReceiver) |
private int |
nativeUnregisterObserver(long cptr) |
private int |
nativeUnregisterVideoEncodedFrameObserver(long cptr,
AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver) |
private int |
nativeUnregisterVideoFrameObserver(long cptr,
AgoraVideoFrameObserver2 agoraVideoFrameObserver2) |
private int |
nativeUnsubscribeAllAudio(long cptr) |
private int |
nativeUnsubscribeAllVideo(long cptr) |
private int |
nativeUnsubscribeAudio(long cptr,
java.lang.String userId) |
private int |
nativeUnsubscribeVideo(long cptr,
java.lang.String userId) |
int |
publishAudio(AgoraLocalAudioTrack agoraLocalAudioTrack)
Publishes the local audio track.
|
int |
publishVideo(AgoraLocalVideoTrack agoraLocalVideoTrack)
Publishes the local video track.
|
(package private) int |
registerAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
Registers an audio encoded frame observer.
|
(package private) int |
registerAudioFrameObserver(IAudioFrameObserver observer)
Registers an audio frame observer.
|
(package private) int |
registerAudioFrameObserver(IAudioFrameObserver observer,
boolean enableVad,
AgoraAudioVadConfigV2 vadConfig)
Registers an audio frame observer with VAD (Voice Activity Detection)
enabled.
|
(package private) int |
registerCapabilitesObserver(ICapabilitesObserver observer)
Registers a capabilities observer.
|
int |
registerMediaControlPacketReceiver(AgoraMediaPacketReceiver agoraMediaPacketReceiver)
Registers a media control packet receiver.
|
(package private) int |
registerObserver(ILocalUserObserver observer)
Registers a local user observer.
|
(package private) int |
registerVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
Registers a video encoded frame observer.
|
(package private) int |
registerVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
Registers a video frame observer.
|
(package private) int |
sendAudioMetaData(byte[] metaData)
Sends audio metadata.
|
int |
sendIntraRequest(java.lang.String userId)
Sends an intra request to a specified user.
|
int |
setAudioEncoderConfig(AudioEncoderConfig config)
Sets the audio encoder configuration.
|
int |
setAudioScenario(int scenarioType)
Sets the audio scenario.
|
int |
setAudioVolumeIndicationParameters(int intervalInMs,
int smooth,
boolean reportVad)
Sets the audio volume indication parameters.
|
int |
setMixedAudioFrameParameters(int channels,
int sampleRateHz,
int samplesPerCall)
Sets the mixed audio frame parameters.
|
int |
setPlaybackAudioFrameBeforeMixingParameters(int channels,
int sampleRateHz)
Sets the playback audio frame parameters before mixing.
|
int |
setPlaybackAudioFrameParameters(int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
Sets the playback audio frame parameters.
|
int |
setRecordingAudioFrameParameters(int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
Sets the recording audio frame parameters.
|
void |
setUserRole(int role)
Sets the user role.
|
int |
subscribeAllAudio()
Subscribes to the audio of all users.
|
int |
subscribeAllVideo(VideoSubscriptionOptions options)
Subscribes to the video of all users.
|
int |
subscribeAudio(java.lang.String userId)
Subscribes to the audio of a specified user.
|
int |
subscribeVideo(java.lang.String userId,
VideoSubscriptionOptions options)
Subscribes to the video of a specified user.
|
int |
unpublishAudio(AgoraLocalAudioTrack agoraLocalAudioTrack)
Unpublishes the local audio track.
|
int |
unpublishVideo(AgoraLocalVideoTrack agoraLocalVideoTrack)
Unpublishes the local video track.
|
(package private) int |
unregisterAllObservers()
Unregisters all observers.
|
(package private) int |
unregisterAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
Unregisters the audio encoded frame observer.
|
(package private) int |
unregisterAudioFrameObserver()
Unregisters the audio frame observer.
|
(package private) int |
unregisterCapabilitesObserver(ICapabilitesObserver observer)
Unregisters a capabilities observer.
|
int |
unregisterMediaControlPacketReceiver(AgoraMediaPacketReceiver agoraMediaPacketReceiver)
Unregisters the media control packet receiver.
|
(package private) int |
unregisterObserver()
Unregisters the local user observer.
|
(package private) int |
unregisterVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
Unregisters the video encoded frame observer.
|
(package private) int |
unregisterVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
Unregisters the video frame observer.
|
int |
unsubscribeAllAudio()
Unsubscribes from the audio of all users.
|
int |
unsubscribeAllVideo()
Unsubscribes from the video of all users.
|
int |
unsubscribeAudio(java.lang.String userId)
Unsubscribes from the audio of a specified user.
|
int |
unsubscribeVideo(java.lang.String userId)
Unsubscribes from the video of a specified user.
|
private long cptr
private AgoraAudioFrameObserverWrapper agoraAudioFrameObserver
private IAudioEncodedFrameObserver audioEncodedFrameObserver
private AgoraVideoFrameObserver2 agoraVideoFrameObserver2
private AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver
private ICapabilitesObserver capabilitesObserver
private volatile ILocalUserObserver localUserObserver
private final java.util.concurrent.atomic.AtomicBoolean isPublishedAudio
private final java.util.concurrent.atomic.AtomicBoolean isPublishedVideo
int unregisterAllObservers()
void destroy()
int registerAudioFrameObserver(IAudioFrameObserver observer)
observer - The audio frame observer to register.int registerAudioFrameObserver(IAudioFrameObserver observer, boolean enableVad, AgoraAudioVadConfigV2 vadConfig)
observer - The audio frame observer to register.enableVad - Whether to enable VAD.vadConfig - The VAD configuration.int unregisterAudioFrameObserver()
int registerAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
observer - The audio encoded frame observer to register.int unregisterAudioEncodedFrameObserver(IAudioEncodedFrameObserver observer)
observer - The audio encoded frame observer to unregister.int registerObserver(ILocalUserObserver observer)
observer - The local user observer to register.int unregisterObserver()
int registerVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
agoraVideoFrameObserver2 - The video frame observer to register.int unregisterVideoFrameObserver(AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
agoraVideoFrameObserver2 - The video frame observer to unregister.int registerVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
agoraVideoEncodedFrameObserver - The video encoded frame observer to
register.int unregisterVideoEncodedFrameObserver(AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
agoraVideoEncodedFrameObserver - The video encoded frame observer to
unregister.int registerCapabilitesObserver(ICapabilitesObserver observer)
observer - The capabilities observer to register.int unregisterCapabilitesObserver(ICapabilitesObserver observer)
observer - The capabilities observer to unregister.public void setUserRole(int role)
role - The user role to set.public int getUserRole()
public int setAudioEncoderConfig(AudioEncoderConfig config)
config - The audio encoder configuration to set.public LocalAudioDetailedStats getLocalAudioStatistics()
public void destroyLocalAudioStatistics(LocalAudioDetailedStats stats)
stats - The local audio statistics to destroy.public int publishAudio(AgoraLocalAudioTrack agoraLocalAudioTrack)
agoraLocalAudioTrack - The local audio track to publish.public int unpublishAudio(AgoraLocalAudioTrack agoraLocalAudioTrack)
agoraLocalAudioTrack - The local audio track to unpublish.public int publishVideo(AgoraLocalVideoTrack agoraLocalVideoTrack)
agoraLocalVideoTrack - The local video track to publish.public int unpublishVideo(AgoraLocalVideoTrack agoraLocalVideoTrack)
agoraLocalVideoTrack - The local video track to unpublish.public int subscribeAudio(java.lang.String userId)
userId - The user ID to subscribe to.public int subscribeAllAudio()
public int unsubscribeAudio(java.lang.String userId)
userId - The user ID to unsubscribe from.public int unsubscribeAllAudio()
public int adjustPlaybackSignalVolume(int volume)
volume - The volume to set.public int getPlaybackSignalVolume(Out volume)
volume - The output volume.public int setPlaybackAudioFrameParameters(int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
channels - The number of channels.sampleRateHz - The sample rate in Hz.mode - The mode.samplesPerCall - The number of samples per call.public int setRecordingAudioFrameParameters(int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
channels - The number of channels.sampleRateHz - The sample rate in Hz.mode - The mode.samplesPerCall - The number of samples per call.public int setMixedAudioFrameParameters(int channels,
int sampleRateHz,
int samplesPerCall)
channels - The number of channels.sampleRateHz - The sample rate in Hz.samplesPerCall - The number of samples per call.public int setPlaybackAudioFrameBeforeMixingParameters(int channels,
int sampleRateHz)
channels - The number of channels.sampleRateHz - The sample rate in Hz.public int subscribeVideo(java.lang.String userId,
VideoSubscriptionOptions options)
userId - The user ID to subscribe to.options - The video subscription options.public int subscribeAllVideo(VideoSubscriptionOptions options)
options - The video subscription options.public int unsubscribeVideo(java.lang.String userId)
userId - The user ID to unsubscribe from.public int unsubscribeAllVideo()
public int setAudioVolumeIndicationParameters(int intervalInMs,
int smooth,
boolean reportVad)
intervalInMs - The interval in milliseconds.smooth - The smoothness.reportVad - Whether to report VAD.public AgoraMediaCtrlPacketSender getMediaControlPacketSender()
public int registerMediaControlPacketReceiver(AgoraMediaPacketReceiver agoraMediaPacketReceiver)
agoraMediaPacketReceiver - The media control packet receiver to
register.public int unregisterMediaControlPacketReceiver(AgoraMediaPacketReceiver agoraMediaPacketReceiver)
agoraMediaPacketReceiver - The media control packet receiver to
unregister.public int sendIntraRequest(java.lang.String userId)
userId - The user ID to send the intra request to.public int setAudioScenario(int scenarioType)
scenarioType - The audio scenario type to set.int sendAudioMetaData(byte[] metaData)
metaData - The audio metadata to send.private int nativeDestroy(long cptr)
private int nativeRegisterAudioFrameObserver(long cptr,
AgoraAudioFrameObserverWrapper observer)
private int nativeUnregisterAudioFrameObserver(long cptr)
private int nativeRegisterAudioEncodedFrameObserver(long cptr,
IAudioEncodedFrameObserver observer)
private int nativeUnregisterAudioEncodedFrameObserver(long cptr,
IAudioEncodedFrameObserver observer)
private int nativeRegisterObserver(long cptr,
ILocalUserObserver observer)
private int nativeUnregisterObserver(long cptr)
private int nativeRegisterVideoFrameObserver(long cptr,
AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
private int nativeUnregisterVideoFrameObserver(long cptr,
AgoraVideoFrameObserver2 agoraVideoFrameObserver2)
private int nativeRegisterVideoEncodedFrameObserver(long cptr,
AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
private int nativeUnregisterVideoEncodedFrameObserver(long cptr,
AgoraVideoEncodedFrameObserver agoraVideoEncodedFrameObserver)
private int nativeRegisterCapabilitesObserver(long cptr,
ICapabilitesObserver observer)
private int nativeUnregisterCapabilitesObserver(long cptr,
ICapabilitesObserver observer)
private int nativeSetUserRole(long cptr,
int role)
private int nativeGetUserRole(long cptr)
private int nativeSetAudioEncoderConfig(long cptr,
AudioEncoderConfig config)
private LocalAudioDetailedStats nativeGetLocalAudioStatistics(long cptr)
private void nativeDestroyLocalAudioStatistics(long cptr,
LocalAudioDetailedStats stats)
private int nativePublishAudio(long cptr,
AgoraLocalAudioTrack agoraLocalAudioTrack)
private int nativeUnpublishAudio(long cptr,
AgoraLocalAudioTrack agoraLocalAudioTrack)
private int nativePublishVideo(long cptr,
AgoraLocalVideoTrack agoraLocalVideoTrack)
private int nativeUnpublishVideo(long cptr,
AgoraLocalVideoTrack agoraLocalVideoTrack)
private int nativeSubscribeAudio(long cptr,
java.lang.String userId)
private int nativeSubscribeAllAudio(long cptr)
private int nativeUnsubscribeAudio(long cptr,
java.lang.String userId)
private int nativeUnsubscribeAllAudio(long cptr)
private int nativeAdjustPlaybackSignalVolume(long cptr,
int volume)
private int nativeGetPlaybackSignalVolume(long cptr,
Out volume)
private int nativeSetPlaybackAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
private int nativeSetRecordingAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int mode,
int samplesPerCall)
private int nativeSetMixedAudioFrameParameters(long cptr,
int channels,
int sampleRateHz,
int samplesPerCall)
private int nativeSetPlaybackAudioFrameBeforeMixingParameters(long cptr,
int channels,
int sampleRateHz)
private int nativeSubscribeVideo(long cptr,
java.lang.String userId,
VideoSubscriptionOptions options)
private int nativeSubscribeAllVideo(long cptr,
VideoSubscriptionOptions options)
private int nativeUnsubscribeVideo(long cptr,
java.lang.String userId)
private int nativeUnsubscribeAllVideo(long cptr)
private int nativeSetAudioVolumeIndicationParameters(long cptr,
int intervalInMs,
int smooth,
boolean reportVad)
private AgoraMediaCtrlPacketSender nativeGetMediaControlPacketSender(long cptr)
private int nativeRegisterMediaControlPacketReceiver(long cptr,
AgoraMediaPacketReceiver agoraMediaPacketReceiver)
private int nativeUnregisterMediaControlPacketReceiver(long cptr,
AgoraMediaPacketReceiver agoraMediaPacketReceiver)
private int nativeSendIntraRequest(long cptr,
java.lang.String userId)
private int nativeSetAudioScenario(long cptr,
int scenarioType)
private int nativeSendAudioMetaData(long cptr,
byte[] metaData)