AssetBundle.LoadFromStream

Parameters

Returns

AssetBundle The loaded AssetBundle object or null when the object fails to load.

Description

Synchronously 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.

The content is compared against the checksum before it is loaded when the checksum is a non-zero value. An error is thrown if it does not match.

Unlike LoadFromStreamAsync, this function is synchronous and only returns when it has created the AssetBundle object.

Unlike LoadFromFile, 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.

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.

using UnityEngine;
using System.Collections;
using System;
using System.IO;

public class LoadFromStreamExample : MonoBehaviour
{
    void Start()
    {
        var fileStream = new FileStream(Application.streamingAssetsPath, FileMode.Open, FileAccess.Read);
        var myLoadedAssetBundle = AssetBundle.LoadFromStream(fileStream);
        if (myLoadedAssetBundle == null)
        {
            Debug.Log("Failed to load AssetBundle!");
            return;
        }

        var prefab = myLoadedAssetBundle.LoadAsset<GameObject>("MyObject");
        Instantiate(prefab);

        myLoadedAssetBundle.Unload(false);
    }
}

See Also: AssetBundle, LoadFromStreamAsync LoadFromFile.