Class IMediaPlayerCacheManagerAbstract

This class provides methods to manage cached media files.

Hierarchy

  • IMediaPlayerCacheManager

Constructors

Methods

  • Sets whether to delete cached media files automatically.

    If you enable this function to remove cached media files automatically, when the cached media files exceed either the number or size limit you set, the SDK automatically deletes the least recently used cache file.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Parameters

    • enable: boolean

      Whether to enable the SDK to delete cached media files automatically: true : Delete cached media files automatically. false : (Default) Do not delete cached media files automatically.

    Returns number

  • Gets the storage path of the cached media files.

    If you have not called the setCacheDir method to set the storage path for the media files to be cached before calling this method, you get the default storage path used by the SDK.

    Returns

    The call succeeds, and the SDK returns the storage path of the cached media files. < 0: Failure. See MediaPlayerReason.

    Parameters

    • length: number

      An input parameter; the maximum length of the cache file storage path string.

    Returns string

  • Gets the number of media files that are cached.

    Returns

    ≥ 0: The call succeeds and returns the number of media files that are cached. < 0: Failure. See MediaPlayerReason.

    Returns number

  • Gets the maximum number of media files that can be cached.

    By default, the maximum number of media files that can be cached is 1,000.

    Returns

    0: The call succeeds and returns the maximum number of media files that can be cached. < 0: Failure. See MediaPlayerReason.

    Returns number

  • Gets the maximum size of the aggregate storage space for cached media files.

    By default, the maximum size of the aggregate storage space for cached media files is 1 GB. You can call the setMaxCacheFileSize method to set the limit according to your scenarios.

    Returns

    0: The call succeeds and returns the maximum size (in bytes) of the aggregate storage space for cached media files. < 0: Failure. See MediaPlayerReason.

    Returns number

  • Deletes all cached media files in the media player.

    The cached media file currently being played will not be deleted.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Returns number

  • Deletes a cached media file.

    The cached media file currently being played will not be deleted.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Parameters

    • uri: string

      The URI (Uniform Resource Identifier) of the media file to be deleted.

    Returns number

  • Deletes a cached media file that is the least recently used.

    You can call this method to delete a cached media file when the storage space for the cached files is about to reach its limit. After you call this method, the SDK deletes the cached media file that is least used. The cached media file currently being played will not be deleted.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Returns number

  • Sets the storage path for the media files that you want to cache.

    Make sure IRtcEngine is initialized before you call this method.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Parameters

    • path: string

      The absolute path of the media files to be cached. Ensure that the directory for the media files exists and is writable.

    Returns number

  • Sets the maximum number of media files that can be cached.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Parameters

    • count: number

      The maximum number of media files that can be cached. The default value is 1,000.

    Returns number

  • Sets the maximum size of the aggregate storage space for cached media files.

    Returns

    0: Success. < 0: Failure. See MediaPlayerReason.

    Parameters

    • cacheSize: number

      The maximum size (bytes) of the aggregate storage space for cached media files. The default value is 1 GB.

    Returns number

Generated using TypeDoc