mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-26 17:46:26 +03:00
Aaron Vaage
b98ce99f08
Changed the Storage Engine interface to know about the types that it is expected to store. This allow the implementation to do more internally as the scope of the object has been limited. Change-Id: I388e2bde5e7e3f99e8b28bd16e08a8f6d5fc6453
127 lines
3.0 KiB
JavaScript
127 lines
3.0 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2016 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
goog.provide('shaka.offline.IStorageEngine');
|
|
|
|
goog.require('shaka.util.IDestroyable');
|
|
|
|
|
|
|
|
/**
|
|
* @interface
|
|
* @extends {shaka.util.IDestroyable}
|
|
*/
|
|
shaka.offline.IStorageEngine = function() {};
|
|
|
|
|
|
/**
|
|
* Get a single manifest from storage using the key associated
|
|
* to the manifest.
|
|
*
|
|
* @param {number} key
|
|
* @return {!Promise<shakaExtern.ManifestDB>}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.getManifest;
|
|
|
|
|
|
/**
|
|
* Iterate over all the manifests in storage.
|
|
*
|
|
* @param {function(shakaExtern.ManifestDB)} each
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.forEachManifest;
|
|
|
|
|
|
/**
|
|
* Insert or update a manifest in storage.
|
|
*
|
|
* @param {shakaExtern.ManifestDB} value
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.insertManifest;
|
|
|
|
|
|
/**
|
|
* Remove a manifest from storage using the associated key. If the key is
|
|
* not found, this should be a no-op. When a manifest has been removed
|
|
* or skipped (because not it was not found) |opt_onKeyRemoved| should be
|
|
* called with the key that was removed.
|
|
*
|
|
* @param {!Array<number>} key
|
|
* @param {?function(number)} onKeyRemoved
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.removeManifests;
|
|
|
|
|
|
/**
|
|
* Reserve an id for a new manifest.
|
|
*
|
|
* @return {number}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.reserveManifestId;
|
|
|
|
|
|
/**
|
|
* Get a single segment from storage using the key associated
|
|
* to the segment.
|
|
*
|
|
* @param {number} key
|
|
* @return {!Promise<shakaExtern.SegmentDataDB>}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.getSegment;
|
|
|
|
|
|
/**
|
|
* Iterate over all the segments in storage.
|
|
*
|
|
* @param {function(shakaExtern.SegmentDataDB)} each
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.forEachSegment;
|
|
|
|
|
|
/**
|
|
* Insert or update a segment in storage.
|
|
*
|
|
* @param {shakaExtern.SegmentDataDB} value
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.insertSegment;
|
|
|
|
|
|
/**
|
|
* Remove a segment from storage using the associated key. If the key is
|
|
* not found, this should be a no-op. When a segment has been removed
|
|
* or skipped (because not it was not found) |opt_onKeyRemoved| should be
|
|
* called with the key that was removed.
|
|
*
|
|
* @param {!Array<number>} key
|
|
* @param {?function(number)} onKeyRemoved
|
|
* @return {!Promise}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.removeSegments;
|
|
|
|
|
|
/**
|
|
* Reserve an id for a new segment.
|
|
*
|
|
* @return {number}
|
|
*/
|
|
shaka.offline.IStorageEngine.prototype.reserveSegmentId;
|