Methods
        
            
    
    
    cacheManifest(manifest) → {void}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifest | 
            
            
            
                
object
            
             | 
            
            
            manifest object | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    - 
        Type
    
 
    - 
        
void
    
 
    
        
            
    
    
    getManifestById(manifestId) → {*}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifestId | 
            
            
            
                
string
            
             | 
            
            
            manifest identifier | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    manifest
    - 
        Type
    
 
    - 
        
*
    
 
    
        
            
    
    
    getManifestInfoById(manifestId) → {*}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifestId | 
            
            
            
                
string
            
             | 
            
            
            manifest identifier | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    manifest info
    - 
        Type
    
 
    - 
        
*
    
 
    
        
            
    
    
    getManifests(manifestIdsopt) → {*}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        Attributes | 
        
        
        Description | 
    
    
    
    
        
            
                manifestIds | 
            
            
            
                
Array
|
number
|
string
            
             | 
            
                
                
                    <optional> 
                
                
                
                 | 
            
            
            manifests identifiers | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    manifests
    - 
        Type
    
 
    - 
        
*
    
 
    
        
            
    
    
    getManifestsInfo(manifestIdsopt) → {Array}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        Attributes | 
        
        
        Description | 
    
    
    
    
        
            
                manifestIds | 
            
            
            
                
Array
|
number
|
string
            
             | 
            
                
                
                    <optional> 
                
                
                
                 | 
            
            
            manifests identifiers | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    manifests infomrations
    - 
        Type
    
 
    - 
        
Array
    
 
    
        
            
    
    
    getOriginalManifestLocalPath(manifestId) → {string}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifestId | 
            
            
            
                
string
            
             | 
            
            
            manifest identifier | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    local path for manifest files
    - 
        Type
    
 
    - 
        
string
    
 
    
        
            
    
    
    removeFromCache(manifestIdsopt) → {void}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        Attributes | 
        
        
        Description | 
    
    
    
    
        
            
                manifestIds | 
            
            
            
                
Array
|
number
|
string
            
             | 
            
                
                
                    <optional> 
                
                
                
                 | 
            
            
            manifests identifiers | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    - 
        Type
    
 
    - 
        
void
    
 
    
        
            
    
    
    saveManifestWithChosenRepresentations(manifestId, representations, downloadFolder) → {Promise}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifestId | 
            
            
            
                
string
            
             | 
            
            
            manifest identifier | 
        
    
        
            
                representations | 
            
            
            
                
object
            
             | 
            
            
            representations to be saved | 
        
    
        
            
                downloadFolder | 
            
            
            
                
string
            
             | 
            
            
            folder where all fragments are downloaded | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    promise
    - 
        Type
    
 
    - 
        
Promise
    
 
    
        
            
    
    
    saveOriginalManifestOnceOnly(manifestId) → {Promise}
    
    
    Parameters:
    
    
    
        
        | Name | 
        
        Type | 
        
        
        Description | 
    
    
    
    
        
            
                manifestId | 
            
            
            
                
string
            
             | 
            
            
            manifest identifier | 
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
Returns:
        
    promise
    - 
        Type
    
 
    - 
        
Promise