播放信息获取

cacheDir

获取缓存文件的储存路径。

Objective-C

- (NSString *)cacheDir;

详情

如果你在调用该方法前未曾调用 setCacheDir: 方法自定义缓存文件的储存路径，该方法返回的为 SDK 默认的缓存文件储存路径。

返回值

• 方法调用成功时，返回缓存文件的储存路径。
• < 0：方法调用失败，详见 AgoraMediaPlayerReason。

所属接口类

• AgoraRtcMediaPlayerCacheManagerProtocol

cacheFileCount

获取当前已缓存的媒体文件的总数量。

Objective-C

- (NSInteger)cacheFileCount;

返回值

• ≥ 0：方法调用成功，返回当前已缓存的媒体文件的总数量。
• < 0：方法调用失败，详见 AgoraMediaPlayerReason。

所属接口类

• AgoraRtcMediaPlayerCacheManagerProtocol

getDuration

获取媒体文件总时长。

Objective-C

- (NSInteger)getDuration;

返回值

• 方法调用成功时，返回媒体资源的总时长，单位毫秒。
• ≤ 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

maxCacheFileCount

获取所设置的缓存文件数量上限。

Objective-C

- (NSInteger)maxCacheFileCount;

详情

SDK 默认的缓存文件数量上限为 1000。

返回值

• > 0：方法调用成功，返回缓存文件数量的上限。
• < 0：方法调用失败，详见 AgoraMediaPlayerReason。

所属接口类

• AgoraRtcMediaPlayerCacheManagerProtocol

maxCacheFileSize

获取所设置的缓存文件总缓存的上限。

Objective-C

- (NSInteger)maxCacheFileSize;

详情

SDK 默认的缓存文件总缓存上限为 1GB。你可以调用 setMaxCacheFileSize: 方法自定义总缓存大小的上限。

返回值

• > 0：方法调用成功，返回缓存文件的总缓存上限，单位为字节。
• < 0：方法调用失败，详见 AgoraMediaPlayerReason。

所属接口类

• AgoraRtcMediaPlayerCacheManagerProtocol

getMediaPlayerId

获取播放器 ID。

Objective-C

- (int)getMediaPlayerId;

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

getMute

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

Objective-C

- (bool)getMute;

返回值

• YES：当前播放的媒体文件为静音。
• NO：当前播放的媒体文件没有静音。

所属接口类

• AgoraRtcMediaPlayerProtocol

getPlayoutVolume

获取当前本地播放音量。

Objective-C

- (int)getPlayoutVolume;

返回值

返回当前本地播放音量，取值范围从 0 到 100：

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

所属接口类

• AgoraRtcMediaPlayerProtocol

getPosition

获取当前播放进度。

Objective-C

- (NSInteger)getPosition;

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

getPlaySrc

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

Objective-C

- (NSString *)getPlaySrc;

返回值

播放的媒体资源的路径。

所属接口类

• AgoraRtcMediaPlayerProtocol

getPublishSignalVolume

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

Objective-C

- (int)getPublishSignalVolume;

返回值

• ≥ 0: 播放文件的远端播放音量。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

getPlayerState

获取播放器当前状态。

Objective-C

- (AgoraMediaPlayerState)getPlayerState;

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

getStreamCount

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

Objective-C

- (NSInteger)getStreamCount;

详情

注意

请在 open:startPos: 后并收到 AgoraRtcMediaPlayer:didChangedToState:reason: 回调报告播放状态为 AgoraMediaPlayerStateOpenCompleted 后再调用该方法。

返回值

• 方法调用成功，返回该媒体文件中媒体流的数量。
• < 0: 方法调用失败，详见 AgoraMediaPlayerReason。

所属接口类

• AgoraRtcMediaPlayerProtocol

getStreamByIndex:

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

Objective-C

- (AgoraMediaStreamInfo *_Nullable)getStreamByIndex:(int)index;

调用时机

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

调用限制

无。

参数

index

媒体流索引值。该参数的值需小于 getStreamCount 的返回值。

返回值

• 方法调用成功，返回媒体流信息，详见 AgoraRtcMediaStreamInfo。
• 方法调用失败，返回 nil。

所属接口类

• AgoraRtcMediaPlayerProtocol

AgoraRtcMediaPlayer:playbackStats:

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

Objective-C

(void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit playbackStats:(AgoraMediaPlayerPlaybackStats *_Nonnull)info NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:playbackStats:));

详情

自从

v4.3.0

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

参数

info

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

playerKit

AgoraRtcMediaPlayerProtocol 实例。

所属接口类

• AgoraRtcMediaPlayerDelegate