文档中心
服务端网关
API 参考
服务端网关 SDK Java API 参考
|
| AgoraLocalUser (long cptr) |
|
native void | setUserRole (int role) |
|
native int | getUserRole () |
|
native int | setAudioEncoderConfig (AudioEncoderConfig config) |
|
native int | publishAudio (AgoraLocalAudioTrack agora_local_audio_track) |
|
native int | unpublishAudio (AgoraLocalAudioTrack agora_local_audio_track) |
|
native int | publishVideo (AgoraLocalVideoTrack agora_local_video_track) |
|
native int | unpublishVideo (AgoraLocalVideoTrack agora_local_video_track) |
|
native int | subscribeAudio (String user_id) |
|
native int | subscribeAllAudio () |
|
native int | unsubscribeAudio (String user_id) |
|
native int | unsubscribeAllAudio () |
|
native int | setPlaybackAudioFrameParameters (int channels, int sample_rate_hz, int mode, int samples_per_call) |
|
native int | setRecordingAudioFrameParameters (int channels, int sample_rate_hz, int mode, int samples_per_call) |
|
native int | setMixedAudioFrameParameters (int channels, int sample_rate_hz, int mode, int samples_per_call) |
|
native int | setPlaybackAudioFrameBeforeMixingParameters (int channels, int sample_rate_hz) |
|
native int | registerAudioFrameObserver (IAudioFrameObserver observer) |
|
native int | unregisterAudioFrameObserver () |
|
native int | subscribeVideo (String user_id, VideoSubscriptionOptions options) |
|
native int | subscribeAllVideo (VideoSubscriptionOptions options) |
|
native int | unsubscribeVideo (String user_id) |
|
native int | unsubscribeAllVideo () |
|
native int | setAudioVolumeIndicationParameters (int interval_in_ms, int smooth, boolean report_vad) |
|
native int | registerObserver (ILocalUserObserver observer) |
|
native int | unregisterObserver () |
|
native int | sendIntraRequest (String uid) |
|
◆ AgoraLocalUser()
io.agora.rtc.AgoraLocalUser.AgoraLocalUser |
( |
long |
cptr | ) |
|
◆ getUserRole()
native int io.agora.rtc.AgoraLocalUser.getUserRole |
( |
| ) |
|
◆ publishAudio()
发布本地音频轨道至频道。
发布音频轨道时,SDK 默认会将所有音频轨道进行混音。
- 参数
-
agora_local_audio_track | 待发布的本地音频轨道。 |
- 返回
-
◆ publishVideo()
发布本地视频轨道至频道。
- 参数
-
agora_local_video_track | 待发布的本地视频轨道。 |
- 返回
-
◆ registerAudioFrameObserver()
native int io.agora.rtc.AgoraLocalUser.registerAudioFrameObserver |
( |
IAudioFrameObserver |
observer | ) |
|
注册音频数据观测器。
你需要在该方法中实现一个 IAudioFrameObserver
类,并根据具体场景需求,注册以下回调:
onRecordAudioFrame
: 当 SDK 接收到本地录音设备采集的音频数据时,会触发该回调。
onPlaybackAudioFrame
: 当 SDK 接收到远端发送过来用于播放的的音频数据时,会触发该回调。
onPlaybackAudioFrameBeforeMixing
: 当 SDK 接收到远端指定用户发送过来尚未混音的音频数据时,会触发该回调。
onMixedAudioFrame
: 当 SDK 接收到本地采集的和用于播放的混音后的音频数据时,会触发该回调。
- 参数
-
observer | 音频数据观测器:IAudioFrameObserver。 |
- 返回
-
◆ registerObserver()
注册本地用户观测器。
你需要在该方法中实现一个 ILocalUserObserver
类。完成注册后,ILocalUserObserver
会接收 AgoraLocalUser
对象的回调事件。
- 参数
-
observer | ILocalUserObserver 对象。 |
- 返回
-
◆ sendIntraRequest()
native int io.agora.rtc.AgoraLocalUser.sendIntraRequest |
( |
String |
uid | ) |
|
向指定主播发送关键帧请求。
你成功发送请求后,主播会收到 onIntraRequestReceived
回调。
- 参数
-
- 返回
-
◆ setAudioEncoderConfig()
配置音频编码属性。
完成配置后,SDK 会将音频编码属性应用到所有音频轨道。
- 参数
-
config | 音频编码属性 AudioEncoderConfig。 |
- 返回
-
◆ setAudioVolumeIndicationParameters()
native int io.agora.rtc.AgoraLocalUser.setAudioVolumeIndicationParameters |
( |
int |
interval_in_ms, |
|
|
int |
smooth, |
|
|
boolean |
report_vad |
|
) |
| |
◆ setMixedAudioFrameParameters()
native int io.agora.rtc.AgoraLocalUser.setMixedAudioFrameParameters |
( |
int |
channels, |
|
|
int |
sample_rate_hz, |
|
|
int |
mode, |
|
|
int |
samples_per_call |
|
) |
| |
设置 onMixedAudioFrame
回调中返回的音频数据的参数。
- 参数
-
channels | onMixedAudioFrame 回调中音频数据的声道数。
|
sample_rate_hz | onMixedAudioFrame 中音频数据的采样率(Hz)。可设为 8000, 16000, 32000, 44100, 或 48000。 |
mode | onMixedAudioFrame 中音频数据的使用模式:
- 0: 只读模式,即仅读取回调中的 AudioFrame 音频数据,而不进行修改。
- 1: 只写模式,即使用自己的数据代替回调中的 AudioFrame 音频数据。例如,如果你希望使用自己采集的音频数据时,可以使用该模式。
- 2: 读写模式,即读取回调中的 AudioFrame 音频数据,对其进行修改,然后播放。例如,如果你希望应用自己的音频处理模块,进行音频后处理,达到变声的效果,可以设置该模式。
|
samples_per_call | onMixedAudioFram 回调中的采样点数。在 RTMP 或 RTMPS 推流场景中,将该值设为 1024。 |
- 返回
-
◆ setPlaybackAudioFrameBeforeMixingParameters()
native int io.agora.rtc.AgoraLocalUser.setPlaybackAudioFrameBeforeMixingParameters |
( |
int |
channels, |
|
|
int |
sample_rate_hz |
|
) |
| |
设置 onPlaybackAudioFrameBeforeMixing 回调中返回的音频数据的参数。
- 参数
-
channels | onPlaybackAudioFrameBeforeMixing 回调中音频数据的声道数。
|
sample_rate_hz | onPlaybackAudioFrameBeforeMixing 中音频数据的采样率(Hz)。可设为 8000、16000、32000、44100 或 48000。 |
- 返回
-
◆ setPlaybackAudioFrameParameters()
native int io.agora.rtc.AgoraLocalUser.setPlaybackAudioFrameParameters |
( |
int |
channels, |
|
|
int |
sample_rate_hz, |
|
|
int |
mode, |
|
|
int |
samples_per_call |
|
) |
| |
设置 onPlaybackAudioFrame
回调中返回的音频数据的参数。
- 参数
-
channels | onPlaybackAudioFrame 回调中音频数据的声道数。
|
sample_rate_hz | onPlaybackAudioFrame 中音频数据的采样率(Hz)。可设为 8000, 16000, 32000, 44100, 或 48000。 |
mode | onPlaybackAudioFrame 中音频数据的使用模式:
- 0: 只读模式,即仅读取回调中的 AudioFrame 音频数据,而不进行修改。
- 1: 只写模式,即使用自己的数据代替回调中的 AudioFrame 音频数据。例如,如果你希望使用自己采集的音频数据时,可以使用该模式。
- 2: 读写模式,即读取回调中的 AudioFrame 音频数据,对其进行修改,然后播放。例如,如果你希望应用自己的音频处理模块,进行音频后处理,达到变声的效果,可以设置该模式。
|
samples_per_call | onPlaybackAudioFram 回调中的采样点数。在 RTMP 或 RTMPS 推流场景中,将该值设为 1024。 |
- 返回
-
◆ setRecordingAudioFrameParameters()
native int io.agora.rtc.AgoraLocalUser.setRecordingAudioFrameParameters |
( |
int |
channels, |
|
|
int |
sample_rate_hz, |
|
|
int |
mode, |
|
|
int |
samples_per_call |
|
) |
| |
设置 onRecordAudioFrame
回调中返回的音频数据的参数。
- 参数
-
channels | onPlaybackAudioFrame 回调中音频数据的声道数。
|
sample_rate_hz | onRecordAudioFrame 中音频数据的采样率(Hz)。可设为 8000, 16000, 32000, 44100, 或 48000。 |
mode | onRecordAudioFrame 中音频数据的使用模式:
- 0: 只读模式,即仅读取回调中的 AudioFrame 音频数据,而不进行修改。
- 1: 只写模式,即使用自己的数据代替回调中的 AudioFrame 音频数据。例如,如果你希望使用自己采集的音频数据时,可以使用该模式。
- 2: 读写模式,即读取回调中的 AudioFrame 音频数据,对其进行修改,然后播放。例如,如果你希望应用自己的音频处理模块,进行音频后处理,达到变声的效果,可以设置该模式。
|
samples_per_call | onRecordAudioFram 回调中的采样点数。在 RTMP 或 RTMPS 推流场景中,将该值设为 1024。 |
- 返回
-
◆ setUserRole()
native void io.agora.rtc.AgoraLocalUser.setUserRole |
( |
int |
role | ) |
|
设置用户角色。
在加入频道前后,你都可以调用该方法:
- 加入频道前调用,可以设置用户角色为发流者(主播)或收流者(观众)。
- 加入频道后调用,可以切换用户角色为发流者或收流者。
你可以通过 onChangeRoleSuccess
或 onChangeRoleFailure
获取该方法的调用结果。
- 注解
- 调用
connect
加入频道时,如果填入的 token
与你在该方法中设置的 role
不匹配,则加入 频道失败,SDK 触发 onConnectionFailure
回调。
- 参数
-
◆ subscribeAllAudio()
native int io.agora.rtc.AgoraLocalUser.subscribeAllAudio |
( |
| ) |
|
订阅频道内所有用户的音频。
成功调用该方法后,SDK 自动订阅在调用该方法后加入频道的用户的音频。
- 返回
-
◆ subscribeAllVideo()
订阅频道中所有用户的视频。
成功调用该方法后,SDK 自动订阅在调用该方法后加入频道的用户的视频。
- 参数
-
options | 视频订阅选项:VideoSubscriptionOptions。 |
- 返回
-
◆ subscribeAudio()
native int io.agora.rtc.AgoraLocalUser.subscribeAudio |
( |
String |
user_id | ) |
|
◆ subscribeVideo()
订阅远端指定用户的视频。
- 参数
-
user_id | 带订阅视频的远端用户的 ID。 |
options | 视频订阅选项:VideoSubscriptionOptions,例如,仅订阅编码后的视频数据,或仅订阅视频小流。 |
- 返回
-
◆ unpublishAudio()
native int io.agora.rtc.AgoraLocalUser.unpublishAudio |
( |
AgoraLocalAudioTrack |
agora_local_audio_track | ) |
|
停止向频道内发布本地音频轨道。
- 参数
-
agora_local_audio_track | 待停止发布的本地音频轨道。 |
- 返回
-
◆ unpublishVideo()
native int io.agora.rtc.AgoraLocalUser.unpublishVideo |
( |
AgoraLocalVideoTrack |
agora_local_video_track | ) |
|
停止发布本地视频轨道至频道。
- 参数
-
agora_local_video_track | 待停止发布的本地视频轨道。 |
- 返回
-
◆ unregisterAudioFrameObserver()
native int io.agora.rtc.AgoraLocalUser.unregisterAudioFrameObserver |
( |
| ) |
|
释放音频数据观测器。
- 参数
-
observer | 音频数据观测器:IAudioFrameObserver。 |
- 返回
-
◆ unregisterObserver()
native int io.agora.rtc.AgoraLocalUser.unregisterObserver |
( |
| ) |
|
释放本地用户观测器 ILocalUserObserver
对象。
- 参数
-
observer | ILocalUserObserver 对象。 |
- 返回
-
◆ unsubscribeAllAudio()
native int io.agora.rtc.AgoraLocalUser.unsubscribeAllAudio |
( |
| ) |
|
停止订阅频道内所有远端音频。
成功调用该方法后,如未再调用 subscribeAudio
或 subscribeAllAudio
,SDK 自动停止订阅在调用该方法后加入频道的用户的音频。
- 返回
-
◆ unsubscribeAllVideo()
native int io.agora.rtc.AgoraLocalUser.unsubscribeAllVideo |
( |
| ) |
|
停止订阅频道内所有用户的视频。
成功调用该方法后,除非再调用 subscribeVideo
或 subscribeAllVideo
,否则 SDK 自动停止订阅在调用该方法后加入频道的用户视频。
- 返回
-
◆ unsubscribeAudio()
native int io.agora.rtc.AgoraLocalUser.unsubscribeAudio |
( |
String |
user_id | ) |
|
◆ unsubscribeVideo()
native int io.agora.rtc.AgoraLocalUser.unsubscribeVideo |
( |
String |
user_id | ) |
|
该类的文档由以下文件生成: