Version: 2023.2
LanguageEnglish
  • C#

AssetBundle.LoadFromStreamAsync

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static AssetBundleCreateRequest LoadFromStreamAsync(Stream stream);

Declaration

public static AssetBundleCreateRequest LoadFromStreamAsync(Stream stream, uint crc);

Declaration

public static AssetBundleCreateRequest LoadFromStreamAsync(Stream stream, uint crc, uint managedReadBufferSize);

Parameters

stream The managed Stream object. Unity calls Read(), Seek() and the Length property on this object to load the AssetBundle data.
crc An optional CRC-32 checksum of the uncompressed content.
managedReadBufferSize You can use this to override the size of the read buffer Unity uses while loading data. The default size is 32KB.

Returns

AssetBundleCreateRequest Asynchronous load request for an AssetBundle. Use assetBundle property to get an AssetBundle once it is loaded.

Description

Asynchronously loads an AssetBundle from a managed Stream.

The function supports bundles of any compression type. lzma compressed data is decompressed to memory, while uncompressed and chunk-compressed bundles are read directly from the Stream.

Unlike LoadFromStream, this function is asynchronous.

Unlike LoadFromFileAsync, the data for the AssetBundle is supplied by a managed Stream object.

The following are restrictions on a Stream object to optimize AssetBundle data loading:

  1. The AssetBundle data must start at stream position zero.
  2. Unity sets the seek position to zero before it loads the AssetBundle data.
  3. Unity assumes the read position in the stream is not altered by any other process. This allows the Unity process to read from the stream without having to call Seek() before every read.
  4. stream.CanRead must return true.
  5. stream.CanSeek must return true.
  6. It must be accessible from threads different to the main thread. Seek() and Read() can be called from any Unity native thread.
  7. In certain circumstances Unity will try to read passed the size of the AssetBundle data. The Stream implementation must gracefully handle this without throwing exceptions. The Stream implementation must also return the actual number of bytes read (not including any bytes passed the end of the AssetBundle data).
  8. When starting at the end of the AssetBundle data and trying to read data the Stream implementation must return 0 bytes read and not throw exceptions.

To reduce the number of calls from native to managed code the data is read from the Stream using a buffered reader with a buffer size of managedReadBufferSize.

  • Changing managedReadBufferSize may change the loading performance, especially on mobile devices.
  • The optimal value for managedReadBufferSize varies from project to project and potentially from Asset Bundle to Asset Bundle.
  • A good range of values to experiment with is: 8KB, 16KB, 32KB, 64KB, 128KB.
  • Larger values might be better for compressed Asset Bundles or if the Asset Bundle contains large sized assets or if the Asset Bundle does not contain many assets and they are loaded sequentially from the Asset Bundle.
  • Smaller values might be better for uncompressed Asset Bundles and reading lots of small assets or if the Asset Bundles has lots of assets in it and the asset are loaded in a random order.

Do not dispose the Stream object while loading the AssetBundle or any assets from the bundle. Its lifetime should be longer than the AssetBundle. This means you dispose the Stream object after calling AssetBundle.Unload.

Additional resources: AssetBundle, LoadFromStream LoadFromFileAsync.