メインコンテンツまでスキップ

KollusStorage

KollusStorage Class​

com.kollus.sdk.media.KollusStorage

コンテンツのダウンロード、キャッシュ管理、DRM 情報の更新、および各種イベントリスナーを統括するストレージ管理クラスです。

Interfaces​

  • interface DrmSessionManagerListener
  • interface OnKollusStorageDeviceListener
  • interface OnKollusStorageListener

Public Methods​

  • KollusStorage(Context context)
  • void cancelLoad()
  • int checkLiveStream(String url)
  • void clearCache()
  • String decrypt(String encData)
  • int download(String mediaContentKey)
  • void finish()
  • ArrayList<KollusContent> getDownloadContentList()
  • KollusContent getDownloadKollusContent(String path)
  • boolean getKollusContent(KollusContent content, String mediaContentKey) throws IllegalStateException
  • String getLastError()
  • long getNativeInstance()
  • String getRootPath()
  • long getUsedSize(int type)
  • String getVersion()
  • int initialize(String key, String expireDate, String packageName)
  • boolean isReady()
  • int load(String path, String extraDrmParam, KollusContent content)
  • void registerDrmSessionManagerListenerList(DrmSessionManagerListener listener)
  • void registerKollusPlayerCallbackListener(KollusPlayerCallbackListener listener)
  • void registerKollusPlayerDRMListener(KollusPlayerDRMListener listener)
  • void registerKollusPlayerThumbnailListener(KollusPlayerThumbnailListener listener)
  • void registerKollusStorageListener(OnKollusStorageListener listener)
  • synchronized void releaseInstance()
  • int remove(String mediaContentKey)
  • void removeDrmSessionManagerListenerList(DrmSessionManagerListener listener)
  • void sendStoredLMS(StoredLMSListener listener)
  • void setCacheSize(int cacheSizeMB)
  • int setDevice(String storagePath, boolean bTablet)
  • void setDeviceASync(String storagePath, boolean bTablet, OnKollusStorageDeviceListener listener)
  • void setNetworkTimeout(int timeout, int retryCount)
  • int unload(String mediaContentKey)
  • void unregisterKollusPlayerCallbackListener(KollusPlayerCallbackListener listener)
  • void unregisterKollusPlayerDRMListener(KollusPlayerDRMListener listener)
  • void unregisterKollusPlayerThumbnailListener(KollusPlayerThumbnailListener listener)
  • void unregisterKollusStorageListener(OnKollusStorageListener listener)
  • void updateDownloadDRMInfo(KollusPlayerDRMUpdateListener listener, boolean bAll)
  • void updateDownloadDRMInfo(KollusPlayerDRMUpdateListener listener, ArrayList<String> mckList)

Static Public Methods​

  • static synchronized KollusStorage getInstance(Context context)

Static Public Properties​

  • static final int TYPE_CACHE = 0
  • static final int TYPE_DOWNLOAD = 1
  • static final int TYPE_ALL = 2

Protected Methods​

  • int downloadFile(String srcPath, String dstPath)
  • int downloadThumbnail(String srcPath, String dstPath)
  • String getCallback(String customer, String callbackUrl, String postData)
  • String getMediaInfoJson(Uri uri)
  • String getNoKollusDownloadPath()
  • String getNoKollusStreamPath()
  • void registerKollusPlayerLMSListener(KollusPlayerLMSListener listener)
  • void sendCallback(String customer, String url)
  • void unregisterKollusPlayerLMSListener(KollusPlayerLMSListener listener)

Method Details​

void com.kollus.sdk.media.KollusStorage.cancelLoad()

現在進行中のロード(Load)操作を中断します。ダウンロードをキャンセルする際は、このメソッドを呼び出した後にunloadを実行する必要があります。

int com.kollus.sdk.media.KollusStorage.checkLiveStream(String url)

該当パスが現在ライブ配信中の URL であるかを確認します。

  • パラメーター
    • url: 視聴 URL
  • 戻り値: ライブ配信中かどうかの確認コード
void com.kollus.sdk.media.KollusStorage.clearCache()

ストリーミング再生時に使用された一時キャッシュデータをすべて削除します。（ダウンロードコンテンツは削除されません。）

int com.kollus.sdk.media.KollusStorage.download(String mediaContentKey)

ロードされたコンテンツのメディアコンテンツキーを使用してダウンロードを開始します。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
  • 戻り値: エラーコード（参考: ErrorCodes）
void com.kollus.sdk.media.KollusStorage.finish()

Native レイヤーのストレージリソースを解放します。

ArrayList<KollusContent> com.kollus.sdk.media.KollusStorage.getDownloadContentList()

現在ダウンロードされているすべてのコンテンツリストを返します。

  • 戻り値: ダウンロード済みコンテンツリスト
KollusContent com.kollus.sdk.media.KollusStorage.getDownloadKollusContent(String path)

指定されたパスに対応するダウンロードコンテンツ情報を取得します。

  • パラメーター
    • path: コンテンツパス
  • 戻り値: コンテンツ情報
static synchronized KollusStorage com.kollus.sdk.media.KollusStorage.getInstance(Context context)

