最終更新: 2024.12.10_Review

iOS API References

API文書情報

• バージョン：2.3.19
• 日付：2024.12.10

KollusBookmarkクラス参照

#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

KollusContentクラス参照

#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

コンテンツ所要時間

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]

コンテンツ所要時間

• (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 *)  kollusPlayerViewbookmark: (NSArray *)  bookmarksenabled: (BOOL)  enabled error: (NSError *)  error

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

媒介変数:

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

#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)  buffering prepared: (BOOL)  prepared error: (NSError *)  error

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

媒介変数:

Remarks:

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

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

コンテンツの字幕配信

媒介変数:

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

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

媒介変数:

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

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

媒介変数:

• (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)  userInteraction error: (NSError *)  error

一時停止した場合に転送

媒介変数:

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

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

媒介変数:

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

再生速度が変更された

媒介変数:

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

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

媒介変数:

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

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

媒介変数:

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

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

媒介変数:

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

呼び出し後、コンテンツの再生準備が完了したかどうかを送信

媒介変数:

Remarks:

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

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

リピート再生モードが変更された

媒介変数:

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

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

媒介変数:

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

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

媒介変数:

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

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

媒介変数:

• (void) kollusPlayerView: (KollusPlayerView *)  kollusPlayerViewunknownError: (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 *)  kollusPlayerViewrequest: (NSDictionary *)  request json: (NSDictionary *)  json error: (NSError *)  error

DRM Callback転送後に呼び出し

媒介変数:

<Kollus PlayerLMSDelegate>プロトコルを参照

#import <KollusPlayerLMSDelegate.h>

インスタンス·メソッド

(void) - kollusPlayerView:lmsData:resultJson:

メソッド文書化

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

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

媒介変数:

KollusPlayer Viewクラスを参照

#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 isWaterMark

Audio water mark 可否

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

ダウンロードコンテンツlmsoff

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

NSMutableArray * listSubTitle

字幕ファイルリスト

NSMutableArray * listSubTitleSub

サブ字幕ファイルリスト

メソッド文書化

• (BOOL) addBookmark: (NSTimeInterval)  positionvalue: (NSString *)  value error: (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失敗

警告:

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

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

再生開始

媒介変数:

戻り値:

YES成功

NO失敗

警告:

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

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

バッファリング排水設定

媒介変数:

警告:

prepare To Player 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 

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

• (bool) setSubTitlePath: (char *)  path

字幕ファイル選択

媒介変数:

戻り値:

bool true:成功 false:失敗

• (bool) setSubTitleSubPath: (char *)  path

サブ字幕ファイル選択

媒介変数:

戻り値:

bool true:成功 false:失敗

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

再生中止

媒介変数:

戻り値:

YES成功

NO失敗

警告:

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

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

強制つなぎ

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

ダウンロードコンテンツlmsoff

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

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

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

Kollus SDK認証キー(カテノイドから発行)

NSString * applicationBundleID

application Bundle ID(ex:com.yourcompany.applicationname)

NSString * keychainGroup

keychain 그룹(ex:com.yourcompany.shared)

NSDate * applicationExpireDate

KollusSDK有効日(カテノイドより発行)

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 *)  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

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

媒介変数:

戻り値:

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

• (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を返還

警告:

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

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

• (BOOL) startStorageWithFirst: (BOOL)  firsterror: (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]

application 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]

Kollus SDK認証キー(カテノイドから発行)

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

DRMコンテンツリストを一括更新中に各コンテンツ更新済みの場合に呼び出し

媒介変数:

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

コンテンツのダウンロード中にステータスの変化がある場合、呼び出し

媒介変数:

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

Callback処理後に呼び出し

媒介変数:

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

DRM Callback処理後に呼び出し

媒介変数:

• (void) onSendCompleteStoredLms: (int)  successCountfailCount: (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

字幕言語

詳細な説明

字幕情報

属性文書化

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