Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 2.16 KB

cacheconfiguration.md

File metadata and controls

64 lines (50 loc) · 2.16 KB

Cache configuration

Define cache configuration with BetterPlayerCacheConfiguration for given data source. Cache works only for network data sources.

BetterPlayerCacheConfiguration should be used in BetterPlayerDataSource:

BetterPlayerDataSource _betterPlayerDataSource = BetterPlayerDataSource(
      BetterPlayerDataSourceType.network,
      Constants.elephantDreamVideoUrl,
      cacheConfiguration: BetterPlayerCacheConfiguration(
        useCache: true,
        preCacheSize: 10 * 1024 * 1024,
        maxCacheSize: 10 * 1024 * 1024,
        maxCacheFileSize: 10 * 1024 * 1024,

        ///Android only option to use cached video between app sessions
        key: "testCacheKey",
      ),
    );
///Enable cache for network data source
final bool useCache;

/// The maximum cache size to keep on disk in bytes.
/// Android only option.
final int maxCacheSize;

/// The maximum size of each individual file in bytes.
/// Android only option.
final int maxCacheFileSize;

///Cache key to re-use same cached data between app sessions.
final String? key;

Clear all cached data:

betterPlayerController.clearCache();

Start pre cache before playing video:

betterPlayerController.preCache(_betterPlayerDataSource);

Stop running pre cache:

betterPlayerController.stopPreCache(_betterPlayerDataSource);

On Android both HLS and non-HLS data sources will work in the same way (by using ExoPlayer internal cache mechanism). On iOS for HLS stream HLSCachingReverseProxyServer is being used, and for other sources CachingPlayerItem is being used.

See table below to check which cache options are available on given platform:

Feature Android HLS Android non-HLS iOS HLS iOS non-HLS
Normal item cache ✓ ✓ ✓ ✓
Pre cache ✓ ✓ x ✓
Stop cache ✓ ✓ x ✓