最終更新: 2025.06.30_Review

iOS API References

API文書情報

• 日付：2025.05.28

Kollus Bookmarkクラス参照

#import <KollusBookmark.h>

属性

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]

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

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

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

KollusChatクラス参照

#import <KollusChat.h>

属性

BOOL isChatVisible

チャット画面を見せてくれるかチェック

BOOL isChatInfo

チャット情報があるかチェック

NSString * chatUrl

チャット Url

BOOL isAdmin

管理者かどうか

BOOL isAnonymous

匿名可否

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

Kollus Content クラス参照

#import <KollusContent.h>

属性

NSString * company

会社名

NSString * title

コンテンツ·タイトル

NSString * course

コース名

NSString * teacher

講師名

NSString * snapshot

スナップショットファイルパス

NSString * thumbnail

サムネイルファイルパス

NSString * mediaContentKey

メディア·コンテンツ·キー

NSString * synopsis

シノプシス

NSString * descriptionURL

詳細情報URL

CGSize naturalSize

映像 原本 サイズ

NSString * iosPlayerType

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

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

コンテンツduration

NSTimeInterval position

続きを読む時間

NSUInteger contentIndex

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

long long fileSize

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

long long downloadSize

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

NSUInteger downloadProgress

ダウンロードパーセンテージ

BOOL downloaded

ダウンロード完了可否

long long downloadStopSize

ダウンロード停止されたファイルサイズ

int downloadedTime

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

速成文書化

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

コンテンツ·タイトル

<KollusPlayer Bookmark Delegate>プロトコルを参照

#import <KollusPlayerBookmarkDelegate.h>

インスタンス·メソッド

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

メソッド文書化

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView bookmark: (NSArray *)  bookmarksenabled: (BOOL)  enabled error: (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 *) view bitrate: (int)  bitrate

HLSコンテンツbitrate値転送

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL)  buffering prepared: (BOOL)  prepared error: (NSError *)  error

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

パラメータ:

Remarks:

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

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *)  charset caption: (char *)  caption

コンテンツの字幕配信

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charsetSub: (char *)  charsetSubcaptionSub: (char *)  captionSub

コンテンツのサブ字幕配信

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL)  enabledOutputerror: (NSError *)  error

TV出力許容コンテンツ属性伝送

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int)  framerate

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) view height: (int)  height

HLSコンテンツ再生中のresolution送信

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView lockedPlayer: (KollusPlayerType)  playerType

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *)  mck

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize)  naturalSize

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView pause: (BOOL)  userInteraction error: (NSError *)  error

一時停止された場合に転送

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView play: (BOOL)  userInteraction error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playbackRate: (float)  playbackRate error: (NSError *)  error

再生速度が変更された

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playerContentFrame: (CGRect)  contentFrame error: (NSError *)  error

再生画面サイズが変更になった

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView playerContentMode: (KollusPlayerContentMode)  playerContentMode error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView position: (NSTimeInterval)  position error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView prepareToPlayWithError: (NSError *)  errorprepareToPlay 

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

パラメータ:

Remarks:

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

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView repeat: (BOOL)  repeat error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView scroll: (CGPoint)  distance error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView stop: (BOOL)  userInteraction error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView thumbnail: (BOOL)  isThumbnail error: (NSError *)  error

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

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView unknownError: (NSError *)  error

その他エラー発生時に転送

パラメータ:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView zoom: (UIPinchGestureRecognizer *)  recognizer error: (NSError **)  error

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

パラメータ:

戻り値:

YES 成功

NO 失敗

「KollusPlayer DRM Delegate」プロトコルを参照

#import <KollusPlayerDRMDelegate.h>

インスタンス·メソッド

(void) - kollusPlayerView:request:json:error:

メソッド文書化

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView request: (NSDictionary *)  request json: (NSDictionary *)  json error: (NSError *)  error

DRMCallback送信後に呼び出し

パラメータ:

<KollusPlayerLMSDelegate>プロトコル参照

#import <KollusPlayerLMSDelegate.h>

インスタンス·メソッド

(void) - kollusPlayerView:lmsData:resultJson:

