iOS SDK_Old

最終更新 KollusSDK_iOS_v2.2.92_0401

[V2.2.92] - 2021.04.01

回路図索引

クラス回路図

NSObject KollusBookmark KollusContent KollusStorage KPSection LogUtil SubTitleInfo <NSObject> <KollusPlayerBookmarkDelegate> <KollusPlayerDelegate> <KollusPlayerDRMDelegate> <KollusPlayerLMSDelegate> <KollusStorageDelegate> <NSObjectNSObject> <UtilDelegate> UIView KollusPlayerView

クラス索引

クラスリスト

クラス、構造体、共用体、インターフェース

KollusBookmark KollusContent <KollusPlayerBookmarkDelegate> <KollusPlayerDelegate> <KollusPlayerDRMDelegate> <KollusPlayerLMSDelegate> KollusPlayerView KollusStorage <KollusStorageDelegate> KPSection LogUtil SubTitleInfo <UtilDelegate>

ファイル索引

ファイルリスト

全てのファイルのリスト

._KollusPlayerLMSDelegate.h ._LogUtil.h KollusBookmark.h KollusContent.h KollusPlayerBookmarkDelegate.h KollusPlayerDelegate.h KollusPlayerDRMDelegate.h KollusPlayerLMSDelegate.h KollusPlayerView.h KollusSDK.h KollusStorage.h KollusStorageDelegate.h KPSection.h LogUtil.h SubTitleInfo.h

クラス文書化

KollusBookmark クラス参照

#import <KollusBookmark.h>
KollusBookmarkの継承ダイヤグラム:

属性

NSTimeInterval position
- ブックマーク位置
NSDate * time
- ブックマーク生成日時
NSString * title
- ブックマークタイトル(index: サービス提供者)
NSString * value
- ブックマークタイトル(ユーザー)
KollusBookmarkKind kind
- ブックマークタイプ

属性文書化

- (KollusBookmarkKind) kind[read], [nonatomic], [assign]
- ブックマークタイプ
- (NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]
- ブックマーク位置
- (NSDate*) time[read], [nonatomic], [unsafe_unretained]
- ブックマーク生成日時
- (NSString*) title[read], [nonatomic], [copy]
- ブックマークタイトル(index: サービス提供者)
- (NSString*) value[read], [nonatomic], [copy]
- ブックマークタイトル(ユーザー)

このクラスの文書化ページは以下のファイルから生成されています。

KollusBookmark.h

KollusContent クラス参照

#import <KollusContent.h>
KollusContentの継承ダイヤグラム:

属性

NSString * company
- 社名
NSString * title
- コンテンツタイトル
NSString * course
- コース名
NSString * teacher
- サービス提供者名
NSString * snapshot
- スナップショットファイル経路
NSString * thumbnail
- サムネイルファイル経路
NSString * mediaContentKey
- メディアコンテンツキー
NSString * synopsis
- シノプシス
NSString * descriptionURL
- 詳細情報URL
CGSize naturalSize
- 映像原本サイズ
KollusContentType contentType
- コンテンツタイプ
NSDate * DRMCheckDate
- DRM チェック日付
NSDate * DRMExpireDate
- DRM 有効期限
long DRMExpireCountMax
- DRM 最大再生回数
long DRMExpireCount
- DRM 再生回数
NSTimeInterval DRMTotalExpirePlayTime
- DRM 全体再生可能時間
NSTimeInterval DRMExpirePlayTime
- DRM 再生可能時間
BOOL DRMExpired
- DRM 有効性可否
BOOL DRMExpireRefreshPopup
- DRM 有効期限更新ポップアップ表示有無
NSTimeInterval duration
- コンテンツの長さ
NSTimeInterval position
- 続き再生位置
NSUInteger contentIndex
- コンテンツ index : ダウンロードコンテンツを再生する際に使用
long long fileSize
- コンテンツファイルサイズ
long long downloadSize
- ダウンロードされたファイルサイズ
NSUInteger downloadProgress
- ダウンロード進行率
BOOL downloaded
- ダウンロード完了有無
int downloadedTime
- ファイルをダウンロードした日付

属性文書化

