播放器控制

  • C++

更新时间不可用

adjustPlayoutVolume

调整本地播放音量。

C++
virtual int adjustPlayoutVolume(int volume) = 0;

调用时机

该方法可以在加入频道前或加入频道后调用。

参数

参数名描述
volume

本地播放音量,取值范围为 0 到 100。0 表示静音,100(默认)表示原始音量。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

adjustPublishSignalVolume

调节用于发布的媒体文件音量。

C++
virtual int adjustPublishSignalVolume(int volume) = 0;

调用时机

该方法可以在加入频道前或后调用。

参数

参数名描述
volume

音量,范围为 0 到 400:

  • 0:静音。
  • 100:(默认)原始音量。
  • 400:原始音量的四倍(将音频信号放大四倍)。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

mute

设置是否将媒体文件静音。

C++
virtual int mute(bool muted) = 0;

调用时机

你可以在加入频道前或加入频道后调用该方法。

参数

参数名描述
muted

是否将媒体文件静音:

  • true:静音媒体文件。
  • false:(默认)取消静音媒体文件。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

pause

暂停播放。

C++
virtual int pause() = 0;

调用时机

你可以在加入频道前或加入频道后调用该方法。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

play

播放媒体文件。

C++
virtual int play() = 0;

调用时机

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

playPreloadedSrc

播放预加载的媒体资源。

C++
virtual int playPreloadedSrc(const char* src) = 0;

调用 preloadSrc 将媒体资源预加载到播放列表后,可以调用该方法播放该资源。调用成功后,如果收到 onPlayerSourceStateChanged 回调并报告 PLAYER_STATE_PLAYING 状态,表示播放成功。

如果你想更换要播放的预加载媒体资源,可以再次调用该方法并传入新的媒体资源 URL。若想重新播放该媒体资源,需要先调用 preloadSrc 重新预加载资源。

如需清空播放列表,请调用 stop 方法。

注: 如果在播放暂停时调用该方法,该方法在播放恢复之前不会生效。

参数

参数名描述
src

播放列表中媒体资源的 URL,必须与通过 preloadSrc 设置的 src 保持一致,否则无法播放该媒体资源。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

resume

恢复播放媒体文件。

C++
virtual int resume() = 0;

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

seek

跳转到新的播放位置。

C++
virtual int seek(int64_t newPos) = 0;

如果在播放完成后调用 seek(即收到回调 onPlayerSourceStateChanged 报告播放状态为 PLAYER_STATE_PLAYBACK_COMPLETED 或 PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED),SDK 会从指定位置重新开始播放媒体文件,并触发 onPlayerSourceStateChanged 回调,报告播放状态为 PLAYER_STATE_PLAYING。 如果在播放暂停时调用 seek,调用成功后,SDK 会跳转到指定位置。要恢复播放,请调用 resume 或 play。

调用时机

你可以在加入频道前或后调用该方法。

相关回调

成功调用该方法后,SDK 会触发 onPlayerEvent 回调,报告跳转到新播放位置的结果。

参数

参数名描述
newPos

新的播放位置,单位为毫秒。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

stop

停止播放媒体轨道。

C++
virtual int stop() = 0;

调用该方法停止播放后,如需再次播放,需要调用 open 或 openWithMediaSource 重新打开媒体资源。

调用时机

在播放后调用该方法。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onSeek

定位媒体资源数据时触发的回调。

C++
virtual int64_t onSeek(int64_t offset, int whence) = 0;

该回调在调用 openWithMediaSource 或 open 打开自定义媒体资源时触发,用于请求媒体资源中指定位置的数据。

参数

参数名描述
offset

目标位置相对于起始点的偏移量,单位为字节。该值可以为正数或负数。

whence

起始点,可设置为以下值之一:

  • 0:起始点为数据开头,定位后的实际数据偏移量为 offset。
  • 1:起始点为当前位置,定位后的实际数据偏移量为当前位置加 offset。
  • 2:起始点为数据末尾,定位后的实际数据偏移量为整个数据长度加 offset。
  • 65536:不执行定位操作,返回文件大小。建议在播放 MP3、WAV 等纯音频文件时使用该值。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • whence 为 65536 时,返回媒体文件大小。
  • whence 为 0、1 或 2 时,返回定位后的实际数据偏移量。
  • -1:定位失败。

所属接口类