メソッド文書化

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerView lmsData:(NSString *)lmsData  json resultJson:(NSDictionary *)resultJson

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

Kollus Storage ポインター

NSString * contentURL

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

NSString * mediaContentKey

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

KollusContent * content

使用中のコンテンツ情報

BOOL AIRateEnable

AI倍速支援可否

NSTimeInterval currentPlaybackTime

コンテンツ現在時間

NSTimeInterval liveDuration

ライブタイムシフトDuration

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 isAudioOnly

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

BOOL muteOnStart

開始時にmuteかどうか

CGSize naturalSize

原本コンテンツ 映像サイズ

BOOL isZoomedIn

Zoom in 有無

KollusPlayerType playerType

プレーヤー·タイプ

NSString * customSkin

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

KPSection * playSection

プレビュー情報

NSInteger nRepeatStartTime

Repeat Start Time.

NSInteger nRepeatEndTime

Repeat End Time.

BOOL audioBackgroundPlay

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

BOOL lmsOffDownloadContent

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

NSUInteger proxyPort

Proxy Server Port 指定

BOOL intro

イントロ可否

BOOL seekable

seek できるか

NSInteger nSecSkip

与えられたn秒後に skip

BOOL isLive

Live可否

BOOL disablePlayRate

倍速コントロールが可能かどうか

NSInteger nSeekableEnd

NSString * strCaptionStyle

Partner portal 設定値 : 字幕スタイル "bg" : 字幕背景適用、"bg"以外のユーザー設定

BOOL forceNScreen

強制接続

BOOL ignoreZero

続きを見る時間値が小さい時でも続きを見る有効

BOOL isThumbnailEnable

サムネイル使用可否

BOOL isThumbnailSync

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

NSString * fpsCertURL

FairPlay認証URL。

NSString * fpsDrmURL

FairPlay DRM URL.

NSInteger nOfflineBookmarkUse

NSInteger nOfflineBookmarkDownload

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

NSInteger nOfflineBookmarkReadOnly

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

NSString * strVideoWaterMark

NSInteger nVideoWaterMarkAlpha

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

NSInteger nVideoWaterMarkFontSize

ビデオウォーターマークフォントサイズ

NSString * strVideoWaterMarkFontColor

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

NSInteger nVideoWaterMarkShowTime

ビデオウォーターマークが見える時間

NSInteger nVideoWaterMarkHideTime

ビデオウォーターマークの見えない時間

NSString * extraDrmParam

動的Drmパラメーター

NSMutableArray * streamInfoList

HLS ABR Information.

KollusChat * kollusChat

ライブチャット

NSInteger nextEpisodeShowTime

次回再生Show Time

NSString * nextEpisodeCallbackURL

次回再生URL

NSMutableDictionary * nextEpisodeCallbackParams

次回再生Params

BOOL nextEpisodeShowButton

Content Provider Name

NSString *contentProviderName

バックグラウンド再生可否

BOOL disableBackgroundAudio

次回再生Show Button

NSMutableArray * listSubTitle

字幕ファイルリスト

NSMutableArray * listSubTitleSub

サブ字幕ファイルリスト

メソッド文書化

• (BOOL) addBookmark: (NSTimeInterval)  position value: (NSString *)  value error: (NSError **)  error

ブックマーク追加

パラメータ:

戻り値:

YES追加可能

NO 追加不可能

警告:

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