KollusStorageのシングルトンインスタンスを返します。

  • パラメーター
    • context: アプリケーションコンテキスト
  • 戻り値: KollusStorageインスタンス
boolean com.kollus.sdk.media.KollusStorage.getKollusContent(KollusContent content, String mediaContentKey) throws IllegalStateException

メディアコンテンツキーを通じて特定のコンテンツ情報を取得します。

  • パラメーター
    • content: 情報を格納する空のオブジェクト
    • mediaContentKey: メディアコンテンツキー
  • 戻り値: 情報取得の成否
String com.kollus.sdk.media.KollusStorage.getLastError()

最後に発生したエラーのメッセージを返します。

  • 戻り値: エラーメッセージ
String com.kollus.sdk.media.KollusStorage.getMediaInfoJson(Uri uri)

Internal SDK Only  指定された URI のメディア情報を JSON 形式で取得します。

  • パラメーター
    • uri: メディア URI
  • 戻り値: メディア情報（JSON データ）
long com.kollus.sdk.media.KollusStorage.getNativeInstance()

Native レイヤーで管理されているKollusStorageエンジンの実際のインスタンスハンドル（ポインター）値を返します。

  • 戻り値: Native インスタンスアドレス値(Handle)
String com.kollus.sdk.media.KollusStorage.getRootPath()

現在設定されているコンテンツ保存のルートパスを返します。

  • 戻り値: 現在設定されている保存先パス
long com.kollus.sdk.media.KollusStorage.getUsedSize(int type)

指定されたデータタイプの総使用容量を取得します。

  • パラメーター
    • type
      • TYPE_CACHE(0): ストリーミング再生時に生成されたキャッシュ容量
      • TYPE_DOWNLOAD(1): ローカルに保存されたダウンロードコンテンツの総容量
      • TYPE_ALL(2): すべてのタイプの総容量
  • 戻り値: 現在使用中の総容量
String com.kollus.sdk.media.KollusStorage.getVersion()

SDK ライブラリのバージョン情報を返します。

  • 戻り値: SDK バージョン
int com.kollus.sdk.media.KollusStorage.initialize(String key, String expireDate, String packageName)

SDK ライブラリを初期化します。

  • パラメーター
    • key: 発行されたキー
    • expireDate: 有効期限(YYYY/MM/DD)
    • packageName: アプリパッケージ名
  • 戻り値: エラーコード（参考: ErrorCodes）
boolean com.kollus.sdk.media.KollusStorage.isReady()

ストレージ管理者が使用可能な状態（デバイス設定完了）かどうかを確認します。

  • 戻り値
    • true: 使用可能
    • false: 使用不可
int com.kollus.sdk.media.KollusStorage.load(String path, String extraDrmParam, KollusContent content)

ダウンロードするコンテンツ情報をロードします。

  • パラメーター
    • path: ダウンロードするコンテンツのパス
    • extraDrmParam: 動的 DRM Download Callback / Play Callback 引数
    • content: 情報を格納するオブジェクト
  • 戻り値: エラーコード（参考: ErrorCodes）
void com.kollus.sdk.media.KollusStorage.registerKollusPlayerCallbackListener(KollusPlayerCallbackListener listener)

KollusPlayerCallbackListenerを登録します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.registerKollusPlayerDRMListener(KollusPlayerDRMListener listener)

KollusPlayerDRMListenerを登録します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.registerKollusPlayerLMSListener(KollusPlayerLMSListener listener)

KollusPlayerLMSListenerを登録します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.registerKollusPlayerThumbnailListener(KollusPlayerThumbnailListener listener)

KollusPlayerThumbnailListenerを登録します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.registerKollusStorageListener(OnKollusStorageListener listener)

OnKollusStorageListenerを登録します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
synchronized void com.kollus.sdk.media.KollusStorage.releaseInstance()

使用中のKollusStorageインスタンスのリソースを明示的に解放します。

int com.kollus.sdk.media.KollusStorage.remove(String mediaContentKey)

ローカルに保存されたダウンロードコンテンツを削除します。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
  • 戻り値: エラーコード（参考: ErrorCodes）
void com.kollus.sdk.media.KollusStorage.sendStoredLMS(StoredLMSListener listener)

ネットワーク障害などにより送信できなかったローカル保存 LMS データを一括送信します。

  • パラメーター
    • listener: イベントを処理するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.setCacheSize(int cacheSizeMB)

ストリーミング時に使用するキャッシュメモリサイズを設定します。setDeviceまたはsetDeviceASyncを呼び出す前に設定する必要があります。

  • パラメーター
    • cacheSizeMB: キャッシュサイズ(MB)
int com.kollus.sdk.media.KollusStorage.setDevice(String storagePath, boolean bTablet)

ストレージのルートパスとデバイスタイプを設定します。

  • パラメーター
    • storagePath: ストレージ管理者が使用するルートパス
    • bTablet: タブレットかどうか（true: タブレット）
void com.kollus.sdk.media.KollusStorage.setDeviceASync(String storagePath, boolean bTablet, OnKollusStorageDeviceListener listener)

