最終更新 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>
- UIView
|
クラス索引
クラスリスト
クラス、構造体、共用体、インターフェース
- 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
- 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]
このクラスの文書化ページは以下のファイルから生成されています。
KollusContent クラス参照
#import <KollusContent.h>
KollusContentの継承ダイヤグラム:

属性
- NSString * company
- NSString * title
- NSString * course
- NSString * teacher
- NSString * snapshot
- NSString * thumbnail
- NSString * mediaContentKey
- NSString * synopsis
- NSString * descriptionURL
- CGSize naturalSize
- KollusContentType contentType
- NSDate * DRMCheckDate
- NSDate * DRMExpireDate
- long DRMExpireCountMax
- long DRMExpireCount
- NSTimeInterval DRMTotalExpirePlayTime
- NSTimeInterval DRMExpirePlayTime
- BOOL DRMExpired
- BOOL DRMExpireRefreshPopup
- 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]
- - (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]
- - (long) DRMExpireCount[read], [nonatomic], [unsafe_unretained]
- - (long) DRMExpireCountMax[read], [nonatomic], [unsafe_unretained]
- - (BOOL) DRMExpired[read], [nonatomic], [unsafe_unretained]
- - (NSDate*) DRMExpireDate[read], [nonatomic], [strong]
- - (NSTimeInterval) DRMExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- - (BOOL) DRMExpireRefreshPopup[read], [nonatomic], [unsafe_unretained]
- - (NSTimeInterval) DRMTotalExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- - (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]
このクラスの文書化ページは以下のファイルから生成されています。
<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
- - (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
- - (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
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error
その他のエラーが発生した際にリクエスト
パラメータ |
---|
kollusPlayerView | KollusPlayerView ID |
error | エラー内容 |
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
このプロトコルの文書化ページは以下のファイルから生成されています。
<KollusPlayerDRMDelegate> プロトコル参照
#import <KollusPlayerDRMDelegate.h>
<KollusPlayerDRMDelegate>の継承ダイヤグラム:

インスタンスメソッド
- (void) - kollusPlayerView:request:json:error:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
DRM Callback 転送後にリクエスト
パラメータ |
---|
kollusPlayerView | KollusPlayerView ID |
json | レスポンスされたJSONオブジェクト |
error | エラー内容 |
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerDRMDelegate.h
<KollusPlayerLMSDelegate> プロトコル参照
#import <KollusPlayerLMSDelegate.h>
<KollusPlayerLMSDelegate>の継承ダイヤグラム:

インスタンスメソッド
- (void) - kollusPlayerView:json:error:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView json: (NSDictionary *) json error: (NSError *) error
LMSデータをサーバーに転送してからリクエスト
パラメータ |
---|
kollusPlayerView | KollusPlayerView ID |
json | リクエストしたJSONオブジェクト |
error | エラー内容(nil: 成功) |
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerLMSDelegate.h
KollusPlayerView クラス参照
#import <KollusPlayerView.h>
KollusPlayerViewの継承ダイヤグラム:

インスタンスメソッド
- (id) - initWithContentURL:
- (id) - initWithMediaContentKey:
- (BOOL) - prepareToPlayWithMode:error:
- (BOOL) - playWithError:
- (BOOL) - pauseWithError:
- (BOOL) - stopWithError:
- (BOOL) - scroll:error:
- (BOOL) - scrollStopWithError:
- (BOOL) - zoom:error:
- (BOOL) - addBookmark:value:error:
- (BOOL) - removeBookmark:error:
- (void) - setNetworkTimeOut:
- (void) - setBufferingRatio:
- (BOOL) - isOpened
- (BOOL) - setSkipPlay
- (void) - changeBandWidth:
- (bool) - setSubTitlePath:
- (CGRect) - getVideoPosition
- (CGFloat) - getZoomValue
- (void) - setPauseOnForeground:
属性
- id< KollusPlayerDelegate > delegate
- id< KollusPlayerDRMDelegate > DRMDelegate
- id< KollusPlayerLMSDelegate > LMSDelegate
- id< KollusPlayerBookmarkDelegate > bookmarkDelegate
- KollusStorage * storage
- NSString * contentURL
- 再生するコンテンツ URL (ストリーミング再生)
- NSString * mediaContentKey
- 再生するコンテンツのメディアコンテンツキー (ダウンロード再生)
- KollusContent * content
- NSTimeInterval currentPlaybackTime
- NSTimeInterval liveSeekableDuration
- float currentPlaybackRate
- NSArray * bookmarks
- KollusPlayerContentMode scalingMode
- CGRect playerContentFrame
- KollusPlayerRepeatMode repeatMode
- BOOL screenConnectEnabled
- BOOL bookmarkModifyEnabled
- BOOL debug
- BOOL isPreparedToPlay
- BOOL isPlaying
- BOOL isBuffering
- BOOL isSeeking
- BOOL isScrolling
- BOOL isWaterMark
- BOOL isAudioOnly
- BOOL muteOnStart
- CGSize naturalSize
- BOOL isZoomedIn
- KollusPlayerType playerType
- NSString * customSkin
- KPSection * playSection
- BOOL audioBackgroundPlay
- BOOL lmsOffDownloadContent
- NSUInteger proxyPort
- BOOL intro
- BOOL seekable
- NSInteger nSecSkip
- BOOL isLive
- BOOL disablePlayRate
- NSInteger nSeekableEnd
- 指定されたn秒までまたは現在再生秒までシークすることができる。seekableがfalseの場合のみ適用可能: -1=シーク不可
- NSString * strCaptionStyle
- Partner portalで設定: 字幕スタイル"bg"=字幕背景適用, "bg"以外=ユーザー設定
- BOOL forceNScreen
- BOOL isThumbnailEnable
- BOOL isThumbnailSync
- サムネールダウンロード方式(sync, async)
- NSString * fpsCertURL
- NSString * fpsDrmURL
- NSInteger nOfflineBookmarkUse
- オフラインブックマークはダウンロード再生のみ使用 (0: 使用しない, 1: 使用する)
- NSInteger nOfflineBookmarkDownload
- 1: Indexブックマークのみダウンロード, 2: Indexブックマークとユーザーブックマークを全てダウンロード
- NSInteger nOfflineBookmarkReadOnly
- ブックマーク編集権限の有無 (0: あり-default, 1: なし)
- NSString * strVideoWaterMark
- NSInteger nVideoWaterMarkAlpha
- NSInteger nVideoWaterMarkFontSize
- NSString * strVideoWaterMarkFontColor
- NSInteger nVideoWaterMarkShowTime
- NSInteger nVideoWaterMarkHideTime
- NSString * extraDrmParam
- NSMutableArray * streamInfoList
- NSMutableArray * listSubTitle
メソッド文書化
- - (BOOL) addBookmark: (NSTimeInterval) position value: (NSString *) value error: (NSError **) error
ブックマークを登録する
パラメータ |
---|
position | 追加する位置 |
value | ブックマークのタイトル |
error | エラー内容 |
リターン: YES=登録可能, NO=登録不可
指定したpositionに既にブックマークが登録されている場合、新たに入力したブックマークで入れ替わる。 |
- - (void) changeBandWidth: (int) bandWidth
- HLSストリーミングでbandwidthが変更された際にリクエスト
- - (CGRect) getVideoPosition
- ビデオ領域を取得する
- リターン: CGRect ビデオ再生位置
- - (CGFloat) getZoomValue
- 画面のズームイン/ズームアウト値を取得する
- リターン: CGFloat 画面の拡大/縮小比率値
- - (id) initWithContentURL: (NSString *) url
コンテンツURLを使用してプレーヤーを生成
- リターン: 生成されたPlayer ID
- - (id) initWithMediaContentKey: (NSString *) mck
- - (BOOL) isOpened
- プレーヤー生成有無を取得
- リターン: YES=生成されている, NO=生成されていない
- - (BOOL) pauseWithError: (NSError **) error
一時停止
リターン: YES=成功, NO=失敗
prepareToPlayerWithError メソッドのリクエストに成功してから使用する |
- - (BOOL) prepareToPlayWithMode: (KollusPlayerType) type error: (NSError **) error
- - (BOOL) removeBookmark: (NSTimeInterval) position error: (NSError **) error
ブックマークを削除する
パラメータ |
---|
position | 削除するブックマークの位置 |
error | エラー内容 |
リターン: YES=削除可能, NO=削除不可
ブックマークのkindがKollusBookmarkKindIndexの場合、削除されない |
- - (BOOL) scroll: (CGPoint) distance error: (NSError **) error
ビデオ出力画面を移動
パラメータ |
---|
distance | 移動する距離 |
error | エラー内容 |
- リターン: YES=成功, NO=失敗
- - (BOOL) scrollStopWithError: (NSError **) error
ビデオ出力画面の移動を中止 (画面位置固定)
- リターン: YES=成功, NO=失敗
- - (void) setBufferingRatio: (NSInteger) bufferingRatio
バッファリング倍数を設定
パラメータ |
---|
bufferingRatio | 設定するバッファリング倍数 |
prepareToPlayerWithError メソッドのリクエストに成功してから使用する PlayerTypeKollusのみ使用可能 |
- - (void) setNetworkTimeOut: (NSInteger) timeOut
Playerのネットワークタイムアウト値を設定
パラメータ |
---|
timeOut | タイムアウト値(秒) |
retryCount | リトライ回数 |
- (void) setPauseOnForeground: (BOOL) bPause
- - (BOOL) setSkipPlay
- play listの中で現在再生中のコンテンツをスキップ
- - (bool) setSubTitlePath: (char *) path
字幕ファイルを選択
- リターン: bool true=成功, false=失敗
- - (BOOL) pauseWithError: (NSError **) error
再生中断
リターン: YES=成功, NO=失敗
prepareToPlayerWithError メソッドのリクエストに成功してから使用する |
- - (BOOL) zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
ビデオ出力画面の拡大/縮小
パラメータ |
---|
recognizer | pinchズームを適用するUIPinchGestureRecognizerポインター |
error | エラー内容 |
- リターン: YES=成功, NO=失敗
属性文書化
- - (BOOL) audioBackgroundPlay[read], [write], [nonatomic], [unsafe_unretained]
- - (id) bookmarkDelegate[read], [write], [nonatomic], [weak]
- - (BOOL) bookmarkModifyEnabled[read], [nonatomic], [unsafe_unretained]
- - (NSArray*) bookmarks[read], [write], [nonatomic], [strong]
- - (KollusContent*) content[read], [nonatomic], [weak]
- - (NSString*) contentURL[read], [write], [nonatomic], [copy]
- 再生するコンテンツのURL (ストリーミング再生)
- - (float) currentPlaybackRate[read], [write], [nonatomic], [unsafe_unretained]
再生速度: 最大10倍速まで設定可能
速度が2倍を超える場合、画質低下、ビデオとオーディオのシンクが合わなくなる可能性がある |
- - (NSTimeInterval) currentPlaybackTime[read], [write], [nonatomic], [unsafe_unretained]
- - (NSString*) customSkin[read], [write], [nonatomic], [copy]
- - (BOOL) debug[read], [write], [nonatomic], [unsafe_unretained]
- - (id) delegate[read], [write], [nonatomic], [weak]
- - (BOOL) disablePlayRate[read], [nonatomic], [unsafe_unretained]
- - (id) DRMDelegate[read], [write], [nonatomic], [weak]
- - (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]
- - (BOOL) forceNScreen[read], [nonatomic], [unsafe_unretained]
- - (NSString*) fpsCertURL[read], [write], [nonatomic], [copy]
- - (NSString*) fpsDrmURL[read], [write], [nonatomic], [copy]
- - (BOOL) intro[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isAudioOnly[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isBuffering[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isLive[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isPlaying[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isPreparedToPlay[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isScrolling[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isSeeking[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isThumbnailEnable[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isThumbnailSync[read], [nonatomic], [unsafe_unretained]
- サムネールダウンロード方式(sync, async)
- - (BOOL) isWaterMark[read], [nonatomic], [unsafe_unretained]
- - (BOOL) isZoomedIn[read], [nonatomic], [unsafe_unretained]
- - (NSMutableArray*) listSubTitle[read], [nonatomic], [assign]
- - (NSTimeInterval) liveSeekableDuration[read], [nonatomic], [unsafe_unretained]
- - (id) LMSDelegate[read], [write], [nonatomic], [weak]
- - (BOOL) lmsOffDownloadContent[read], [write], [nonatomic], [unsafe_unretained]
- - (NSString*) mediaContentKey[read], [write], [nonatomic], [assign]
- 再生するコンテンツのメディアコンテンツキー (ダウンロード再生)
- - (BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]
- - (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]
- - (NSInteger) nOfflineBookmarkDownload[read], [nonatomic], [unsafe_unretained]
- 1: Indexブックマークのみダウンロード, 2: Indexブックマークとユーザーブックマークを全てダウンロード
- - (NSInteger) nOfflineBookmarkReadOnly[read], [nonatomic], [unsafe_unretained]
- ブックマーク編集権限の有無 (0: あり-default, 1: なし)
- - (NSInteger) nOfflineBookmarkUse[read], [nonatomic], [unsafe_unretained]
- オフラインブックマークはダウンロード再生のみ使用 (0: 使用しない, 1: 使用する)
- - (NSInteger) nSecSkip[read], [nonatomic], [unsafe_unretained]
- - (NSInteger) nSeekableEnd[read], [nonatomic], [unsafe_unretained]
- 指定されたn秒までまたは現在再生秒までシークすることができる。seekableがfalseの場合のみ適用可能: -1=シーク不可
- - (NSInteger) nVideoWaterMarkAlpha[read], [nonatomic], [unsafe_unretained]
- - (NSInteger) nVideoWaterMarkFontSize[read], [nonatomic], [unsafe_unretained]
- - (NSInteger) nVideoWaterMarkHideTime[read], [nonatomic], [unsafe_unretained]
- - (NSInteger) nVideoWaterMarkShowTime[read], [nonatomic], [unsafe_unretained]
- - (CGRect) playerContentFrame[read], [write], [nonatomic], [unsafe_unretained]
- - (KollusPlayerType) playerType[read], [nonatomic], [assign]
- - (KPSection*) playSection[read], [write], [nonatomic], [assign]
- - (NSUInteger) proxyPort[read], [write], [nonatomic], [unsafe_unretained]
- - (KollusPlayerRepeatMode) repeatMode[read], [write], [nonatomic], [unsafe_unretained]
- - (KollusPlayerContentMode) scalingMode[read], [write], [nonatomic], [unsafe_unretained]
- - (BOOL) screenConnectEnabled[read], [nonatomic], [unsafe_unretained]
- - (BOOL) seekable[read], [nonatomic], [unsafe_unretained]
- - (KollusStorage*) storage[read], [write], [nonatomic], [weak]
- - (NSString*) strCaptionStyle[read], [nonatomic], [copy]
- Partner portalで設定: 字幕スタイル"bg"=字幕背景適用, "bg"以外=ユーザー設定
- - (NSMutableArray*) streamInfoList[read], [nonatomic], [assign]
- - (NSString*) strVideoWaterMark[read], [nonatomic], [copy]
- - (NSString*) strVideoWaterMarkFontColor[read], [nonatomic], [copy]
このクラスの文書化ページは以下のファイルから生成されています。
KollusStorage クラス参照
#import <KollusContent.h>
KollusStorageの継承ダイヤグラム:

インスタンスメソッド
- (BOOL) - startStorage:
- (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
属性
- id< KollusStorageDelegate > delegate
- NSString * applicationVersion
- NSString * applicationDeviceID
- NSString * applicationKey
- KollusSDK 認証キー (カテノイドから発行されたキー)
- NSString * applicationBundleID
- アプリケーション Bundle ID (ex:com.yourcompany.applicationname)
- NSString * keychainGroup
- keychain グループ (ex:com.yourcompany.shared)
- NSDate * applicationExpireDate
- KollusSDK 有効期限 (カテノイドから発行されたキーの有効期限)
- long long storageSize
- ダウンロードしたコンテンツの全体サイズ (bytes)
- long long cacheDataSize
- NSInteger serverPort
- NSString * extraDrmParam
- NSString * appUserAgent
- NSString * deviceType
- デバイスタイプ (kp-mobile, kp-tablet)
メソッド文書化
- - (NSString*) checkContentURL: (NSString *) URL error: (NSError **) error
- - (NSMutableArray*) contents
- - (BOOL) downloadCancelContent: (NSString *) mediaContentKey error: (NSError **) error
コンテンツ ダウンロードを中止
パラメータ |
---|
mediaContentKey | ダウンロードを中止するコンテンツのメディアコンテンツキー |
error | エラー内容 |
- リターン: YES=成功, NO=失敗
- - (BOOL) downloadContent: (NSString *) mediaContentKey error: (NSError **) error
- - (NSString *) loadContentURL: (NSString *) URL error: (NSError **) error
コンテンツ ダウンロードを初期化
パラメータ |
---|
url | ダウンロードを初期化するコンテンツのURL |
error | エラー内容 |
- リターン: ダウンロード初期化が完了されたコンテンツのメディアコンテンツキー
- - (BOOL) removeCacheWithError: (NSError **) error
- - (BOOL) removeContent: (NSString *) mediaContentKey error: (NSError **) error
指定したコンテンツを削除する。
パラメータ |
---|
mediaContentKey | 削除するコンテンツのメディアコンテンツキー |
error | エラー内容 |
- リターン: YES=成功, NO=失敗
- - (void) sendStoredLms
- - (void) setBackgroundDownload: (BOOL) bBackground
- ストレージのコンテンツのバックグラウンドダウンロード設定の有無
- - (void) setCacheSize: (NSInteger) cacheSizeMB
ストレージのキャッシュサイズを設定する。
パラメータ |
---|
cacheSizeMB | ストリーミングコンテンツのキャッシュサイズ(Mega Bytes) |
- - (void) setNetworkTimeOut: (NSInteger) timeOut retry: (NSInteger) retryCount
ストレージのネットワークタイムアウト値を設定
パラメータ |
---|
timeOut | タイムアウト値(秒) |
retryCount | リトライ回数 |
- - (BOOL) startStorage: (NSError **) error
KollusStorageを開始する。
リターン: YES=成功, NO=失敗
このメソッドをリクエストしない場合、コンテンツ情報配列(contents)がnilでリターンされる。 |
- - (void) updateDownloadDRMInfo: (BOOL) bAll
DRMコンテンツリストを更新
パラメータ |
---|
expired | YES=全てのコンテンツ, NO=有効期限切れのコンテンツのみ |
属性文書化
- - (NSString*) applicationBundleID[read], [write], [nonatomic], [copy]
- - (NSString*) applicationDeviceID[read], [nonatomic], [copy]
- - (NSDate*) applicationExpireDate[read], [write], [nonatomic], [copy]
- KollusSDK 有効期限 (カテノイドから発行されたキーの有効期限)
- - (NSString*) applicationKey[read], [write], [nonatomic], [copy]
- KollusSDK 認証キー (カテノイドから発行されたキー)
- - (NSString*) applicationVersion[read], [nonatomic], [copy]
- - (NSString*) appUserAgent[read], [nonatomic], [copy]
- - (long long) cacheDataSize[read], [nonatomic], [unsafe_unretained]
- - (id) delegate[read], [write], [nonatomic], [weak]
- - (NSString*) deviceType[read], [nonatomic], [copy]
- デバイスタイプ (kp-mobile, kp-tablet)
- - (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]
- - (NSString*) keychainGroup[read], [write], [nonatomic], [copy]
- keychain グループ (ex:com.yourcompany.shared)
- - (NSInteger) serverPort[read], [write], [nonatomic], [assign]
- - (long long) storageSize[read], [nonatomic], [unsafe_unretained]
- ダウンロードしたコンテンツの全体サイズ (bytes)
このクラスの文書化ページは以下のファイルから生成されています。
<KollusStorageDelegate> プロトコル参照
#import <KollusStorageDelegate.h>
<KollusStorageDelegate>の継承ダイヤグラム:

インスタンスメソッド
- (void) - kollusStorage:downloadContent:error:
- (void) - kollusStorage:request:json:error:
- (void) - kollusStorage:cur:count:error:
- (void) - kollusStorage:lmsData:resultJson:
- (void) - onSendCompleteStoredLms:failCount:
メソッド文書化
- - (void) kollusStorage: (KollusStorage *) kollusStorage cur: (int) cur count: (int) count error: (NSError *) error
- - (void) kollusStorage: (KollusStorage *) kollusStorage downloadContent: (KollusContent *) content error: (NSError *) error
- - (void) kollusStorage: (KollusStorage *) kollusStorage lmsData: (NSString *) lmsData resultJson: (NSDictionary *) resultJson
LMS Callbackの処理後にリクエスト
パラメータ |
---|
KollusStorage | KollusStorage ID |
lmsData | LMSデータ情報 |
lmsResult | LMS結果情報 |
- - (void) kollusStorage: (KollusStorage *) kollusStorage request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
DRM Callbackの処理後にリクエスト
パラメータ |
---|
KollusStorage | KollusStorage ID |
request | リクエスト情報 |
json | レスポンスされたJSON |
error | エラー内容: nilではない場合エラー発生 |
- - (void) onSendCompleteStoredLms: (int) successCount failCount: (int) failCount
残っているLMSデータを転送してからリクエスト
パラメータ |
---|
successCount | 転送成功回数 |
failCount | 転送失敗回数 |
このプロトコルの文書化ページは以下のファイルから生成されています。
KPSection クラス参照
#import <KPSection.h>
KPSectionの継承ダイヤグラム:

属性
- NSInteger startTime
- NSInteger endTime
属性文書化
- - (NSInteger) endTime[read], [write], [nonatomic], [unsafe_unretained]
- - (NSInteger) startTime[read], [write], [nonatomic], [unsafe_unretained]
このクラスの文書化ページは以下のファイルから生成されています。
LogUtil クラス参照
#import <LogUtil.h>
LogUtilの継承ダイヤグラム:

クラスメソッド
- (instancetype) + sharedUtil
- (void) + utilLog:
メソッド文書化
- + (instancetype) sharedUtil
- + (void) utilLog: (NSString *) logContent , ...
属性文書化
- - (id) utilDelegate[read], [write], [nonatomic], [weak]
このクラスの文書化ページは以下のファイルから生成されています。
SubTitleInfo クラス参照
#import <SubTitleInfo.h>
SubTitleInfoの継承ダイヤグラム:

属性
- NSString * strName
- NSString * strUrl
- NSString * strLanguage
書斎説明
字幕の情報
属性文書化
- - (NSString*) strLanguage[read], [write], [nonatomic], [retain]
- - (NSString*) strName[read], [write], [nonatomic], [retain]
- - (NSString*) strUrl[read], [write], [nonatomic], [retain]
このクラスの文書化ページは以下のファイルから生成されています。
<UtilDelegate> プロトコル参照
#import <LogUtil.h>
<UtilDelegate>の継承ダイヤグラム:

インスタンスメソッド
メソッド文書化
- - (void) onLogUtil: (NSString *) logData[required]
このプロトコルの文書化ページは以下のファイルから生成されています。
ファイル文書化
._KollusPlayerLMSDelegate.h ファイル参照
変数
変数文書化
._LogUtil.h ファイル参照
変数
変数文書化
KollusBookmark.h ファイル参照
#import "KollusSDK.h"
クラス
関数
- typedef NS_ENUM (NSInteger, KollusBookmarkKind)
KollusContent.h ファイル参照
#import "KollusSDK.h"
KollusPlayerBookmarkDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerBookmarkDelegate>
KollusPlayerDelegate.h ファイル参照
クラス
- protocol <KollusPlayerDelegate>
KollusPlayerDRMDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerDRMDelegate>
KollusPlayerLMSDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerDRMDelegate>
KollusPlayerView.h ファイル参照
#import <AVFoundation/AVFoundation.h>
#import "KollusSDK.h"
#import "KollusPlayerDelegate.h"
#import "KollusPlayerDRMDelegate.h"
#import "KollusPlayerLMSDelegate.h"
#import "KollusPlayerBookmarkDelegate.h"
#import "KPSection.h"
クラス
KollusSDK.h ファイル参照
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
関数
- typedef NS_ENUM (NSInteger, KollusPlayerType)
- typedef NS_ENUM (NSInteger, KollusContentType)
- typedef NS_ENUM (NSInteger, KollusPlayerContentMode)
- typedef NS_ENUM (NSInteger, KollusPlayerRepeatMode)
関数文書化
- typedef NS_ENUM (NSInteger , KollusPlayerType )
- プレーヤータイプ
- Kollus Player
- Native player
- HLS player
- typedef NS_ENUM (NSInteger , KollusContentType )
- typedef NS_ENUM (NSInteger , KollusPlayerContentMode )
- typedef NS_ENUM (NSInteger , KollusPlayerRepeatMode )
KollusStorage.h ファイル参照
#import <AVKit/AVKit.h>
#import "KollusSDK.h"
#import "KollusStorageDelegate.h"
クラス
KollusStorageDelegate.h ファイル参照
クラス
KPSection.h ファイル参照
#import <Foundation/Foundation.h>
クラス
LogUtil.h ファイル参照
#import <Foundation/Foundation.h>
クラス
- class LogUtil
- protocol <UtilDelegate>
SubTitleInfo.h ファイル参照
#import <Foundation/Foundation.h>
クラス