• (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 失敗

警告:

prepare ToPlayer With Errorメソッド呼び出し及び成功した場合に使用

• (BOOL) playWithError: (NSError **)  error

再生開始

パラメータ:

戻り値:

YES 成功

NO 失敗

警告:

prepare ToPlayer With Errorメソッド呼び出し及び成功した場合に使用

• (BOOL) prepareToPlayWithMode: (KollusPlayerType)  type error: (NSError **)  error

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

パラメータ:

戻り値:

YES 成功

NO 失敗

• (BOOL) removeBookmark: (NSTimeInterval)  position error: (NSError **)  error

ブックマーク削除

パラメータ:

戻り値:

YES 削除可能

NO 削除不可

警告:

ブックマークkindがKollus Bookmark Kind Indexであるブックマークは削除されない

• (BOOL) scroll: (CGPoint)  distance error: (NSError **)  error

ビデオ出力画面を移動

パラメータ:

戻り値:

YES 成功

NO 失敗

• (BOOL) scrollStopWithError: (NSError **)  error

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

パラメータ:

戻り値:

YES 成功

NO 失敗

• (void) setAIRate: (bool)  bAIRate

AI倍速使用設定

パラメータ:

• (void) setBufferingRatio: (NSInteger)  bufferingRatio

バッファリング倍数設定

パラメータ:

警告:

prepare ToPlayer With Errorメソッド呼び出し及び成功した場合に使用

Player Type Kollusの場合のみ適用されます。

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

playlist中に現在再生中の動画をskip

• (bool) setSubTitlePath: (char *)  path

字幕ファイル選択

パラメータ:

戻り値:

bool true:成功 false:失敗

• (bool) setSubTitleSubPath: (char *)  path

サブ字幕ファイル選択

パラメータ:

戻り値:

bool true:成功 false:失敗

• (BOOL) stopWithError: (NSError **)  error

再生停止

パラメータ:

戻り値:

YES 成功

NO 失敗

警告:

prepare ToPlayer With Errorメソッド呼び出し及び成功した場合に使用

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

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]

強制接続

• (BOOL) ignoreZero[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) 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

• (BOOL) nextEpisodeShowButton[read],[nonatomic], [unsafe_unretained]

次回再生Show Button

• (NSString *) contentProviderName[read],[nonatomic], [unsafe_unretained]

Content Provider Name

• (BOOL) disableBackgroundAudio[read],[nonatomic], [unsafe_unretained]

バックグラウンド再生可否

• (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秒後に skip

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

与えられたn秒まで、または現在の再生秒までSeekできる。 seekableが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]

Kollus Storage ポインター

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

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

Kollus Storage クラス参照

#import <KollusStorage.h>

インスタンス·メソッド

(BOOL) - setKollusPath:

(BOOL) - startStorage:

(BOOL) - startStorageWithFirst:error:

(BOOL) - startStorageWithCheck:

(BOOL) - startStorageWithNewPlayerID:

(NSString *) - loadContentURL:error:

(NSString *) - checkContentURL:error:

(BOOL) - downloadContent:error:

(BOOL) - removeContent:error:

(BOOL) - removeCacheWithError:

(BOOL) - downloadCancelContent:error:

(void) - setNetworkTimeOut:retry:

(void) - updateDownloadDRMInfo:

(void) - setCacheSize:

(void) - setBackgroundDownload:

(NSMutableArray *) - contents

(void) - sendStoredLms

属性

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有効日付(カテノイドで発行)

NSString *storagePath

Kollus SDK フォルダ

long long storageSize

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

long long cacheDataSize

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

NSInteger serverPort

Hybrid Appで使用されるポート番号

NSString * extraDrmParam

動的Drmパラメーター

NSString * appUserAgent

UserAgent.

NSString * deviceType

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

メソッド文書化

• (NSString*) checkContentURL: (NSString *)  URL error: (NSError **)  error

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

パラメータ:

戻り値:

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

• (NSMutableArray*) contents

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

• (BOOL) downloadCancelContent: (NSString *)  mediaContentKey error: (NSError **)  error

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

パラメータ:

戻り値:

YES 成功

NO 失敗

• (BOOL) downloadContent: (NSString *)  mediaContentKey error: (NSError **)  error

コンテンツダウンロード (コンテンツインデックスでダウンロード)

パラメータ:

戻り値:

YES 成功

NO 失敗

• (NSString *) loadContentURL: (NSString *)  URL error: (NSError **)  error

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

パラメータ:

戻り値:

初期化が完了したコンテンツキー(media Content Key)

• (BOOL) removeCacheWithError: (NSError **)  error

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

パラメータ:

戻り値:

YES 成功

NO 失敗

• (BOOL) removeContent: (NSString *)  mediaContentKey error: (NSError **)  error

特定コンテンツ削除

パラメータ:

戻り値:

YES 成功

NO 失敗

• (void) sendStoredLms

未送信のLMSデータ転送

• (void) setBackgroundDownload: (BOOL)  bBackground