ストレージ設定を非同期方式で実行します。

  • パラメーター
    • storagePath: ストレージ管理者が使用するルートパス
    • bTablet: タブレットかどうか（true: タブレット）
    • listener: 設定完了を受信するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.setNetworkTimeout(int timeout, int retryCount)

ネットワーク Timeout 時間と再試行回数を設定します。

  • パラメーター
    • timeout: 制限時間(sec)
    • retryCount: Timeout 発生時の再試行回数
int com.kollus.sdk.media.KollusStorage.unload(String mediaContentKey)

ロード済みのインデックスを解放します。ダウンロードキャンセル時はcancelLoadの後に呼び出します。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
  • 戻り値: エラーコード（参考: ErrorCodes）
void com.kollus.sdk.media.KollusStorage.unregisterKollusPlayerCallbackListener(KollusPlayerCallbackListener listener)

KollusPlayerCallbackListenerを解除します。

  • パラメーター
    • listener: 解除するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.unregisterKollusPlayerDRMListener(KollusPlayerDRMListener listener)

KollusPlayerDRMListenerを解除します。

  • パラメーター
    • listener: 解除するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.unregisterKollusPlayerLMSListener(KollusPlayerLMSListener listener)

KollusPlayerLMSListenerを解除します。

  • パラメーター
    • listener: 解除するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.unregisterKollusPlayerThumbnailListener(KollusPlayerThumbnailListener listener)

KollusPlayerThumbnailListenerを解除します。

  • パラメーター
    • listener: 解除するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.unregisterKollusStorageListener(OnKollusStorageListener listener)

OnKollusStorageListenerを解除します。

  • パラメーター
    • listener: 解除するリスナーインスタンス
void com.kollus.sdk.media.KollusStorage.updateDownloadDRMInfo(KollusPlayerDRMUpdateListener listener, boolean bAll)

すべてのコンテンツまたは期限切れコンテンツの DRM 情報を一括更新します。

  • パラメーター
    • listener: 更新の進行状況および結果を受信するインターフェースインスタンス
    • bAll: 更新範囲の設定値（true: 全コンテンツ、false: 期限切れコンテンツのみ）
void com.kollus.sdk.media.KollusStorage.updateDownloadDRMInfo(KollusPlayerDRMUpdateListener listener, ArrayList<String>  mckList)

特定のメディアコンテンツキーリストに対応するコンテンツの DRM を更新します。

  • パラメーター
    • listener: 更新の進行状況および結果を受信するインターフェースインスタンス
    • mckList: 更新対象のメディアコンテンツキーリスト

Property Details​

属性値説明
TYPE_CACHE0ストリーミング再生時に生成されるキャッシュデータ
TYPE_DOWNLOAD1ローカルストレージに保存されるダウンロードコンテンツデータ
TYPE_ALL2すべてのタイプのデータ（キャッシュ＋ダウンロード）

OnKollusStorageDeviceListener Interface​

com.kollus.sdk.media.KollusStorage.OnKollusStorageDeviceListener

setDeviceASyncメソッドの呼び出しによるストレージデバイス設定プロセスの進行状況を受信するインターフェースです。

Public Methods​

  • void onDeviceSettingEnd()
  • void onDeviceSettingError(int nErrorCode)
  • void onDeviceSettingStart()

Method Details​

void com.kollus.sdk.media.KollusStorage.OnKollusStorageDeviceListener.onDeviceSettingEnd()

デバイスの設定および初期化プロセスが正常に完了した時点で呼び出されます。

void com.kollus.sdk.media.KollusStorage.OnKollusStorageDeviceListener.onDeviceSettingError(int nErrorCode)

デバイス設定中にエラーが発生した際に呼び出されます。（例: 指定されたパスに必要なディレクトリを作成する権限がない場合や、ストレージ容量が不足している場合）

  • パラメーター
    • nErrorCode: 発生したエラーの識別コード
void com.kollus.sdk.media.KollusStorage.OnKollusStorageDeviceListener.onDeviceSettingStart()

デバイス設定プロセスが開始した時点で呼び出されます。

OnKollusStorageListener Interface​

com.kollus.sdk.media.KollusStorage.OnKollusStorageListener

コンテンツダウンロードプロセスの状態変化（進行中、完了、エラー発生）イベントを受信するインターフェースです。

Public Methods​

  • void onComplete(KollusContent content)
  • void onError(KollusContent content, int errorCode)
  • void onProgress(KollusContent content)

Method Details​

void com.kollus.sdk.media.KollusStorage.OnKollusStorageListener.onComplete(KollusContent content)

コンテンツのすべてのデータがローカルストレージに正常に保存された時点で呼び出されます。

  • パラメーター
    • content: コンテンツ情報
void com.kollus.sdk.media.KollusStorage.OnKollusStorageListener.onError(KollusContent content, int errorCode)

ダウンロード中に予期しないエラーが発生して中断された時点で呼び出されます。

  • パラメーター
    • content: コンテンツ情報
    • errorCode: エラーコード
void com.kollus.sdk.media.KollusStorage.OnKollusStorageListener.onProgress(KollusContent content)

ダウンロードが進行している間、定期的に呼び出されます。

  • パラメーター
    • content: コンテンツ情報