# 媒体播放器缓存 (/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## enableAutoRemoveCache: [#enableautoremovecache] 设置是否自动删除缓存的媒体文件。 ```objc - (int)enableAutoRemoveCache:(BOOL)enable NS_SWIFT_NAME(enableAutoRemoveCache(_:)); ``` 当缓存的媒体文件超过设置的数量或大小限制时,如果启用该功能,SDK 会自动删除最近最少使用的缓存文件。 ### 参数 [#参数] 是否启用 SDK 自动删除缓存的媒体文件: - YES:自动删除缓存的媒体文件。 - NO:(默认)不自动删除缓存的媒体文件。 ### 返回值 [#返回值] - 0:方法调用成功。 - < 0:方法调用失败,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## cacheDir [#cachedir] 获取缓存媒体文件的存储路径。 ```objc - (NSString *)cacheDir NS_SWIFT_NAME(cacheDir()); ``` 如果在调用该方法前未调用 [setCacheDir:](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_setcachedir) 方法设置缓存媒体文件的存储路径,则该方法返回 SDK 默认使用的存储路径。 ### 返回值 [#返回值-1] - 方法调用成功时,返回缓存媒体文件的存储路径。 - 方法调用失败,返回 nil,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-1] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## cacheFileCount [#cachefilecount] 获取已缓存的媒体文件数量。 ```objc - (NSInteger)cacheFileCount NS_SWIFT_NAME(cacheFileCount()); ``` ### 返回值 [#返回值-2] - 方法调用成功,返回已缓存的媒体文件数量。 - 方法调用失败,返回小于 0 的错误码,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-2] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## maxCacheFileCount [#maxcachefilecount] 获取可缓存的媒体文件的最大数量。 ```objc - (NSInteger)maxCacheFileCount NS_SWIFT_NAME(maxCacheFileCount()); ``` 默认情况下,最多可以缓存 1,000 个媒体文件。 ### 返回值 [#返回值-3] 方法调用成功,返回可缓存的媒体文件的最大数量。 - < 0:方法调用失败,返回错误码,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-3] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## maxCacheFileSize [#maxcachefilesize] 获取缓存媒体文件的聚合存储空间的最大大小。 ```objc - (NSInteger)maxCacheFileSize NS_SWIFT_NAME(maxCacheFileSize()); ``` 你可以调用 [setMaxCacheFileSize:](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_setmaxcachefilesize) 方法根据你的使用场景设置该限制。默认情况下,缓存媒体文件的聚合存储空间的最大大小为 1 GB。 ### 返回值 [#返回值-4] - 方法调用成功,返回缓存媒体文件的聚合存储空间的最大大小(单位为字节)。 - 方法调用失败,返回小于 0 的错误码,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-4] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## removeAllCaches [#removeallcaches] 删除媒体播放器中所有缓存的媒体文件。 ```objc - (int)removeAllCaches NS_SWIFT_NAME(removeAllCaches()); ``` :::note 注: [removeAllCaches](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removeallcaches) 不会删除当前正在播放的缓存媒体文件。 ::: ### 返回值 [#返回值-5] - 0:方法调用成功。 - < 0:方法调用失败,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-5] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## removeCacheByUri: [#removecachebyuri] 删除缓存的媒体文件。 ```objc - (int)removeCacheByUri:(NSString *)uri NS_SWIFT_NAME(removeCache(byUri:)); ``` :::note 注: [removeCacheByUri:](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removecachebyuri) 当前正在播放的缓存媒体文件不会被删除。 ::: ### 参数 [#参数-1] 要删除的媒体文件的 URI(统一资源标识符)。 ### 返回值 [#返回值-6] - 0:方法调用成功。 - < 0:方法调用失败,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-6] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## removeOldCache [#removeoldcache] 删除最少使用的缓存媒体文件。 ```objc - (int)removeOldCache NS_SWIFT_NAME(removeOldCache()); ``` 当缓存文件的存储空间即将达到上限时,你可以调用该方法删除一个缓存媒体文件。SDK 会删除最少使用的缓存媒体文件。 :::note 注: [removeOldCache](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removeoldcache) 当前不会删除正在播放的缓存媒体文件。 ::: ### 返回值 [#返回值-7] - 0:方法调用成功。 - < 0:方法调用失败,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-7] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## setCacheDir: [#setcachedir] 设置要缓存的媒体文件的存储路径。 ```objc - (int)setCacheDir:(NSString *)cacheDir NS_SWIFT_NAME(setCacheDir(_:)); ``` :::note 注: 请确保在调用该方法前已初始化 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_irtcengine)。 ::: ### 参数 [#参数-2] 要缓存的媒体文件的绝对路径。确保该目录存在且可写。 ### 返回值 [#返回值-8] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-8] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## setMaxCacheFileCount: [#setmaxcachefilecount] 设置可缓存的媒体文件数量上限。 ```objc - (int)setMaxCacheFileCount:(NSInteger)count NS_SWIFT_NAME(setMaxCacheFileCount(_:)); ``` ### 参数 [#参数-3] 可缓存的媒体文件数量上限(默认值为 1,000)。 ### 返回值 [#返回值-9] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-9] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## setMaxCacheFileSize: [#setmaxcachefilesize] 设置用于缓存媒体文件的聚合存储空间的最大大小。 ```objc - (int)setMaxCacheFileSize:(NSInteger)cacheSize NS_SWIFT_NAME(setMaxCacheFileSize(_:)); ``` ### 参数 [#参数-4] 缓存媒体文件的聚合存储空间的最大大小(字节)(默认值为 1 GB)。 ### 返回值 [#返回值-10] - 0:方法调用成功。 - < 0:方法调用失败,详见 [AgoraMediaPlayerReason](/zh-CN/api-reference/rtc/ios/enum-mediaplayerreason)。 ### 所属接口类 [#所属接口类-10] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## sharedInstance [#sharedinstance] 获取 [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) 实例。 ```objc + (instancetype)sharedInstance NS_SWIFT_NAME(sharedInstance()); ``` ### 返回值 [#返回值-11] 方法调用成功,返回 [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) 实例。 ### 所属接口类 [#所属接口类-11] - [AgoraRtcMediaPlayerCacheManagerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayercachemanager) ## AgoraRtcMediaPlayer\:cacheStats: [#agorartcmediaplayercachestats] 上报正在缓存的媒体文件的统计信息。 ```objc - (void)AgoraRtcMediaPlayer:(id _Nonnull)playerKit cacheStats:(AgoraMediaPlayerCacheStatistics *_Nonnull)info NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:cacheStats:)); ``` ### 触发时机 [#触发时机] 该回调在你调用 [openWithMediaSource:](/zh-CN/api-reference/rtc/ios/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) 方法并将 `enableCache` 设置为 YES 后,每秒触发一次。 ### 参数 [#参数-5] [AgoraRtcMediaPlayerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayer) 实例。详见 [AgoraRtcMediaPlayerProtocol](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayer)。 正在缓存的媒体文件的统计信息。详见 [AgoraMediaPlayerCacheStatistics](/zh-CN/api-reference/rtc/ios/class-cachestatistics)。 ### 所属接口类 [#所属接口类-12] - [AgoraRtcMediaPlayerDelegate](/zh-CN/api-reference/rtc/ios/rtc-interface-class#class_imediaplayersourceobserver)