ストレージコンテンツのバックグラウンドをダウンロードするかどうか

• (void) setCacheSize: (NSInteger)  cacheSizeMB

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

パラメータ:

• (void) setNetworkTimeOut: (NSInteger)  timeOut retry: (NSInteger)  retryCount

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

パラメータ:

• (BOOL) setKollusPath: (NSString *)path

ストレージフォルダ設定

パラメータ:

戻り値:

YES 成功

NO 失敗

警告:

このメソッドは、新規アプリでのみ使用する必要があります。 そうでなければ、既存のdownloadされたコンテンツは見ることができない

スタートストレージ関数を呼び出し前に使用しなければならない。 default pathでDocumnetフォルダを使用

• (BOOL) startStorage: (NSError **)  error

KollusStorage 시작

パラメータ:

戻り値:

YES 成功

NO 失敗

警告:

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

• (BOOL) startStorageWithCheck: (NSError **)  error

KollusStorage 시작

パラメータ:

戻り値:

成功した場合はYES、失敗した場合はNOを返還

警告:

このメソッドを呼び出していない場合、コンテンツの数(contents Count)が0に返される

このメソッドは、キーチェーンからplayer ID獲得に失敗した場合、最初の実行であれば新たに生成後処理、最初の実行でなければ3回の要請すべてに失敗した場合、エラー処理

• (BOOL) startStorageWithFirst: (BOOL)  first error: (NSError **)  error

KollusStorage 시작

パラメータ:

戻り値:

成功した場合はYES、失敗した場合はNOを返還

警告:

このメソッドを呼び出していない場合、コンテンツの数(contents Count)が0に返される

• (BOOL) startStorageWithNewPlayerID: (NSError **)  error

KollusStorage 시작

パラメータ:

戻り値:

成功した場合はYES、失敗した場合はNOを返還

警告:

このメソッドを呼び出していない場合、コンテンツの数(contents Count)が0に返される

このメソッドはplayer IDを新たに作成してキーチェーンに登録して使用

• (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*) storagePath[readonly], [nonatomic], [copy]

Kollus SDK フォルダ

• (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で使用されるポート番号

• (long long) storageSize[read], [nonatomic], [unsafe_unretained]

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

「Kollus Storage Delegate」プロトコルを参照

#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 *)  kollusStorage cur: (int)  cur count: (int)  count error: (NSError *)  error

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

パラメータ:

• (void) kollusStorage: (KollusStorage *)  kollusStorage downloadContent: (KollusContent *)  content error: (NSError *)  error

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

パラメータ:

• (void) kollusStorage: (KollusStorage *)  kollusStorage lmsData: (NSString *)  lmsData resultJson: (NSDictionary *)  resultJsonLMS 

Callback処理後に呼び出し

パラメータ:

• (void) kollusStorage: (KollusStorage *)  kollusStorage request: (NSDictionary *)  request json: (NSDictionary *)  json error: (NSError *)  error

DRMCallback処理後に呼び出し

パラメータ:

• (void) onSendCompleteStoredLms: (int)  successCount failCount: (int)  failCount

未転送 LMS Callback完了後に呼び出し

パラメータ:

KPSection クラス参照

#import <KPSection.h>

属性

NSInteger startTime

Play Section Start Time.

NSInteger endTime

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]

SubTitle Infoクラス参照

字幕情報

#import <SubTitleInfo.h>

属性

NSString * strName

字幕名

NSString * strUrl

字幕経路

NSString * strLanguage

字幕言語

BOOL isAISubtitles

AI字幕可否

詳しい説明

字幕情報

速成文書化

• (NSString*) strLanguage[read], [nonatomic], [retain]

字幕言語

• (NSString*) strName[read], [nonatomic], [retain]

字幕名

• (NSString*) strUrl[read],[nonatomic], [retain]

字幕経路

• BOOL isAISubtitls[read], [nonatomic], [unsafe_unretained]

AI字幕可否

「UtilDelegate」プロトコル参照

#import <LogUtil.h>

インスタンス·メソッド

(void) - onLogUtil:

メソッド文書化

• (void) onLogUtil: (NSString *)  logData