播放信息获取

GetDuration

获取媒体文件总时长。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetDuration(int64& duration);

参数

duration

输出参数。媒体文件总时长（毫秒）。

返回值

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

所属接口类

• IMediaPlayer

GetMediaPlayerId

获取播放器 ID。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetMediaPlayerId();

返回值

• 方法调用成功，返回播放器 ID。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMediaPlayer

GetMute

获取当前播放的媒体文件是否静音。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetMute(bool & muted);

参数

mute

输出参数。静音状态：

• true: 媒体文件已静音。
• false: 媒体文件未静音。

返回值

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

所属接口类

• IMediaPlayer

GetPlayoutVolume

获取当前本地播放音量。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPlayoutVolume(int & volume);

参数

volume

输出参数。本地播放音量，取值范围从 0 到 100：

• 0: 无声。
• 100: （默认）媒体文件的原始播放音量。

返回值

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

所属接口类

• IMediaPlayer

GetPlayPosition

获取当前播放进度。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPlayPosition(int64& pos);

参数

pos

媒体资源文件当前的播放位置，单位为毫秒。

返回值

• 方法调用成功，返回当前播放进度（毫秒）。
• < 0: 方法调用失败，详见 FENUMWRAP_MEDIA_PLAYER_REASON。

所属接口类

• IMediaPlayer

GetPlaySrc

获取播放的媒体资源的路径。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
FString GetPlaySrc();

返回值

播放的媒体资源的路径。

所属接口类

• IMediaPlayer

GetPublishSignalVolume

获取远端用户听到的音量。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetPublishSignalVolume(int & volume);

参数

volume

输出参数。播放文件的远端播放音量。

返回值

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

所属接口类

• IMediaPlayer

GetState

获取播放器当前状态。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
EMEDIA_PLAYER_STATE GetState();

返回值

播放器当前状态，详见 EMEDIA_PLAYER_STATE。

所属接口类

• IMediaPlayer

GetStreamCount

获取当前媒体文件中媒体流的数量。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetStreamCount(int64& count);

详情

注意

请在 Open 后并收到 OnPlayerSourceStateChanged 回调报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后再调用该方法。

参数

count

输出参数。当前媒体文件中媒体流的数量。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败，详见 FENUMWRAP_MEDIA_PLAYER_REASON。

所属接口类

• IMediaPlayer

GetStreamInfo

通过媒体流的索引值获取媒体流信息。

C++

UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetStreamInfo(int64 index, FPlayerStreamInfo& info);

调用时机

你需要在 GetStreamCount 后调用该方法。

调用限制

无。

参数

index

媒体流索引值。该参数需小于 GetStreamCount 的 count 参数。

info

输出参数。媒体流的所有信息，详见 FPlayerStreamInfo。

返回值

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

所属接口类

• IMediaPlayer

OnPlayerPlaybackStats

报告当前播放的媒体资源的相关信息。

C++

UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnPlayerPlaybackStats(const FPlayerPlaybackStats& stats);

详情

当媒体资源开始播放后，SDK 会每秒触发一次该回调，报告媒体资源的相关信息。

参数

stats

媒体资源的相关信息，详见 FPlayerPlaybackStats。

所属接口类

• IMediaPlayerSourceObserver