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

KollusStorage

お知らせ

このドキュメントは機械翻訳で作成された下書きであり、現在レビュー中です。機械翻訳の特性上、一部の内容が不正確であったり、韓国語の原文と異なる場合があります。より正確な情報については、韓国語のドキュメントをご参照ください。

KollusStorage Class​

#import <KollusStorage.h>

コンテンツのダウンロード・削除・取得を管理するクラスです。

Instance Methods​

  • (BOOL) setKollusPath:
  • (BOOL) startStorage:
  • (BOOL) startStorageWithFirst:error:
  • (BOOL) startStorageWithCheck:
  • (BOOL) startStorageWithNewPlayerID:
  • (NSString *) loadContentURL:error:
  • (NSString *) checkContentURL:error:
  • (BOOL) downloadContent:error:
  • (BOOL) removeContent:error:
  • (BOOL) removeCacheWithError:
  • (BOOL) downloadCancelContent:error:
  • (void) setNetworkTimeOut:retry:
  • (void) updateDownloadDRMInfo:
  • (void) setCacheSize:
  • (void) setBackgroundDownload:
  • (NSMutableArray *) contents
  • (void) sendStoredLms

Properties​

  • id<KollusStorageDelegate> delegate
  • NSString * applicationVersion
  • NSString * applicationDeviceID
  • NSString * applicationKey
  • NSString * applicationBundleID
  • NSString * keychainGroup
  • NSDate * applicationExpireDate
  • NSString * storagePath
  • long long storageSize
  • long long cacheDataSize
  • NSInteger serverPort
  • NSString * extraDrmParam
  • NSString * appUserAgent
  • NSString * deviceType

Method Details​

(BOOL) setKollusPath: (NSString *) path

Kollus SDK がコンテンツを保存するストレージフォルダのパスを設定します。

  • 注意: このメソッドは新規アプリインストール時にのみ使用してください。既存のパスを変更すると、以前にダウンロードされたコンテンツにアクセスできなくなります。startStorage の呼び出し前に設定する必要があります。
  • パラメーター
    • path: コンテンツが保存されるパス（デフォルト: Document）
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) startStorage: (NSError **) error

KollusStorage を開始します。

  • 注意: このメソッドを呼び出さない場合、コンテンツ情報の配列(contents)が nil で返されるため、ダウンロードされたコンテンツにアクセスできません。
  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) startStorageWithFirst: (BOOL) first error: (NSError **) error

KollusStorage を開始します。

  • 注意: このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が 0 で返されます。保存されたコンテンツの一覧を正常に取得するには、必ず呼び出す必要があります。
  • パラメーター
    • first: アプリインストール後の初回起動かどうか
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) startStorageWithCheck: (NSError **) error

KollusStorage を開始します。

  • 注意: このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が 0 で返されます。保存されたコンテンツの一覧を正常に取得するには、必ず呼び出す必要があります。
  • プレイヤー ID の処理ロジック
    • 初回起動時: キーチェーンにプレイヤー ID が存在しない場合、新しい ID を生成して登録します。
    • 再起動時: キーチェーンから ID の取得を試み、3 回連続して失敗した場合はエラーを返します。
  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) startStorageWithNewPlayerID: (NSError **) error

KollusStorage を開始します。

  • 注意: このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が 0 で返されます。保存されたコンテンツの一覧を正常に取得するには、必ず呼び出す必要があります。新しいプレイヤー ID を生成してキーチェーンに登録するため、既存の ID に依存するデータを利用する場合は注意が必要です。
  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(NSString *) loadContentURL: (NSString *) URL error: (NSError **) error

コンテンツのダウンロードを初期化します。

  • パラメーター
    • URL: コンテンツ URL
    • error: エラー詳細
  • 戻り値: メディアコンテンツキー
(NSString*) checkContentURL: (NSString *) URL error: (NSError **) error

指定された URL に対応するコンテンツのダウンロード状況とメディアコンテンツキーを確認します。

  • パラメーター
    • URL: コンテンツ URL
    • error: エラー詳細
  • 戻り値: ダウンロード済みコンテンツが存在する場合はメディアコンテンツキー、存在しない場合は nil
(BOOL) downloadContent: (NSString *) mediaContentKey error: (NSError **) error

メディアコンテンツキーを使用してコンテンツをダウンロードします。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) removeContent: (NSString *) mediaContentKey error: (NSError **) error

特定のコンテンツを削除します。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) removeCacheWithError: (NSError **) error

ストリーミングコンテンツのキャッシュデータを削除します。

  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) downloadCancelContent: (NSString *) mediaContentKey error: (NSError **) error

コンテンツのダウンロードを停止します。

  • パラメーター
    • mediaContentKey: メディアコンテンツキー
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(void) setNetworkTimeOut: (NSInteger) timeOut retry: (NSInteger) retryCount

ストレージネットワークの Timeout を設定します。

  • パラメーター
    • timeOut: Timeout 値(sec)
    • retryCount: リトライ回数
