播放器控制
- Flutter
更新时间不可用
adjustPlayoutVolume
调节本地播放音量。
Future<void> adjustPlayoutVolume(int volume);调用时机
加入频道前后均可调用。
参数
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
adjustPublishSignalVolume
调节远端用户听到的音量。
Future<void> adjustPublishSignalVolume(int volume);连接到声网服务器后,你可以调用该方法,调节远端用户听到的媒体文件的音量。
调用时机
加入频道前后均可调用。
参数
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
mute
设置是否静音。
Future<void> mute(bool muted);调用时机
该方法在加入频道前后均可调用。
参数
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
pause
暂停播放。
Future<void> pause();调用时机
该方法在加入频道前后均可调用。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
play
播放媒体文件。
Future<void> play();调用时机
- 在调用 open 或 openWithMediaSource 打开媒体文件、且收到 onPlayerSourceStateChanged 回调报告状态为 playerStateOpenCompleted 后,调用该方法。
- 在调用 seek 后调用该方法。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
playPreloadedSrc
播放预加载的媒体资源。
Future<void> playPreloadedSrc(String src);调用 preloadSrc 方法将媒体资源预加载到播放列表后,可以调用该方法播放已预加载的媒体资源。调用该方法后,如果你收到 onPlayerSourceStateChanged 回调报告状态 playerStatePlaying,则表示播放成功。
如果你想更换播放的预加载媒体资源,你可以再次调用该方法并指定新的媒体资源路径。如果你想重新播放媒体资源,你需要在播放前调用 preloadSrc 重新将该媒体资源预加载到播放列表。如果你想清空播放列表,请调用 stop。
注: 如果你在播放暂停时调用该方法,该方法会在恢复播放后才生效。
参数
| 参数名 | 描述 |
|---|---|
src | 播放列表中的媒体资源 URL 地址,必须与 preloadSrc 方法设置的 |
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
resume
暂停后恢复播放。
Future<void> resume();返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
seek
定位到媒体文件的指定播放位置。
Future<void> seek(int newPos);- 如果你在播放已经完成后(收到 onPlayerSourceStateChanged 回调报告播放状态为 playerStatePlaybackCompleted 或 playerStatePlaybackAllLoopsCompleted)再调用 seek,方法调用成功后,SDK 会从你指定的位置开始自动播放,此时你会收到 onPlayerSourceStateChanged 回调报告播放状态为 playerStatePlaying。
- 如果你在播放暂停的情况下调用 seek,调用成功后 SDK 会定位到你指定位置,如需播放,请调用 resume 或 play。
调用时机
该方法在加入频道前后均可调用。
相关回调
成功调用该方法后,你会收到 onPlayerEvent 回调,报告当前播放器发生的事件,如定位开始、定位成功或定位失败。
参数
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
stop
停止播放。
Future<void> stop();调用该方法停止播放后,如需重新播放,需要调用 open 或 openWithMediaSource 再次打开媒体资源。
调用时机
该方法需要在 play 之后调用。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。