最終更新: 2024.08.29_Review

iOS API References

API文書情報

• バージョン：2.3.16
• 日付：2024.8.29

KollusBookmarkクラス参照

#Import <KollusBookmark.h>

属性

NSTimeIntervalPosition

ブックマーク 時間

NSDate *Time

ブックマーク 生成された 日時

NSString *Title

ブックマーク タイトル(インデックス:講師用）

NSString *Value

ブックマーク タイトル(ユーザー）

KollusBookmarkKindKind

ブックマーク 種類

属性文書化

·         (KollusBookmarkKind) kind[read], [nonatomic], [assign]

ブックマークの種類

·         (NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]

ブックマークの時間

·         (NSDate*) time[read], [nonatomic], [unsafe_unretained]

ブックマーク生成された日時

·         (NSString*) title[read], [nonatomic], [copy]

ブックマークタイトル(インデックス：講師用）

·         (NSString*) value[read], [nonatomic], [copy]

ブックマークタイトル（ユーザー）

KollusChatクラス参照

#Import <KollusChat.h>

属性

BOOLisChatVisible

チャット 画面 表示 チェック

BOOLisChatInfo

チャット 情報 有無 チェック

NSString *chatUrl

チャットUrl

BOOLisAdmin

管理者か否か

BOOLisAnonymous

匿名か否か

NSString *roomId

ルームID

NSString *chattingServer

チャット サーバー

NSString *userId

ユーザーID

NSString *nickName

ニックネーム

NSString *photoUrl

フォトUrl

属性文書化

·         (NSString*) chattingServer[read], [write], [nonatomic], [copy]

チャットサーバー

·         (NSString*) chatUrl[read], [write], [nonatomic], [copy]

チャットUrl

·         (BOOL) isAdmin[read], [write], [nonatomic], [unsafe_unretained]

管理者か否か

·         (BOOL) isAnonymous[read], [write], [nonatomic], [unsafe_unretained]

匿名か否か

·         (BOOL) isChatInfo[read], [write], [nonatomic], [unsafe_unretained]

チャット情報有無チェック

·         (BOOL) isChatVisible[read], [write], [nonatomic], [unsafe_unretained]

チャット画面見せるかチェック

·         (NSString*) nickName[read], [write], [nonatomic], [copy]

ニックネーム

·         (NSString*) photoUrl[read], [write], [nonatomic], [copy]

フォトURL

·         (NSString*) roomId[read], [write], [nonatomic], [copy]

ルームID

·         (NSString*) userId[read], [write], [nonatomic], [copy]

ユーザーID

KollusContentクラス参照

#Import <KollusContent.h>

属性

NSString *Company

会社名

NSString *Title

コンテンツ タイトル

NSString *Course

コース名

NSString *Teacher

講師名

NSString *Snapshot

スナップショット ファイル 経路

NSString *Thumbnail

サムネイル ファイル 経路

NSString *mediaContentKey

メディア コンテンツ キー

NSString *Synopsis

シノプシス

NSString *descriptionURL

詳細情報URL

CGSizenaturalSize

映像 原本 サイズ

NSString *iosPlayerType

プレイヤー タイプ:Hw、sw、native

KollusContentTypecontentType

コンテンツ タイプ

NSDate *DRMCheckDate

DRMチェック日時

NSDate *DRMExpireDate

DRM満了日時

LongDRMExpireCountMax

DRM最大 カウント

LongDRMExpireCount

DRM再生 カウント

NSTimeIntervalDRMTotalExpirePlayTime

DRM全体 再生可能 時間

NSTimeIntervalDRMExpirePlayTime

DRM再生可能 時間

BOOLDRMExpired

DRM満了か否か

BOOLDRMExpireRefreshPopup

DRM有効期限 更新 ポップアップか否か

NSTimeIntervalDuration

コンテンツDuration

NSTimeIntervalPosition

つなげる 時間

NSUIntegercontentIndex

コンテンツ インデックス:ダウンロード コンテンツ 再生時 使用

Long longfileSize

コンテンツ ファイル サイズ

Long longdownloadSize

ダウンロード なった ファイル サイズ

NSUIntegerdownloadProgress

ダウンロード パーセント

BOOLDownloaded

ダウンロード 完了か否か

Long longdownloadStopSize

ダウンロード 静止した ファイル サイズ

IntdownloadedTime

ファイル ダウンロード 日時

属性文書化

·         (NSStRing*) company[read], [nonatomic], [copy]

会社名

·         (NSUInteger) contentIndex[read], [nonatomic], [unsafe_unretained]

コンテンツインデックス：ダウンロードコンテンツ再生時使用

·         (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]

ダウンロードしたファイルサイズ

·         (Long long) downloadStopSize[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]

コンテンツ duration

·         (Long long) fileSize[read], [nonatomic], [unsafe_unretained]

コンテンツファイルサイズ

·         (NSString*) iosPlayerType[read], [nonatomic], [copy]

プレイヤータイプ :Hw、sw、native

·         (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>

インスタンスメソッド

(Void) -kollusPlayerView:bookmark:Enabled:error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewBookmark: (NSArray *)BookmarksEnabled: (BOOL)EnabledError: (NSError *)Error

再生コンテンツのブックマークの有無を呼び出し

パラメーター:

<KollusPlayerDelegate>プロトコル参照

#Import <KollusPlayerDelegate。H>

インスタンスメソッド

(Void) -kollusPlayerView:prepareToPlayWithError:

(Void) -kollusPlayerView:play:Error:

(Void) -kollusPlayerView:pause:Error:

(Void) -kollusPlayerView:buffering:Prepared: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:unknownError:

(Void) -kollusPlayerView:framerate:

(Void) -kollusPlayerView:lockedPlayer:

(Void) -kollusPlayerView:charset:Caption:

(Void) -kollusPlayerView:charsetSub:captionSub:

(Void) -kollusPlayerView:thumbnail:Error:

(Void) -kollusPlayerView:mck:

(Void) -kollusPlayerView:height:

(Void) -kollusPlayerView:bitrate:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *)ViewBitrate: (Int)Bitrate

HLSコンテンツbitrate値転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewBuffering: (BOOL)BufferingPrepared: (BOOL)PreparedError: (NSError *)Error

システムのデータバッファリングが停滞または停滞が解消された場合に転送

パラメーター:

Remarks:

buffering値がYESに変更される前にシステムによる一時停止デリゲートが呼び出された場合、buffering値がNOに変更された場合、UIでPlayWithError:メソッドの呼び出しが必要。

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewCharset: (char *）CharsetCaption: (char *)Caption

コンテンツの字幕転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewcharsetSub: (char *）charsetSubcaptionSub: (char *)captionSub

コンテンツの サブ字幕 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewenabledOutput: (BOOL)enabledOutputError: (NSError *)Error

テレビ出力 許容 コンテンツ 属性 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewFramerate: (Int)Framerate

コンテンツの フレームレート 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)ViewHeight: (Int)Height

HLSコンテンツ 再生中のResolution転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewlockedPlayer: (KollusPlayerType)playerType

デバイス ロック 発生時 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewMck: (NSString *）Mck

メディア コンテンツ キーを 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewnaturalSize: (CGSize）naturalSize

コンテンツの 原本 映像サイズ 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPause: (BOOL)userInteractionError: (NSError *)Error

一時停止 なった 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPlay: (BOOL)userInteractionError: (NSError *)Error

再生が 始まった 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplaybackRate: (float)playbackRateError: (NSError *)Error

再生速度が 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplayerContentFrame: (CGRect)contentFrameError: (NSError *)Error

再生画面 サイズが 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplayerContentMode: (KollusPlayerContentMode)playerContentModeError: (NSError *)Error

再生画面 モードが 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPosition: (NSTimeInterval)PositionError: (NSError *)Error

再生位置が 変更される 前後に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewprepareToPlayWithError: (NSError *)errorprepareToPlay

呼び出し 後 コンテンツ 再生準備 完了か否かを 転送

パラメーター:

Remarks:

Errorがnilでない場合、再生準備失敗

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewRepeat: (BOOL)RepeatError: (NSError *)Error

繰り返し再生モードが変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewScroll: (CGPoint)DistanceError: (NSError *)Error

映像画面 移動 動作 前後に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewStop: (BOOL)userInteractionError: (NSError *)Error

再生が 静止した 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewThumbnail: (BOOL)isThumbnailError: (NSError *)Error

サムネイル 非同期 ダウンロード 完了を 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewunknownError: (NSError *)Error

ギターエラー 発生時 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewZoom: (UIPinchGestureRecognizer *)RecognizerError: (NSError **)Error

ビデオ 出力画面 拡大/縮小 前後に 転送

パラメーター:

戻り値：

YES成功

NO失敗

<KollusPlayerDRMDelegate>プロトコル参照

#Import <KollusPlayerDRMDelegate.h>

インスタンスメソッド

(Void) -kollusPlayerView:request:Json:error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewRequest: (NSDictionary *)RequestJson: (NSDictionary *)JsonError: (NSError *)Error

DRM Callback転送後呼び出し

パラメーター:

<KollusPlayerLMSDelegate>プロトコル参照

#Import <KollusPlayerLMSDelegate.h>

インスタンスメソッド

(Void) -kollusPlayerView:json:Error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewJson: (NSDictionary *)JsonError: (NSError *)Error

LMS情報をサーバーに転送してから呼び出し

パラメーター:

KollusPlayerViewクラス参照

#Import <KollusPlayerView.h>

インスタンスメソッド

(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:

(Bool) -setSubTitleSubPath:

(CGRect) -getVideoPosition

(CGFloat) -getZoomValue

(Void) -setPauseOnForeground:

(Void) -setDisableZoomOut:

(Void) -setDecoder:

(Void) -setAIRate:

属性

Id<KollusPlayerDelegate>Delegate

プレイヤー 関連 デリゲート

Id<KollusPlayerDRMDelegate>DRMDelegate

DRM情報 関連 デリゲート

Id<KollusPlayerLMSDelegate>LMSDelegate

LMS情報 関連 デリゲート

Id<KollusPlayerBookmarkDelegate>bookmarkDelegate

Bookmark関連 デリゲート

KollusStorage*Storage

KollusStorage ポインタ

NSString *contentURL

再生する コンテンツURL(Stream Play)

NSString *mediaContentKey

再生する コンテンツMedia Content Key (Local Play)

KollusContent*Content

使用中の コンテンツ 情報

BOOLAIRateEnable

AI倍速 サポートか否か

NSTimeIntervalcurrentPlaybackTime

コンテンツ 現在の時間

NSTimeIntervalliveDuration

ライブ タイムシフトDuration

FloatcurrentPlaybackRate

NSArray *Bookmarks

ブックマーク 情報 配列

KollusPlayerContentModescalingMode

コンテンツ 出力 モード

CGRectplayerContentFrame

プレイヤー 画面 領域

KollusPlayerRepeatModerepeatMode

全体繰り返し モード

BOOLscreenConnectEnabled

画面出力 許容か否か

BOOLbookmarkModifyEnabled

ブックマーク 修正権限か否か

BOOLDebug

デバッグ ログ 出力か否か

BOOLisPreparedToPlay

再生準備 完了か否か

BOOLisPlaying

再生中か否か

BOOLisBuffering

バッファリング 進行するか否か

BOOLisSeeking

探索中か否か

BOOLisScrolling

画面同中か否か

BOOLisWaterMark

Audio water markか否か

BOOLisAudioOnly

オーディオ コンテンツか否か

BOOLmuteOnStart

開始時Muteか否か

CGSizenaturalSize

オリジナルコンテンツ 映像サイズ

BOOLisZoomedIn

Zoom inか否か

KollusPlayerTypeplayerType

プレイヤー タイプ

NSString *customSkin

プレイヤー スキン情報JSON Data

KPSection*playSection

プレビュー 情報

NSIntegernRepeatStartTime

Repeat Start Time。

NSIntegernRepeatEndTime

Repeat End Time。

BOOLaudioBackgroundPlay

バックグラウンド オーディオファイル 再生

BOOLlmsOffDownloadContent

ダウンロード コンテンツLms off

NSUIntegerproxyPort

Proxy Server Port指定

BOOLIntro

イントロか否か

BOOLSeekable

Seek可否

NSIntegernSecSkip

与えられたN初後にSkip

BOOLisLive

Liveか否か

BOOLdisablePlayRate

倍速 コントロール 可能か否か

NSIntegernSeekableEnd

NSString *strCaptionStyle

Partner portalで設定: 字幕スタイル"bg"=字幕背景適用, "bg"以外=ユーザー設定

BOOLforceNScreen

必ず続きから再生

BOOLisThumbnailEnable

サムネイル 使用か否か

BOOLisThumbnailSync

サムネイル ダウンロード 方式(Sync, async)

NSString *fpsCertURL

FairPlay認証URL。

NSString *fpsDrmURL

FairPlay DRM URL。

NSIntegernOfflineBookmarkUse

NSIntegernOfflineBookmarkDownload

1:indexブックマークのみ ダウンロード, 2:index/ユーザーブックマークを全てダウンロード

NSIntegernOfflineBookmarkReadOnly

追加/削除 使用か否か( 0:使用(デフォルト値)、1:使用 しない）

NSString *strVideoWaterMark

NSIntegernVideoWaterMarkAlpha

ビデオ ウォーターマーク アルファ 値

NSIntegernVideoWaterMarkFontSize

ビデオ ウォーターマーク フォント 大きさ

NSString *strVideoWaterMarkFontColor

ビデオ ウォーターマーク カラー

NSIntegernVideoWaterMarkShowTime

ビデオ ウォーターマーク 表示 時間

NSIntegernVideoWaterMarkHideTime

ビデオ ウォーターマーク 非表示 時間

NSString *extraDrmParam

動的Drmパラメータ

NSMutableArray *streamInfoList

HLS ABR Information.

KollusChat*kollusChat

ライブ チャット

NSIntegernextEpisodeShowTime

次の動画再生 表示時間

NSString *nextEpisodeCallbackUR次の動画再生 再生URL

NSMutableDictionary *nextEpisodeCallbackParams

次の動画再生 再生Params

NSMutableArray *listSubTitle

字幕 ファイル リスト

NSMutableArray *listSubTitleSub

サブ字幕 ファイル リスト

メソッド文書化

·         (BOOL) addBookmark: (NSTimeInterval)PositionValue: (NSString *)ValueError: (NSError **)Error

ブックマーク追加

パラメーター:

戻り値：

YES追加可能

NO追加不可能

警告:

すでに同じpositionのブックマークが存在する場合、入力されたブックマークに置き換えられる

·         (Void) changeBandWidth: (Int)bandWidth

HLS再生中のbandwidth変更

·         (CGRect) getVideoPosition

ビデオ領域

戻り値：

CGRectビデオ再生位置

·         (CGFloat)getZoomValue

ビデオ出力画面の拡大/縮小値

戻り値：

CGFloat出力画面の拡大/縮小比率の値

·         (Id) initWithContentURL: (NSString *）Url

コンテンツURLを使ってプレイヤーを生成

パラメーター:

戻り値：

生成されたプレイヤーID

·         (Id) initWithMediaContentKey: (NSString *）Mck

コンテンツインデックスを使ってプレイヤーを生成（ダウンロードしたコンテンツの場合に使用）

パラメーター:

戻り値：

生成されたプレイヤーID

·         (BOOL) isOpened

プレイヤー生成の可否確認

戻り値：

YES生成済み

NO生成できない

·         (BOOL) pauseWithError: (NSError **）Error

一時停止

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

·         (BOOL) playWithError: (NSError **）Error

再生開始

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

·         (BOOL) prepareToPlayWithMode: (KollusPlayerType)TypeError: (NSError **)Error

コンテンツ再生準備 (KollusPlayer or Native)

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) removeBookmark: (NSTimeInterval)PositionError: (NSError **)Error

ブックマークの削除

パラメーター:

戻り値：

YES削除可能

NO削除不可能

警告:

ブックマークの種類が KollusBookmarkKindIndex であるブックマークは削除されません

·         (BOOL) scroll: (CGPoint)distanceError: (NSError **)Error

ビデオ出力画面を移動

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) scrollStopWithError: (NSError **）Error

ビデオ出力画面の移動停止(画面位置固定)

パラメーター:

戻り値：

YES成功

NO失敗

·         (Void) setAIRate: (Bool)bAIRate

AI倍速使用設定

パラメーター:

·         (Void) setBufferingRatio: (NSInteger)bufferingRatio

バッファリン倍数 設定

パラメーター:

警告:

prepareToPlayerWithErrorメソッド呼び出しと成功した場合に使用

PlayerTypeKollusの場合のみ適用されます。

·         (Void) setDecoder: (Bool)bHW

コーデックの設定

パラメーター:

·         (Void) setDisableZoomOut: (BOOL)bDisable

Zoom機能からZoom out機能を 止めるAPI

パラメーター:

·         (Void) setNetworkTimeOut: (NSInteger)timeOut

プレイヤー ネットワーク タイムアウト 設定

パラメーター:

·         (Void) setPauseOnForeground: (BOOL)bPause

Foreground状態で 変更時Player再生状態をPauseで 維持する のためのAPI

パラメーター:

·         (BOOL) setSkipPlay

Play listの中で現在再生中の動画をスキップ

·         (Bool) setSubTitlePath: (char *）Path

字幕ファイルの選択

パラメーター:

戻り値：

 Bool True:成功 False:失敗

·         (Bool) setSubTitleSubPath: (char *）Path

サブ字幕ファイルの選択

パラメーター:

戻り値：

 Bool True:成功 False:失敗

·         (BOOL) stopWithError: (NSError **）Error

再生停止

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッド呼び出しと成功した場合に使用

·         (BOOL) zoom: (UIPinchGestureRecognizer *）recognizer Error: (NSError **)Error

ビデオ出力画面の拡大/縮小

パラメーター:

戻り値：

YES成功

NO失敗

属性文書化

·         (BOOL) AIRateEnable[read]、[write]、[nonatomic]、[unsafe_unretained]

AI配属支援のか否か

·         (BOOL) audioBackgroundPlay[read], [write], [nonatomic], [unsafe_unretained]

バックグラウンドオーディオファイルの再生

·         (id<KollusPlayerBookmarkDelegate>) 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(Stream Play)

·         (Float) currentPlaybackRate[read], [wrIte]、[nonatomic]、[unsafe_unretained]

コンテンツの再生速度10倍速まで対応。 警告： 2倍速を超えると品質が低下し、オーディオ、ビデオのシンクが合わない可能性があります

·         (NSTimeInterval) currentPlaybackTime[read], [write], [nonatomic], [unsafe_unretained]

コンテンツの現在時間

·         (NSString*) customSkin[read], [write], [nonatomic], [copy]

プレイヤースキン情報JSON Data

·         (BOOL) debug[read], [write], [nonatomic], [unsafe_unretained]

デバッグログ出力のか否か

·         (id<KollusPlayerDelegate>) delegate[read], [write], [nonatomic], [weak]

プレイヤー関連のデリゲート

·         (BOOL) disablePlayRate[read], [nonatomic], [unsafe_unretained]

倍速コントロールの可否

·         (id<KollusPlayerDRMDelegate>) DRMDelegate[read], [write], [nonatomic], [weak]

DRM情報関連のデリゲート

·         (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]

動的drmパラメータ

·         (BOOL) forceNScreen[read], [nonatomic], [unsafe_unretained]

強制継続

·         (NSString*) fpsCertURL[read], [write], [nonatomic], [copy]

FairPlay認証URL。

·         (NSString*) fpsDrmURL[read], [write], [nonatomic], [copy]

FairPlay DRM URL。

·         (BOOL) intro[read], [nonatomic], [unsafe_unretained]

イントロか否か

·         (BOOL) isAudioOnly[read], [nonatomic], [unsafe_unretained]

オーディオコンテンツか否か

·         (BOOL) isBuffering[read], [nonatomic], [unsafe_unretained]

バッファリングが進行するか否か

·         (BOOL) isLive[read], [nonatomic], [unsafe_unretained]

Liveか否か

·         (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]

Audio water markか否か

·         (BOOL) isZoomedIn[read], [nonatomic], [unsafe_unretained]

Zoom inか否か

·         (KollusChat*) kollusChat[read], [write], [nonatomic], [assign]

ライブチャット

·         (NSMutableArray*) listSubTitle[read], [nonatomic], [assign]

字幕ファイルリスト

·         (NSMutableArray*) listSubTitleSub[read], [nonatomic], [assign]

サブ字幕ファイルリスト

·         (NSTimeInterval) liveDuration[read], [nonatomic], [unsafe_unretained]

ライブタイムシフト Duration

·         (id<KollusPlayerLMSDelEgate>) LMSDelegate[read], [write], [nonatomic], [weak]

LMS情報に関するデリゲート

·         (BOOL) lmsOffDownloadContent[read], [write], [nonatomic], [unsafe_unretained]

ダウンロードコンテンツlms off

·         (NSString*) mediaContentKey[read], [write], [nonatomic], [assign]

再生するコンテンツ Media Content Key (Local Play)

·         (BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]

開始時にmuteか否か

·         (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]

オリジナルコンテンツの映像サイズ

·         (NSMutableDicTionary*) nextEpisodeCallbackParams[read], [nonatomic], [assign]

次の回再生 Params

·         (NSString*) nextEpisodeCallbackURL[read], [nonatomic], [copy]

次の回再生URL

·         (NSInteger) nextEpisodeShowTime[read], [nonatomic], [unsafe_unretained]

次の回再生 Show Time

·         (NSInteger) nOfflineBookmarkDownload[read], [nonatomic], [unsafe_unretained]

1:インデックスのみダウンロード、2:インデックス/ブックマークすべてダウンロード

·         (NSInteger) nOfflineBookmarkReadOnly[read], [nonatomic], [unsafe_unretained]

追加/削除の使用 か否か( 0:使用(デフォルト)、1:使用しない)

·         (NSInteger) nOfflineBookmarkUse[read], [nonatomic], [unsafe_unretained]

オフラインブックマークはダウンロードコンテンツのみ使用 0: 使用しない, 1: 使用

·         (NSInteger) nRepeatEndTime[read], [nonatomic], [unsafe_unretained]

Repeat End Time。

·         (NSInteger) nRepeatStartTime[read], [nonatomic], [unsafe_unretained]

Repeat Start Time。

·         (NSInteger) nSecSkip[read], [nonatomic], [unsafe_unretained]

与えられたn秒後にスキップ

·         (NSInteger) nSeekableEnd[read], [nonatomic], [unsafe_unretained]

与えられたn秒まで、または現在の再生秒までシークできます。シークブルが falseの場合のみ適用 -1 : Seekできない（シークシーできない）

·         (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]

Proxy Server Portの指定

·         (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]

Seekできるか

·         (KollusStorage*) storage[read], [write], [nonatomic], [weak]

KollusStorageポインタ

·         (NSString*) strCaptionStyle[read], [nonatomic], [copy]

パートナーポータルの設定値段：字幕スタイル「bg」：字幕背景適用、「bg」でなければユーザー設定、

·         (NSMutableArray*) streamInfoList[read], [nonatomic], [assign]

HLS ABR Information.

·         (NSString*) strVideoWaterMark[read], [nonatomic], [copy]

ビデオウォーターマークビデオウォーターマーク文字

·         (NSString*) strVideoWaterMarkFontColor[read], [nonatomic], [copy]

ビデオウォーターマークカラー

KollusStorageクラス参照

#Import <KollusStorage.h>

インスタンスメソッド

(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

属性

Id<KollusStorageDelegate>Delegate

ダウンロード 状態情報 デリゲート

NSString *applicationVersion

KollusSDKバージョン

NSString *applicationDeviceID

KollusPlayer Device ID。

NSString *applicationKey

KollusSDK認証 キー(カテノイドで 発行）

NSString *applicationBundleID

アプリケーションBundle ID(ex:com.yourcompany.applicationname)

NSString *keychainGroup

Keychainグループ(Ex:com.yourcompany.shared)

NSDate *applicationExpireDate

KollusSDK有効日付(カテノイドで 発行）

Long longstorageSize

ダウンロード コンテンツ  サイズ(Bytes)

Long longcacheDataSize

キャッシュデータ サイズ(Bytes)

NSIntegerserverPort

Hybrid Appで 使われるPort番号

NSString *extraDrmParam

動的Drmパラメータ

NSString *appUserAgent

UserAgent。

NSString *deviceType

デバイスType(kp-mobile, kp-tablet)

メソッド文書化

·         (NSString*) checkContentURL: (NSString *）URLError: (NSError **)Error

コンテンツのダウンロードチェック：渡されたURLに該当するコンテンツのダウンロードの有無及びMCKを確認するために使用

パラメーター:

戻り値：

ダウンロード完了したコンテンツmedia content key

·         (NSMutableArray*) contents

ダウンロードコンテンツ情報配列

·         (BOOL) downloadCancelContent: (NSString *）mediaContentKeyError: (NSError **)Error

コンテンツのダウンロードを中止

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) downloadContent: (NSString *）mediaContentKeyError: (NSError **)Error

コンテンツダウンロード（コンテンツインデックスでダウンロード）

パラメーター:

戻り値：

YES成功

NO失敗

·         (NSString *) loadContentURL: (NSString *）URLError: (NSError **)Error

コンテンツダウンロードの初期化

パラメーター:

戻り値：

初期化完了したコンテンツキー (mediaContentKey)

·         (BOOL) removeCacheWithError: (NSError **）Error

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

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) removeContent: (NSString *）mediaContentKeyError: (NSError **)Error

特定のコンテンツの削除

パラメーター:

戻り値：

YES成功

NO失敗

·         (Void) sendStoredLms

未送信されたLMS data転送

·         (Void) setBackgroundDownload: (BOOL)bBackground

ストレージコンテンツのバックグラウンドダウンロードか否か

·         (Void) setCacheSize: (NSInteger)cacheSizeMB

ストレージキャッシュサイズ設定

パラメーター:

·         (Void) setNetworkTimeOut: (NSInteger)timeOutRetry: (NSInteger)retryCount

ストレージ ネットワーク タイムアウト 設定

パラメーター:

·         (BOOL) startStorage: (NSError **）Error

KollusStorageスタート

パラメーター:

戻り値：

YES成功

NO失敗

警告:

このメソッドを呼び出しなかった場合、コンテンツ情報配列(contents)がnilで返される

·         (BOOL) startStorageWithCheck: (NSError **）Error

KollusStorageスタート

パラメーター:

戻り値：

成功時YES、失敗時NOを返す

警告:

このメソッドを呼び出しなかった場合、コンテンツ数(contentsCount)が0で返される

このメソッドはキーチェーンからplayerID獲得失敗時初実行なら新しく生成後処理、初実行でなければ3回要請全て失敗時エラー処理

·         (BOOL) startStorageWithFirst: (BOOL)FirstError: (NSError **)Error

KollusStorageスタート

パラメーター:

戻り値：

成功時YES、失敗時NOを返す

警告:

このメソッドを呼び出しなかった場合、コンテンツ数(contentsCount)が0で返される

·         (BOOL) startStorageWithNewPlayerID: (NSError **）Error

KollusStorageスタート

パラメーター:

戻り値：

成功時YES、失敗時NOを返す

警告:

このメソッドを呼び出しなかった場合、コンテンツ数(contentsCount)が0で返される

このメソッドはplayerIDを新しく生成してキーチェーンに登録して使用

·         (Void) updateDownloadDRMInfo: (BOOL)bAll

Drmコンテンツリスト更新

パラメーター:

属性文書化

·         (NSString*) applicationBundleID[read], [write], [nonatomic], [copy]

アプリケーションBundle ID(ex:com.yourcompany.Applicationname)

·         (NSString*) applicationDeviceID[read], [nonatomic], [copy]

KollusPlayer Device ID。

·         (NSDate*) applicationExpireDate[read], [write], [nonatomic], [copy]

KollusSDKの有効期限（カテノイドから発行）

·         (NSString*)applicationKey[read], [write], [nonatomic], [copy]

KollusSDK認証キー（カテノイドから発行）

·         (NSString*) applicationVersion[read], [nonatomic], [copy]

KollusSDKバージョン

·         (NSString*) appUserAgent[read], [nonatomic], [copy]

UserAgent。

·         (Long long) cacheDataSize[read], [nonatomic], [unsafe_unretained]

キャッシュデータ総サイズ(bytes)

·         (id<KollusStorageDelegate>) delegate[read], [write], [nonatomic], [weak]

ダウンロード状態情報デリゲート

·         (NSString*) deviceType[read], [nonatomic], [copy]

デバイスType(kp-mobile, kp-tablet)

·         (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]

動的drmパラメータ

·         (NSString*) keychainGroup[read], [write], [nonatomic], [copy]

Keychainグループ(ex:com.yourcompany.shared)

·         (NSInteger) serverPort[read], [write], [nonatomic], [assign]

Hybrid Appで使われるport番号

·         (Long long) storageSize[read], [nonatomic], [unsafe_unretained]

ダウンロードコンテンツの合計サイズ(bytes)

<KollusStorageDelegate>プロトコル参照

#Import <KollusStorageDelegate.h>

インスタンスメソッド

(Void) -kollusStorage:downloadContent:Error:

(Void) -kollusStorage:request:Json:error:

(Void) -kollusStorage:Cur:count:Error:

(Void) -kollusStorage:lmsData:resultJson:

(Void) -onSendCompleteStoredLms:failCount:

メソッド文書化

·         (Void) kollusStorage: (KollusStorage *）kollusStorageCur: (int)CurCount: (int)CountError: (NSError *)Error

DRMコンテンツリストを一括更新中、各コンテンツの更新が終わった場合、呼び出し

パラメーター:

·         (Void) kollusStorage: (KollusStorage *）kollusStoragedownloadContent: (KollusContent *)ContentError: (NSError *)Error

コンテンツ ダウンロード 中 状態の変化が ある 場合 呼び出し

パラメーター:

·         (Void) kollusStorage: (KollusStorage *）kollusStoragelmsData: (NSString *)lmsDataresultJson: (NSDictionary *)resultJsonLMS

Callback 処理後 呼び出し

パラメーター:

·         (Void) kollusStorage: (KollusStorage *）kollusStorageRequest: (NSDictionary *)RequestJson: (NSDictionary *)JsonError: (NSError *)Error

DRM Callback 処理後 呼び出し

パラメーター:

·         (Void) onSendCompleteStoredLms: (Int)successCountfailCount: (int)failCount

未転送 LMSコールバック 完了後 呼び出し

パラメーター:

KPSectionクラス参照

#Import <KPSection.h>

属性

NSIntegerstartTime

Play Section Start Time。

NSIntegerendTime

Play Section End Time。

属性文書化

·         (NSInteger) endTime[read], [write], [nonatomic], [unsafe_unretained]

Play Section End Time。

·         (NSInteger) startTime[read], [write], [nonatomic], [unsafe_unretained]

Play Section Start Time。

LogUtilクラス参照

#Import <LogUtil.h>

クラスメソッド

(Instancetype) +sharedUtil

(Void) +utilLog:

属性

Id<UtilDelegate>utilDelegate

メソッド文書化

+ (instancetype) sharedUtil

+ (void) utilLog: (NSString *）logContent、...

属性文書化

·         (id<UtilDelegate>) utilDelegate[read], [write], [nonatomic], [weak]

SubTitleInfoクラス参照

字幕情報

#Import <SubTitleInfo.h>

属性

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>

インスタンスメソッド

(Void) -onLogUtil:

メソッド文書化

·         (Void) onLogUtil: (NSString *）logData

KollusBookmarkクラス参照

#Import <KollusBookmark.h>

属性

NSTimeIntervalPosition

ブックマーク 時間

NSDate *Time

ブックマーク 生成された 日時

NSString *Title

ブックマーク タイトル(インデックス:講師用）

NSString *Value

ブックマーク タイトル(ユーザー）

KollusBookmarkKindKind

ブックマーク 種類

属性文書化

·         (KollusBookmarkKind) kind[read], [nonatomic], [assign]

ブックマークの種類

·         (NSTimeInterval) posiTion[read], [nonatomic], [unsafe_unretained]

ブックマークの時間

·         (NSDate*) time[read], [nonatomic], [unsafe_unretained]

ブックマーク生成された日時

·         (NSString*) title[read], [nonatomic], [copy]

ブックマークタイトル(インデックス：講師使用）

·         (NSString*) value[read], [nonatomic], [copy]

ブックマークタイトル（ユーザー）

KollusChatクラス参照

#Import <KollusChat.h>

属性

BOOLisChatVisible

チャット 画面 表示 チェック

BOOLisChatInfo

チャット 情報 有無 チェック

NSString *chatUrl

チャットUrl

BOOLisAdmin

管理者か否か

BOOLisAnonymous

匿名か否か

NSString *roomId

ルームID

NSString *chattingServer

チャット サーバー

NSString *userId

ユーザーID

NSString *nickName

ニックネーム

NSString *photoUrl

フォトUrl

属性文書化

·         (NSString*) chattingServer[read], [write], [nonatomic], [copy]

チャットサーバー

·         (NSString*) chatUrl[read], [write], [nonatomic], [copy]

チャットUrl

·         (BOOL) isAdmin[read], [write], [nonatomic], [unsafe_unretained]

管理者か否か

·         (BOOL) isAnonymous[read], [write], [nonatomic], [unsafe_unretained]

匿名か否か

·         (BOOL) isChatInfo[read], [write], [nonatomic], [unsafe_unretained]

チャット情報有無チェック

·         (BOOL) isChatVisible[read], [write], [nonatomic], [unsafe_unretained]

チャット画面見せるかチェック

·         (NSString*) nickName[read], [write], [nonatomic], [copy]

ニックネーム

·         (NSString*) photoUrl[read], [write], [nonatomic], [copy]

フォトURL

·         (NSString*) roomId[read], [write], [nonatomic], [copy]

ルームID

·         (NSString*) userId[read], [write], [nonatomic], [copy]

ユーザーID

KollusContentクラス参照

#Import <KollusContent.h>

属性

NSString *Company

会社名

NSString *Title

コンテンツ タイトル

NSString *Course

コース名

NSString *Teacher

講師名

NSString *Snapshot

スナップショット ファイル 経路

NSString *Thumbnail

サムネイル ファイル 経路

NSString *mediaContentKey

メディア コンテンツ キー

NSString *Synopsis

シノプシス

NSString *descriptionURL

詳細情報URL

CGSizenaturalSize

映像 原本 サイズ

NSString *iosPlayerType

プレイヤー タイプ:Hw、sw、native

KollusContentTypecontentType

コンテンツ タイプ

NSDate *DRMCheckDate

DRMチェック日時

NSDate *DRMExpireDate

DRM満了日時

LongDRMExpireCountMax

DRM最大 カウント

LongDRMExpireCount

DRM再生 カウント

NSTimeIntervalDRMTotalExpirePlayTime

DRM全体 再生可能 時間

NSTimeIntervalDRMExpirePlayTime

DRM再生可能 時間

BOOLDRMExpired

DRM満了か否か

BOOLDRMExpireRefreshPopup

DRM有効期限 更新 ポップアップか否か

NSTimeIntervalDuration

コンテンツDuration

NSTimeIntervalPosition

つなげる 時間

NSUIntegercontentIndex

コンテンツ インデックス:ダウンロード コンテンツ 再生時 使用

Long longfileSize

コンテンツ ファイル サイズ

Long longdownloadSize

ダウンロード なった ファイル サイズ

NSUIntegerdownloadProgress

ダウンロード パーセント

BOOLDownloaded

ダウンロード 完了か否か

Long longdownloadStopSize

ダウンロード 静止した ファイル サイズ

IntdownloadedTime

ファイル ダウンロード 日時

属性文書化

·         (NSString*) company[read], [nonatomic], [copy]

会社名

·         (NSUInteger) contentIndex[read], [nonatomic], [unsafe_unretained]

コンテンツインデックス：ダウンロードコンテンツ再生時使用

·         (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]

ダウンロードしたファイルサイズ

·         (Long long) downloadStopSize[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]

コンテンツ duration

·         (LonG long) fileSize[read], [nonatomic], [unsafe_unretained]

コンテンツファイルサイズ

·         (NSString*) iosPlayerType[read], [nonatomic], [copy]

プレイヤータイプ :Hw、sw、native

·         (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>

インスタンスメソッド

(Void) -kollusPlayerView:bookmark:Enabled:error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewBookmark: (NSArray *)BookmarksEnabled: (BOOL)EnabledError: (NSError *)Error

再生コンテンツのブックマークの有無を呼び出し

パラメーター:

<KollusPlayerDelegate>プロトコル参照

#Import <KollusPlayerDelegate.h>

インスタンスメソッド

(Void) -kollusPlayerView:prepareToPlayWithError:

(Void) -kollusPlayerView:play:Error:

(Void) -kollusPlayerView:pause:Error:

(Void) -kollusPlayerView:buffering:Prepared: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:unknownError:

(Void) -kollusPlayerView:framerate:

(Void) -kollusPlayerView:lockedPlayer:

(Void) -kollusPlayerView:charset:Caption:

(Void) -kollusPlayerView:charsetSub:captionSub:

(Void) -kollusPlayerView:thumbnail:Error:

(Void) -kollusPlayerView:mck:

(Void) -kollusPlayerView:height:

(Void) -kollusPlayerView:bitrate:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *)ViewBitrate: (Int)Bitrate

HLSコンテンツbitrate値転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewBuffering: (BOOL)BufferingPrepared: (BOOL)PreparedError: (NSError *)Error

システムの データ バッファリングが 停滞したり 停滞が 解消された 場合に 転送

パラメーター:

Remarks:

buffering値がYESに変更される前にシステムによる一時停止デリゲートが呼び出された場合、buffering値がNOに変更された場合にUIでPlayWithError:メソッド呼び出しが必要。

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewCharset: (char *）CharsetCaption: (char *)Caption

コンテンツの字幕転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewcharsetSub: (char *）charsetSubcaptionSub: (char *)captionSub

コンテンツの サブ字幕 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewenabledOutput: (BOOL)enabledOutputError: (NSError *)Error

テレビ出力 許容 コンテンツ 属性 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewFramerate: (Int)Framerate

コンテンツの フレームレート 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)ViewHeight: (Int)Height

HLSコンテンツ 再生中のResolution転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewlockedPlayer: (KollusPlayerType)playerType

デバイス ロック 発生時 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewMck: (NSString *）Mck

メディア コンテンツ キーを 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *)kollusPlayerViewnaturalSize: (CGSize）naturalSize

コンテンツの 原本 映像サイズ 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPause: (BOOL)userInteractionError: (NSError *)Error

一時停止 なった 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPlay: (BOOL)userInteractionError: (NSError *)Error

再生が 始まった 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplaybackRate: (float)playbackRateError: (NSError *)Error

再生速度が 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplayerContentFrame: (CGRect)contentFrameError: (NSError *)Error

再生画面 サイズが 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewplayerContentMode: (KollusPlayerContentMode)playerContentModeError: (NSError *)Error

再生画面 モードが 変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewPosition: (NSTimeInterval)PositionError: (NSError *)Error

再生位置が 変更される 前後に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewprepareToPlayWithError: (NSError *)errorprepareToPlay

呼び出し 後 コンテンツ 再生準備 完了か否かを 転送

パラメーター:

Remarks:

Errorがnilでない場合、再生準備失敗

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewRepeat: (BOOL)RepeatError: (NSError *)Error

繰り返し再生モードが変更された

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewScroll: (CGPoint)DistanceError: (NSError *)Error

映像画面 移動 動作 前後に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewStop: (BOOL)userInteractionError: (NSError *)Error

再生が 静止した 場合に 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewThumbnail: (BOOL)isThumbnailError: (NSError *)Error

サムネイル 非同期 ダウンロード 完了を 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewunknownError: (NSError *)Error

ギターエラー 発生時 転送

パラメーター:

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewZoom: (UIPinchGestureRecognizer *)RecognizerError: (NSError **)Error

ビデオ 出力画面 拡大/縮小 前後に 転送

パラメーター:

戻り値：

YES成功

NO失敗

<KollusPlayerDRMDelegate>プロトコル参照

#Import <KollusPlayerDRMDelegate.h>

インスタンスメソッド

(Void) -kollusPlayerView:request:Json:error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewRequest: (NSDictionary *)RequestJson: (NSDictionary *)JsonError: (NSError *)Error

DRM Callback転送後呼び出し

パラメーター:

<KollusPlayerLMSDelegate>プロトコル参照

#Import <KollusPlayerLMSDelegate.H>

インスタンスメソッド

(Void) -kollusPlayerView:json:Error:

メソッド文書化

·         (Void) kollusPlayerView: (KollusPlayerView *）kollusPlayerViewJson: (NSDictionary *)JsonError: (NSError *)Error

LMS情報をサーバーに転送してから呼び出し

パラメーター:

KollusPlayerViewクラス参照

#Import <KollusPlayerView.h>

インスタンスメソッド

(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:

(Bool) -setSubTitleSubPath:

(CGRect) -getVideoPosition

(CGFloat) -getZoomValue

(Void) -setPauseOnForeground:

(Void) -setDisableZoomOut:

(Void) -setDecoder:

(Void) -setAIRate:

属性

Id<KollusPlayerDelegate>Delegate

プレイヤー 関連 デリゲート

Id<KollusPlayerDRMDelegate>DRMDelegate

DRM情報 関連 デリゲート

Id<KollusPlayerLMSDelegate>LMSDelegate

LMS情報 関連 デリゲート

Id<KollusPlayerBookmarkDelegate>bookmarkDelegate

Bookmark関連 デリゲート

KollusStorage*Storage

KollusStorage ポインタ

NSString *contentURL

再生する コンテンツURL(Stream Play)

NSString *mediaContentKey

再生する コンテンツMedia Content Key (Local Play)

KollusContent*Content

使用中の コンテンツ 情報

BOOLAIRateEnable

AI倍速 サポートか否か

NSTimeIntervalcurrentPlaybackTime

コンテンツ 現在の時間

NSTimeIntervalliveDuration

ライブ タイムシフトDuration

FloatcurrentPlaybackRate

NSArray *Bookmarks

ブックマーク 情報 配列

KollusPlayerContentModescalingMode

コンテンツ 出力 モード

CGRectplayerContentFrame

プレイヤー 画面 領域

KollusPlayerRepeatModerepeatMode

全体繰り返し モード

BOOLscreenConnectEnabled

画面出力 許容か否か

BOOLbookmarkModifyEnabled

ブックマーク 修正権限か否か

BOOLDebug

デバッグ ログ 出力か否か

BOOLisPreparedToPlay

再生準備 完了か否か

BOOLisPlaying

再生中か否か

BOOLisBuffering

バッファリング 進行するか否か

BOOLisSeeking

探索中か否か

BOOLisScrolling

画面同中か否か

BOOLisWaterMark

Audio water markか否か

BOOLisAudioOnly

オーディオ コンテンツか否か

BOOLmuteOnStart

開始時Muteか否か

CGSizenaturalSize

オリジナルコンテンツ 映像サイズ

BOOLisZoomedIn

Zoom inか否か

KollusPlayerTypeplayerType

プレイヤー タイプ

NSString *customSkin

プレイヤー スキン情報JSON Data

KPSection*playSection

プレビュー 情報

NSIntegernRepeatStartTime

Repeat Start Time。

NSIntegernRepeatEndTime

Repeat End Time。

BOOLaudioBackgroundPlay

バックグラウンド オーディオファイル 再生

BOOLlmsOffDownloadContent

ダウンロード コンテンツLms off

NSUIntegerproxyPort

Proxy Server Port指定

BOOLIntro

イントロか否か

BOOLSeekable

Seekハル スー 有無

NSIntegernSecSkip

与えられたN初後にSkip

BOOLisLive

Liveか否か

BOOLdisablePlayRate

倍速 コントロール 可能か否か

NSIntegernSeekableEnd

NSString *strCaptionStyle

Partner portalで設定: 字幕スタイル"bg"=字幕背景適用, "bg"以外=ユーザー設定

BOOLforceNScreen

強制 つなげる

BOOLisThumbnailEnable

サムネイル 使用か否か

BOOLisThumbnailSync

サムネイル ダウンロード 方式(Sync, async)

NSString *fpsCertURL

FairPlay認証URL。

NSString *fpsDrmURL

FairPlay DRM URL。

NSIntegernOfflineBookmarkUse

NSIntegernOfflineBookmarkDownload

1: Indexブックマークのみダウンロード, 2: Indexブックマークとユーザーブックマークを全てダウンロード

NSIntegernOfflineBookmarkReadOnly

追加/削除 使用か否か( 0:使用(デフォルト値)、1:使用 しない）

NSString *strVideoWaterMark

NSIntegernVideoWaterMarkAlpha

ビデオ ウォーターマーク アルファ 値段

NSIntegernVideoWaterMarkFontSize

ビデオ ウォーターマーク フォント 大きさ

NSString *strVideoWaterMarkFontColor

ビデオ ウォーターマーク カラー

NSIntegernVideoWaterMarkShowTime

ビデオ ウォーターマーク 表示 時間

NSIntegernVideoWaterMarkHideTime

ビデオ ウォーターマーク 非表示 時間

NSString *extraDrmParam

動的Drmパラメータ

NSMutableArray *streamInfoList

HLS ABR Information.

KollusChat*kollusChat

ライブ チャット

NSIntegernextEpisodeShowTime

次の動画再生 再生Show Time

NSString *nextEpisodeCallbackURL

次の動画再生 再生URL

NSMutableDictionary *nextEpisodeCallbackParams

次の動画再生 再生Params

NSMutableArray *listSubTitle

字幕 ファイル リスト

NSMutableArray *listSubTitleSub

サブ字幕 ファイル リスト

メソッド文書化

·         (BOOL) addBookmark: (NSTimeInterval)PositionValue: (NSString *)ValueError: (NSError **)Error

ブックマーク追加

パラメーター:

戻り値：

YES追加可能

NO追加不可能

警告:

すでに同じpositionのブックマークが存在する場合、入力されたブックマークに置き換えられる

·         (Void) changeBandWidth: (Int)bandWidth

HLS再生中のbandwidth変更

·         (CGRect) getVideoPosition

ビデオ領域

戻り値：

CGRectビデオ再生位置

·         (CGFloat)getZoomValue

ビデオ出力画面の拡大/縮小値

戻り値：

CGFloat出力画面の拡大/縮小比率の値

·         (Id) initWithContentURL: (NSString *）Url

コンテンツURLを使ってプレイヤーを生成

パラメーター:

戻り値：

生成されたプレイヤーID

·         (Id) initWithMediaContentKey: (NSString *）Mck

コンテンツインデックスを使ってプレイヤーを生成（ダウンロードしたコンテンツの場合に使用）

パラメーター:

戻り値：

生成されたプレイヤーID

·         (BOOL) isOpened

プレイヤー生成の可否確認

戻り値：

YES生成済み

NO生成できない

·         (BOOL) pauseWithError: (NSError **）Error

一時停止

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

·         (BOOL) playWithError: (NSError **）Error

再生開始

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

·         (BOOL) prepareToPlayWithMode: (KollusPlayerType)TypeError: (NSError **)Error

コンテンツ再生準備 (KollusPlayer or Native)

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) removeBookmark: (NSTimeInterval)PositionError: (NSError **)Error

ブックマークの削除

パラメーター:

戻り値：

YES削除可能

NO削除不可能

警告:

ブックマークkindがKollusBookmarkKindIndexのブックマークは削除されない

·         (BOOL) scroll: (CGPoint）DistanceError: (NSError **)Error

ビデオ出力画面を移動

パラメーター:

戻り値：

YES成功

NO失敗

·         (BOOL) scrollStopWithError: (NSError **）Error

ビデオ出力画面移動中止（画面位置固定）

パラメーター:

戻り値：

YES成功

NO失敗

·         (Void) setAIRate: (Bool)bAIRate

AI配速使用設定

パラメーター:

·         (Void) setBufferingRatio: (NSInteger)bufferingRatio

バッファリング 倍数 設定

パラメーター:

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

PlayerTypeKollusの場合のみ適用されます。

·         (Void) setDecoder: (Bool)bHW

コーデック設定

パラメーター:

·         (Void) setDisableZoomOut: (BOOL)bDisable

Zoom機能でZoom out機能を 防ぐAPI

パラメーター:

·         (Void) setNetworkTimeOut: (NSInteger)timeOut

プレイヤー ネットワーク タイムアウト 設定

パラメーター:

·         (Void) setPauseOnForeground: (BOOL)bPause

Foreground状態で 変更時Player再生状態をPauseで 維持する ためのAPI

パラメーター:

·         (BOOL) setSkipPlay

Play list中に現在再生中の動画をskip

·         (Bool) setSubTitlePath: (char *）Path

字幕ファイル選択

パラメーター:

戻り値：

BoolTrue:成功False:失敗

·         (Bool) setSubTitleSubPath: (char *）Path

サブ字幕ファイル選択

パラメーター:

戻り値：

BoolTrue:成功False:失敗

·         (BOOL) stopWithError: (NSError **）Error

再生中止

パラメーター:

戻り値：

YES成功

NO失敗

警告:

prepareToPlayerWithErrorメソッドの呼び出しと成功した場合に使用

·         (BOOL) zoom: (UIPinchGestureRecognizer *）RecognizerError: (NSError **)Error

ビデオ出力画面拡大/縮小

パラメーター:

戻り値：

YES成功

NO失敗

属性文書化

·         (BOOL) AIRateEnable[rEad], [write], [nonatomic], [unsafe_unretained]

AI配速支援か否か

·         (BOOL) audioBackgroundPlay[read], [write], [nonatomic], [unsafe_unretained]

バックグラウンドオーディオファイル再生

·         (id<KollusPlayerBookmarkDelegate>) bookmarkDelegate[read], [write], [nonatomic], [weak]

Bookmark関連のデリゲート

·         (BOOL) bookmarkModifyEnabled[read], [nonatomic], [unsafe_unretained]

ブックマークの修正権限の可否

·         (NSArray*) bookmarks[read], [write], [nonatomic], [strong]

ブックマーク情報配列

·         (KollusContent*) content[read], [nonatomic], [weak]

使用中のコンテンツ情報

·         (NSString*) contentURL[read], [write], [nonatomic], [copy]

再生するコンテンツURL(Stream Play)

·         (Float) currentPlaybackRate[read], [write], [nonatomic], [unsafe_unretained]

コンテンツ再生速度も10倍速までサポート。警告：2倍速超過時、品質低下やオーディオ、ビデオシンクが合わないことがある

·         (NSTimeInterval) currentPlaybackTime[read], [write], [nonatomic], [unsafe_unretained]

コンテンツ現在時間

·         (NSString*) customSkin[read], [write], [nonatomic], [copy]

プレイヤースキン情報JSON Data

·         (BOOL) debug[read], [write], [nonatomic], [unsafe_unretained]

デバッグログ出力か否か

·         (id<KollusPlayerDelegate>) delegate[read], [write], [nonatomic], [weak]

プレイヤー関連のデリゲート

·         (BOOL) disablePlayRate[read], [nonatomic], [unsafe_unretained]

倍速コントロール可能か否か

·         (id<KollusPlayerDRMDelegate>) DRMDelegate[read], [write], [nonatomic], [weak]

DRM情報関連のデリゲート

·         (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]

動的drmパラメータ

·         (BOOL) forceNScReen[read], [nonatomic], [unsafe_unretained]

強制継続

·         (NSString*) fpsCertURL[read], [write], [nonatomic], [copy]

FairPlay認証URL。

·         (NSString*) fpsDrmURL[read], [write], [nonatomic], [copy]

FairPlay DRM URL。

·         (BOOL) intro[read], [nonatomic], [unsafe_unretained]

イントロか否か

·         (BOOL) isAudioOnly[read], [nonatomic], [unsafe_unretained]

オーディオコンテンツか否か

·         (BOOL) isBuffering[read], [nonatomic], [unsafe_unretained]

バッファリング進行可否

·         (BOOL) isLive[read], [nonatomic], [unsafe_unretained]

Liveか否か

·         (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]

Audio water markか否か

·         (BOOL) isZoomedIn[read], [nonatomic], [unsafe_unretained]

Zoom inか否か

·         (KollusChat*) kollusChat[read], [write], [nonatomic], [assign]

ライブチャット

·         (NSMutableArray*) listSubTitle[read], [nonatomic], [assign]

字幕ファイルリスト

·         (NSMutableArray*) listSubTitleSub[read], [nonatomic], [assign]

サブ字幕ファイルリスト

·         (NSTimeInterval) liveDuration[read], [nonatomic], [unsafe_unretained]

ライブタイムシフト Duration

·         (id<KollusPlayerLMSDelegate>) LMSDelegate[read], [write], [nonatomic], [weak]

LMS情報に関するデリゲート

·         (BOOL) lmsOffDownloadContent[read], [write], [nonatomic], [unsafe_unretained]

ダウンロードコンテンツlms off

·         (NSString*) mediaContentKey[read], [write], [nonatomic], [assign]

再生するコンテンツ Media Content Key (Local Play)

·         (BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]

開始時にmuteか否か

·         (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]

オリジナルコンテンツの映像サイズ

·         (NSMutableDictionary*) nextEpisodeCallbackParams[read], [nonatomic], [assign]

次の回再生 Params

·         (NSString*) nextEpisodeCallbackURL[read], [nonatomic], [copy]

次の回再生URL

·         (NSInteger) nextEpisodeShowTime[read], [nonatomic], [unsafe_unretained]

次の回再生 Show Time

·         (NSInteger) nOfflineBookmarkDownload[read], [nonatomic], [unsafe_unretained]

1:インデックスのみダウンロード、2:インデックス/ブックマークすべてダウンロード

·         (NSInteger) nOfflineBookmarkReadOnly[read], [nonatomic], [unsafe_unretained]

追加/削除の使用 か否か( 0:使用(デフォルト)、1:使用しない)

·         (NSInteger) nOfflineBookmarkUse[read], [nonatomic], [unsafe_unretained]

オフラインブックマークはダウンロードコンテンツのみ使用 0: 使用しない, 1: 使用

·         (NSInteger) nRepeatEndTime[read], [nonatomic], [unsafe_unretained]

Repeat End Time。

·         (NSInteger) nRepeatStartTime[read], [nonatomic], [unsafe_unretained]

Repeat Start Time。

·         (NSInteger) nSecSkip[read], [nonatomic], [unsafe_unretained]

与えられたn秒後にスキップ

·         (NSInteger) nSeekableEnd[read], [nonatomic], [unsafe_unretained]

与えられたn秒まで、または現在の再生秒までシークできます。シークブルが falseの場合のみ適用 -1 : Seekできない（シークシーできない）

·         (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]

Proxy Server Portの指定

·         (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]

Seekできるか否か？

·         (KollusStorage*) storage[read], [write], [nonatomic], [weak]

KollusStorageポインター

·         (NSString*) strCaptionStyle[read], [nonatomic], [copy]

Partner portalの設定 値 : 字幕スタイル「bg」：字幕の背景適用、「bg」でなければユーザー設定

·         (NSMutableArray*) streamInfoList[read], [nonatomic], [assign]

HLS ABR Information。

·         (NSString*) strVideoWaterMark[read], [nonatomic], [copy]

ビデオウォーターマークビデオウォーターマーク文字

·         (NSString*) strVideoWaterMarkFontColor[read], [nonatomic], [copy]

ビデオウォーターマークカラー

KollusStorageクラス参照

#Import <KollusStorage.h>

インスタンスの 메소드

(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

属性

Id<KollusStorageDelegate>Delegate

ダウンロード 状態情報 デリーゲート

NSString *applicationVersion

KollusSDKバージョン

NSString *applicationDeviceID

KollusPlayer Device ID。

NSString *applicationKey

KollusSDK認証 キー(카테ノイドから 発行)

NSString *applicationBundleID

アプリケーションBundle ID(ex:com.Yourcompany.applicationname)

NSString *keychainGroup

Keychainグループ(Ex:com.yourcompany.shared)

NSDate *applicationExpireDate

KollusSDK有効日付(카테ノイドから 発行)

Long longstorageSize

ダウンロード コンテンツ 合計 サイズ(Bytes)

Long longcacheDataSize

キャッシュデータ 合計 サイズ(Bytes)

NSIntegerserverPort

ハイブリッドアプリで 使用されるPort番号

NSString *extraDrmParam

動的Drmパラメータ

NSString *appUserAgent

UserAgent。

NSString *deviceType

デバイスType(kp-mobile, kp-tablet)

메소드文書化

·         (NSString*) checkContentURL: (NSString *)URLError: (NSError **)Error

コンテンツのダウンロードチェック：渡されたURLに該当するコンテンツのダウンロードの有無、およびMCKを確認するために使用

パラメータ：

戻り値:

ダウンロード完了したコンテンツメディアコンテンツキー

·         (NSMutableArray*) contents

ダウンロードコンテンツ情報配列

·         (BOOL) downloadCancelContent: (NSString *)mediaContentKeyError: (NSError **)Error

コンテンツのダウンロードを停止

パラメータ：

戻り値:

YES成功

NO失敗

·         (BOOL) downloadContent: (NSString *)mediaContentKeyError: (NSError **)Error

コンテンツのダウンロード（コンテンツインデックスでダウンロード）

パラメータ：

戻り値:

YES成功

NO失敗

·         (NSString *) loadContentURL: (NSString *)URLError: (NSError **)Error

コンテンツダウンロードの初期化

パラメータ：

戻り値:

初期化完了したコンテンツキー (mediaContentKey)

·         (BOOL) removeCacheWithError: (NSError **)Error

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

パラメータ：

戻り値:

YES成功

NO失敗

·         (BOOL) removeContent: (NSString *)mediaContentKeyError: (NSError **)Error

特定のコンテンツの削除

パラメータ：

戻り値:

YES成功

NO失敗

·         (Void) sendStoredLms

未送信のLMSデータ転送

·         (Void) setBackgroundDownload: (BOOL)bBackground

ストレージコンテンツのバックグラウンドダウンロードか否か

·         (Void) setCacheSize: (NSInteger）cacheSizeMB

ストレージキャッシュサイズの設定

パラメータ：

·         (Void) setNetworkTimeOut: (NSInteger）timeOutRetry: (NSInteger)retryCount

ストレージ ネットワーク タイムアウト 設定

パラメータ：

·         (BOOL) startStorage: (NSError **)Error

KollusStorage開始

パラメータ：

戻り値:

YES成功

NO失敗

警告:

このメソッドを呼び出さなければ、コンテンツ情報配列(contents)がnilで返される

·         (BOOL) startStorageWithCheck: (NSError **)Error

KollusStorage開始

パラメータ：

戻り値:

成功時はYES、失敗時はNOを返す

警告:

このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が0に返されます

このメソッドは、キーチェーンからのplayerID取得に失敗した場合、初回実行の場合は新規生成後処理し、初回実行でなければ3回のリクエストが全て失敗するとエラー処理

·         (BOOL) startStorageWithFirst: (BOOL)FirstError: (NSError **)Error

KollusStorage開始

パラメータ：

戻り値:

成功時はYES、失敗時はNOを返す

警告:

このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が0に返されます

·         (BOOL) startStorageWithNewPlayerID: (NSError **)Error

KollusStorage開始

パラメータ：

戻り値:

成功時はYES、失敗時はNOを返す

警告:

このメソッドを呼び出さない場合、コンテンツ数(contentsCount)が0に返されます

このメソッドはplayerIDを新しく生成してキーチェーンに登録して使用

·         (Void) updateDownloadDRMInfo: (BOOL)bAll

Drmコンテンツリスト更新

パラメータ：

属性文書化

·         (NSString*) applicationBundleID[read], [write], [nonatomic], [copy]

アプリケーションBundle ID(ex:com.yourcompany.applicationname)

·         (NSString*) applicationDeviceID[read], [nonatomic], [copy]

KollusPlayer Device ID。

·         (NSDate*) applicationExpireDate[read], [write], [nonatomic], [copy]

KollusSDKの有効期限（カテノイドから発行）

·         (NSString*) applicationKey[read], [write], [nonatomic], [copy]

KollusSDK認証キー（カテノイドから発行）

·         (NSString*) applicationVersion[read], [nonatomic], [copy]

KollusSDKバージョン

·         (NSString*) appUserAgent[read], [nonatomic], [copy]

UserAgent。

·         (Long long) cacheDataSize[read], [nonatomic], [unsafe_unretained]

キャッシュデータ総サイズ(bytes)

·         (id<KollusStorageDelegate>) delegate[read], [write], [nonatomic], [weak]

ダウンロード状態情報デリゲート

·         (NSString*)deviceType[read], [nonatomic], [copy]

デバイスType(kp-mobile, kp-tablet)

·         (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]

動的drmパラメータ

·         (NSString*) keychainGroup[read], [write], [nonatomic], [copy]

Keychainグループ(ex:com.yourcompany.shared)

·         (NSInteger) serverPort[read], [write], [nonatomic], [assign]

Hybrid Appで使われるport番号

·         (Long long) storageSize[read], [nonatomic], [unsafe_unretained]

ダウンロードコンテンツの合計サイズ(bytes)

<KollusStorageDelegate>プロトコル参照

#Import <KollusStorageDelegate.h>

インスタンスの 메소드

(Void) -kollusStorage:downloadContent:Error:

(Void) -kollusStorage:request:Json:error:

(Void) -kollusStorage:Cur:count:Error:

(Void) -kollusStorage:lmsData:resultJson:

(Void) -onSendCompleteStoredLms:failCount:

메소드文書化

·         (Void) kollusStorage: (KollusStorage *)kollusStorageCur: (int)CurCount: (int)CountError: (NSError *)Error

DRMコンテンツリストを一括更新中、各コンテンツの更新が終わった場合、呼び出し

パラメータ：

·         (Void) kollusStorage: (KollusStorage *)kollusStoragedownloadContent: (KollusContent *)ContentError: (NSError *)Error

コンテンツ ダウンロード 中 状態の変化が ある 場合 呼び出し

パラメータ：

·         (Void) kollusStorage: (KollusStorage *)kollusStoragelmsData: (NSString *)lmsDataresultJson: (NSDictionary *)resultJsonLMS

Callback 処理後 呼び出し

パラメータ：

·         (Void) kollusStorage: (KollusStorage *)kollusStorageRequest: (NSDictionary *)RequestJson: (NSDictionary *)JsonError: (NSError *)Error

DRM Callback 処理後 呼び出し

パラメータ：

·         (Void) onSendCompleteStoredLms: (Int)successCountfailCount: (int)failCount

未転送 LMSコールバック 完了後 呼び出し

パラメータ：

KPSectionクラス参照

#Import <KPSection.h>

属性

NSIntegerstartTime

Play Section Start Time。

NSIntegerendTime

Play Section End Time。

属性文書化

·         (NSInteger) endTime[read], [write], [nonatomic], [unsafe_unretained]

Play Section End Time。

·         (NSInteger) startTime[read], [write], [nonatomic], [unsafe_unretained]

Play Section Start Time。

LogUtilクラス参照

#Import <LogUtil.h>

クラスメソッド

(Instancetype) +sharedUtil

(Void) +utilLog:

属性

Id<UtilDelegate>utilDelegate

메소드文書化

+ (instancetype) sharedUtil

+ (void) utilLog: (NSString *)logContent、...。

属性文書化

·         (id<UtilDelegate>) utilDelegate[read], [write], [nonatomic], [weak]

SubTitleInfoクラス参照

字幕情報

#Import <SubTitleInfo.h>

属性

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>

インスタンスの メソッド

(Void) -onLogUtil:

メソッド文書化