(void) updateDownloadDRMInfo: (BOOL) bAll

DRM コンテンツリストを更新します。

  • パラメーター
    • bAll: 全コンテンツを更新するかどうか（YES: 全コンテンツを更新、NO: 失効したコンテンツのみ更新）
(void) setCacheSize: (NSInteger) cacheSizeMB

ストレージキャッシュのサイズを設定します。

  • パラメーター
    • cacheSizeMB: ストリーミングコンテンツのキャッシュサイズ(MB)
(void) setBackgroundDownload: (BOOL) bBackground

ストレージコンテンツのバックグラウンドダウンロードの使用有無を設定します。

  • パラメーター
    • bBackground: バックグラウンドダウンロードの有効化（YES: 有効、NO: 無効）
(NSMutableArray*) contents

ダウンロードされたコンテンツ情報の配列を返します。

(void) sendStoredLms

未送信の LMS データを送信します。

Property Details​

属性説明
(id<KollusStorageDelegate>) delegate
[read, write, nonatomic, weak]		ダウンロード状態情報デリゲート
(NSString*) applicationVersion
[read, nonatomic, copy]		Kollus SDK バージョン
(NSString*) applicationDeviceID
[read, nonatomic, copy]		Kollus Player デバイス ID
(NSString*) applicationKey
[read, write, nonatomic, copy]		Kollus SDK 認証キー（カテノイドが発行）
(NSString*) applicationBundleID
[read, write, nonatomic, copy]		アプリケーション Bundle ID（例: com.yourcompany.applicationname）
(NSString*) keychainGroup
[read, write, nonatomic, copy]		キーチェーングループ（例: com.yourcompany.shared）
(NSDate*) applicationExpireDate
[read, write, nonatomic, copy]		Kollus SDK 有効期限（カテノイドが発行）
(NSString*) storagePath
[readonly, nonatomic, copy]		Kollus SDK フォルダ
(long long) storageSize
[read, nonatomic, unsafe_unretained]		ダウンロードコンテンツの総容量(bytes)
(long long) cacheDataSize
[read, nonatomic, unsafe_unretained]		ストリーミングキャッシュデータの総容量(bytes)
(NSInteger) serverPort
[read, write, nonatomic, assign]		ハイブリッドアプリで使用されるポート番号
(NSString*) extraDrmParam
[read, write, nonatomic, copy]		動的 DRM パラメーター
(NSString*) appUserAgent
[read, nonatomic, copy]		HTTP リクエスト時に使用する User-Agent 文字列
(NSString*) deviceType
[read, nonatomic, copy]		デバイスタイプ（kp-mobile: モバイル、kp-tablet: タブレット）

KollusStorageDelegate Protocol​

#import <KollusStorageDelegate.h>

ダウンロードの進行状態と DRM コールバックイベントを受信するプロトコルです。

Instance Methods​

  • (void) kollusStorage:downloadContent:error:
  • (void) kollusStorage:request:json:error:
  • (void) kollusStorage:cur:count:error:
  • (void) kollusStorage:lmsData:resultJson:
  • (void) onSendCompleteStoredLms:failCount:

Method Details​

(void) kollusStorage: (KollusStorage *) kollusStorage cur: (int) cur count: (int) count error: (NSError *) error

DRM コンテンツリストを一括更新中に、各コンテンツの更新が完了したときに呼び出されます。

  • パラメーター
    • kollusStorage: KollusStorage ID
    • cur: 現在の項目
    • count: 全コンテンツ数
    • error: エラー詳細（nil でない場合はエラー発生）
(void) kollusStorage: (KollusStorage *) kollusStorage downloadContent: (KollusContent *) content error: (NSError *) error

コンテンツのダウンロード中に状態変化がある場合に呼び出されます。

  • パラメーター
    • kollusStorage: KollusStorage ID
    • content: 状態変化のあるコンテンツ情報
    • error: エラー詳細（nil でない場合はエラー発生）
(void) kollusStorage: (KollusStorage *) kollusStorage lmsData: (NSString *) lmsData resultJson: (NSDictionary *) resultJsonLMS

LMS コールバック処理後に呼び出されます。

  • パラメーター
    • kollusStorage: KollusStorage ID
    • lmsData: LMS データ
    • resultJsonLMS: LMS result 情報
(void) kollusStorage: (KollusStorage *) kollusStorage request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error

DRM ダウンロードコールバック処理後に呼び出されます。

  • パラメーター
    • kollusStorage: KollusStorage ID
    • request: リクエスト情報
    • json: レスポンスデータ
    • error: エラー詳細（nil でない場合はエラー発生）
(void) onSendCompleteStoredLms: (int) successCount failCount: (int) failCount

未送信 LMS コールバック完了後に呼び出されます。

  • パラメーター
    • successCount: LMS 送信成功回数
    • failCount: LMS 送信失敗回数