文档中心
全部产品
API 参考
MediaPlayer Kit C++ API Reference
MediaPlayer Kit C++ API Reference
◆ ~IMediaPlayer()
virtual agora::rtc::IMediaPlayer::~IMediaPlayer |
( |
| ) |
|
|
inlinevirtual |
◆ initialize()
◆ open()
virtual int agora::rtc::IMediaPlayer::open |
( |
const char * |
src, |
|
|
int64_t |
startPos |
|
) |
| |
|
pure virtual |
打开媒体文件
- 参数
-
src | 设置媒体文件的路径:本地路径或网络路径 |
startPos | 设置起始播放位置(秒),默认值为 0 |
- 返回
-
◆ play()
virtual int agora::rtc::IMediaPlayer::play |
( |
| ) |
|
|
pure virtual |
播放媒体文件
打开媒体文件或暂停播放媒体文件后,你可以调用该方法播放媒体文件。
- 返回
-
◆ pause()
virtual int agora::rtc::IMediaPlayer::pause |
( |
| ) |
|
|
pure virtual |
暂停播放
如果你想恢复播放,请调用 play() 方法。
- 返回
-
◆ stop()
virtual int agora::rtc::IMediaPlayer::stop |
( |
| ) |
|
|
pure virtual |
◆ seek()
virtual int agora::rtc::IMediaPlayer::seek |
( |
int64_t |
pos | ) |
|
|
pure virtual |
◆ mute()
virtual int agora::rtc::IMediaPlayer::mute |
( |
bool |
mute | ) |
|
|
pure virtual |
◆ getMute()
virtual int agora::rtc::IMediaPlayer::getMute |
( |
bool & |
mute | ) |
|
|
pure virtual |
◆ adjustPlayoutVolume()
virtual int agora::rtc::IMediaPlayer::adjustPlayoutVolume |
( |
int |
volume | ) |
|
|
pure virtual |
调节本地播放音量
- 参数
-
volume | 本地播放音量,取值范围从 0 到 100:
- 0: 无声
- 100: (默认)媒体文件的原始播放音量
|
- 返回
-
◆ getPlayoutVolume()
virtual int agora::rtc::IMediaPlayer::getPlayoutVolume |
( |
int & |
volume | ) |
|
|
pure virtual |
获取当前本地播放音量
- 参数
-
[out] | volume | 本地播放音量,取值范围从 0 到 100:
- 0: 无声
- 100: (默认)媒体文件的原始播放音量
|
- 返回
-
◆ getPlayPosition()
virtual int agora::rtc::IMediaPlayer::getPlayPosition |
( |
int64_t & |
pos | ) |
|
|
pure virtual |
◆ getDuration()
virtual int agora::rtc::IMediaPlayer::getDuration |
( |
int64_t & |
duration | ) |
|
|
pure virtual |
◆ getState()
◆ getStreamCount()
virtual int agora::rtc::IMediaPlayer::getStreamCount |
( |
int & |
count | ) |
|
|
pure virtual |
◆ getStreamInfo()
◆ setView()
设置播放器渲染视图
- 参数
-
view | 渲染视图,Windows 平台为窗口句柄(HWND) |
- 返回
-
◆ setRenderMode()
设置播放器视图的渲染模式
- 参数
-
renderMode | 播放器视图的渲染模式:
RENDER_MODE_HIDDEN (1) : 视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉。
RENDER_MODE_FIT (2) : 视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充黑色。
|
- 返回
-
◆ registerPlayerObserver()
◆ unregisterPlayerObserver()
◆ registerVideoFrameObserver()
◆ unregisterVideoFrameObserver()
◆ registerAudioFrameObserver()
◆ unregisterAudioFrameObserver()
◆ setLogFile()
virtual int agora::rtc::IMediaPlayer::setLogFile |
( |
const char * |
filePath | ) |
|
|
pure virtual |
设置日志文件
MediaPlayer Kit 运行时产生的 log 都写入日志文件,调用该方法可以设置日志文件的存储路径。 请确保你指定的日志文件路径存在且可写。如果不调用该方法,日志文件会存储至默认路径。
- 注解
- 请在调用 initialize() 后立即调用该方法,否则日志文件中的 log 可能不完整。
- 参数
-
filePath | 日志文件的完整路径。该日志文件为 UTF-8 编码。 |
- 返回
-
◆ setLogFilter()
virtual int agora::rtc::IMediaPlayer::setLogFilter |
( |
unsigned int |
filter | ) |
|
|
pure virtual |
设置输出日志的过滤等级
设置 MediaPlayer Kit 的输出日志的过滤等级。过滤等级从低到高分别为 OFF,DEBUG,INFO,WARN,ERROR, CRITICAL。选择一个过滤等级,你就可以看到在该等级之前的所有等级的日志信息,详见 filter
参数描述。
- 参数
-
filter | 设置日志过滤等级:
LOG_FILTER_OFF (0) : 不输出任何日志。
LOG_FILTER_DEBUG (0x80f) : 输出所有的日志。
LOG_FILTER_INFO (0x0f) : (推荐取值)输出 INFO,WARN,ERROR,CRITICAL 等级的日志。
LOG_FILTER_WARN (0x0e) : 输出 WARN,ERROR,CRITICAL 等级的日志。
LOG_FILTER_ERROR (0x0c) : 输出 ERROR,CRITICAL 等级的日志。
LOG_FILTER_CRITICAL (0x08) : 输出 CRITICAL 等级的日志。
|
- 返回
-
◆ changePlaybackSpeed()
调节播放速度
请在 play() 后调用该方法。
- 参数
-
- 返回
-
◆ selectAudioTrack()
virtual int agora::rtc::IMediaPlayer::selectAudioTrack |
( |
int |
index | ) |
|
|
pure virtual |
设置使用的音轨
如果媒体资源含有多个音轨,你可以调用该方法设置你想使用的音轨。
- 参数
-
- 返回
-
◆ release()
virtual void agora::rtc::IMediaPlayer::release |
( |
bool |
sync = true | ) |
|
|
pure virtual |