- (NSString*) company[read], [nonatomic], [copy]
- 社名
- (NSUInteger) contentIndex[read], [nonatomic], [unsafe_unretained]
- コンテンツ index : ダウンロードコンテンツを再生する際に使用
- (KollusContentType) contentType[read], [nonatomic], [unsafe_unretained]
- コンテンツタイプ
- (NSString*) course[read], [nonatomic], [copy]
- コース名
- (NSString*) descriptionURL[read], [nonatomic], [copy]
- 詳細情報URL
- (BOOL) downloaded[read], [nonatomic], [unsafe_unretained]
- ダウンロード完了有無
- (int) downloadedTime[read], [nonatomic], [unsafe_unretained]
- ファイルをダウンロードした日付
- (NSUInteger) downloadProgress[read], [nonatomic], [unsafe_unretained]
- ダウンロード進行率
- (long long) downloadSize[read], [nonatomic], [unsafe_unretained]
- ダウンロードされたファイルサイズ
- (NSDate*) DRMCheckDate[read], [nonatomic], [strong]
- DRM チェック日付
- (long) DRMExpireCount[read], [nonatomic], [unsafe_unretained]
- DRM再生回数
- (long) DRMExpireCountMax[read], [nonatomic], [unsafe_unretained]
- DRM最大再生回数
- (BOOL) DRMExpired[read], [nonatomic], [unsafe_unretained]
- DRM有効性可否
- (NSDate*) DRMExpireDate[read], [nonatomic], [strong]
- DRM有効期限
- (NSTimeInterval) DRMExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- DRM再生可能時間
- (BOOL) DRMExpireRefreshPopup[read], [nonatomic], [unsafe_unretained]
- DRM 有効期限更新ポップアップ有無
- (NSTimeInterval) DRMTotalExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- DRM 全体再生可能時間
- (NSTimeInterval) duration[read], [nonatomic], [unsafe_unretained]
- コンテンツの長さ
- (long long) fileSize[read], [nonatomic], [unsafe_unretained]
- コンテンツのファイルサイズ
- (NSString*) mediaContentKey[read], [nonatomic], [copy]
- メディアコンテンツキー
- (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]
- 映像原本サイズ
- (NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]
- 続き再生位置
- (NSString*) snapshot[read], [nonatomic], [copy]
- スナップショットファイルのパス
- (NSString*) synopsis[read], [nonatomic], [copy]
- シノプシス
- (NSString*) teacher[read], [nonatomic], [copy]
- サービス提供者名
- (NSString*) thumbnail[read], [nonatomic], [copy]
- サムネイルファイルのパス
- (NSString*) title[read], [nonatomic], [copy]
- コンテンツタイトル

このクラスの文書化ページは以下のファイルから生成されています。

KollusContent.h

<KollusPlayerBookmarkDelegate> プロトコル参照

#import <KollusPlayerBookmarkDelegate.h>
<KollusPlayerBookmarkDelegate>の継承ダイヤグラム:

インスタンスメソッド

(void) - kollusPlayerView:bookmark:enabled:error:

メソッド文書化

- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView bookmark: (NSArray *) bookmarks enabled: (BOOL) enabled error: (NSError *) error
- 再生するコンテンツのブックマーク有無をリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  bookmarks
  KollusBookmark 配列
  enabled
  YES: ブックマーク有 NO: ブックマーク無
  error
  エラー内容

このプロトコルの文書化ページは以下のファイルから生成されています。

KollusPlayerBookmarkDelegate.h

<KollusPlayerDelegate> プロトコル参照

#import <KollusPlayerDelegate.h>
<KollusPlayerDelegate>の継承ダイヤグラム:

インスタンスメソッド

(void) - kollusPlayerView:prepareToPlayWithError:
(void) - kollusPlayerView:play:error:
(void) - kollusPlayerView:pause:error:
(void) - kollusPlayerView:buffering:error:
(void) - kollusPlayerView:stop:error:
(void) - kollusPlayerView:position:error:
(void) - kollusPlayerView:scroll:error:
(void) - kollusPlayerView:zoom:error:
(void) - kollusPlayerView:naturalSize:
(void) - kollusPlayerView:playerContentMode:error:
(void) - kollusPlayerView:playerContentFrame:error:
(void) - kollusPlayerView:playbackRate:error:
(void) - kollusPlayerView:repeat:error:
(void) - kollusPlayerView:enabledOutput:error:
(void) - kollusPlayerView:caption:text:position:error:
(void) - kollusPlayerView:unknownError:
(void) - kollusPlayerView:framerate:
(void) - kollusPlayerView:lockedPlayer:
(void) - kollusPlayerView:charset:caption:
(void) - kollusPlayerView:thumbnail:error:
(void) - kollusPlayerView:mck:
(void) - kollusPlayerView:height:

メソッド文書化

- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL) buffering error: (NSError *) error
- システムのデータバッファリングが停滞または停滞が解消された場合にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  buffering
  YES: バッファリング開始
  buffering
  NO: バッファリング終了
  error
  エラー内容
  Remark
  バッファリングがYESに変更される前にシステムからの一時停止デリケートがリクエストされた場合
  バッファリングがNOに変更された場合にはUIでPlayWithError: メソッドをリクエストしてください。
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView caption: (KollusCaption *) caption text: (NSString *) text position: (NSTimeInterval) position error: (NSError *) error
- 字幕を表示する際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  caption
  字幕情報
  text
  表示される字幕の内容
  position
  字幕が表示される位置
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *) charset caption: (char *) caption
- コンテンツの字幕をリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  charset
  キャラクターセット
  caption
  字幕情報
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL) enabledOutput error: (NSError *) error
- 外部ディスプライへの出力許可設定をリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  enabledOutput
  YES: 許可
  enabledOutput
  NO: 禁止
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int) framerate
- コンテンツのフレームレートをリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  framerate
  フレームレート
- (void) kollusPlayerView: (KollusPlayerView *) view height: (int) height
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lockedPlayer: (KollusPlayerType) playerType
- デバイスがロックされた際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  lockedPlayer
  現在のplayerタイプ
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *) mck
- メディアコンテンツキーをリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  mck
  メディアコンテンツキー
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize) naturalSize
- コンテンツの原本映像サイズをリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  contentResolution
  原本のサイズ
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView pause: (BOOL) userInteraction error: (NSError *) error
- 一時停止された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  userInteraction
  YES: ユーザーから一時停止
  userInteraction
  NO: システムから一時停止
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView play: (BOOL) userInteraction error: (NSError *) error
- 再生が開始された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  userInteraction
  YES: ユーザーから開始
  userInteraction
  NO: 全体繰り返しまたはシステムから開始
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playbackRate: (float) playbackRate error: (NSError *) error
- 倍速が変更された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  playbackRate
  変更された倍速
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentFrame: (CGRect) contentFrame error: (NSError *) error
- 再生画面のサイズが変更された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  contentFrame
  変更された画面サイズ
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentMode: (KollusPlayerContentMode) playerContentMode error: (NSError *) error
- 再生画面のモードが変更された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  playerContentMode
  変更された画面モード
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView position: (NSTimeInterval) position error: (NSError *) error
- 再生位置を変更する前後にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  position
  変更された再生位置の時間値
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView prepareToPlayWithError: (NSError *) error
- prepareToPlayリクエスト後にコンテンツの再生準備完了可否をリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  error
  エラー内容
  Remark
  errorがnil以外の場合には再生準備に失敗
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView repeat: (BOOL) repeat error: (NSError *) error
- リピート再生が開始または解除された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  repeat
  YES: リピート再生設定状態に変更
  repeat
  NO: リピート再生解除状態に変更
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView scroll: (CGPoint) distance error: (NSError *) error
- 画面が移動される前後にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  distance
  移動距離
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView stop: (BOOL) userInteraction error: (NSError *) error
- 再生が終了された際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  userInteraction
  YES: ユーザーから終了
  userInteraction
  NO: 最後まで再生完了またはシステムから終了
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView thumbnail: (BOOL) isThumbnail error: (NSError *) error
- サムネイルの非同期ダウンロード完了の際にリクエスト
  パラメータ
  パラメータ
  kollusPlayerView
  KollusPlayerView ID
  thumbnail
  有無
  error
  エラー内容
- (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error

パラメータ
kollusPlayerView	KollusPlayerView ID
bookmarks	KollusBookmark 配列
enabled	YES: ブックマーク有 NO: ブックマーク無
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
buffering	YES: バッファリング開始
buffering	NO: バッファリング終了
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
caption	字幕情報
text	表示される字幕の内容
position	字幕が表示される位置
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
charset	キャラクターセット
caption	字幕情報

パラメータ
kollusPlayerView	KollusPlayerView ID
enabledOutput	YES: 許可
enabledOutput	NO: 禁止
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
framerate	フレームレート

パラメータ
kollusPlayerView	KollusPlayerView ID
lockedPlayer	現在のplayerタイプ

パラメータ
kollusPlayerView	KollusPlayerView ID
mck	メディアコンテンツキー

パラメータ
kollusPlayerView	KollusPlayerView ID
contentResolution	原本のサイズ

パラメータ
kollusPlayerView	KollusPlayerView ID
userInteraction	YES: ユーザーから一時停止
userInteraction	NO: システムから一時停止
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
playbackRate	変更された倍速
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
contentFrame	変更された画面サイズ
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
playerContentMode	変更された画面モード
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
repeat	YES: リピート再生設定状態に変更
repeat	NO: リピート再生解除状態に変更
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
distance	移動距離
error	エラー内容

パラメータ
kollusPlayerView	KollusPlayerView ID
thumbnail	有無
error	エラー内容