iOS SDK_Old
最終更新 KollusSDK_iOS_v2.2.92_0401
[V2.2.92] - 2021.04.01
回路図索引
クラス回路図
クラス索引
クラスリスト
クラス、構造体、共用体、インターフェース
ファイル索引
ファイルリスト
全てのファイルのリスト
クラス文書化
KollusBookmark クラス参照
#import <KollusBookmark.h>
KollusBookmarkの継承ダイヤグラム:
属性
- NSTimeInterval position
ブックマーク位置
- NSDate * time
ブックマーク生成日時
- NSString * title
ブックマークタイトル(index: サービス提供者)
- NSString * value
- ブックマークタイトル(ユーザー)
- KollusBookmarkKind kind
- ブックマークタイプ
属性文書化
- - (KollusBookmarkKind) kind[read], [nonatomic], [assign]
- ブックマークタイプ
- - (NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]
- ブックマーク位置
- - (NSDate*) time[read], [nonatomic], [unsafe_unretained]
- ブックマーク生成日時
- - (NSString*) title[read], [nonatomic], [copy]
- ブックマークタイトル(index: サービス提供者)
- - (NSString*) value[read], [nonatomic], [copy]
- ブックマークタイトル(ユーザー)
このクラスの文書化ページは以下のファイルから生成されています。
- KollusBookmark.h
KollusContent クラス参照
#import <KollusContent.h>
KollusContentの継承ダイヤグラム:
属性
- NSString * company
- 社名
- NSString * title
- コンテンツタイトル
- NSString * course
- コース名
- NSString * teacher
- サービス提供者名
- NSString * snapshot
- スナップショットファイル経路
- NSString * thumbnail
- サムネイルファイル経路
- NSString * mediaContentKey
- メディアコンテンツキー
- NSString * synopsis
- シノプシス
- NSString * descriptionURL
- 詳細情報URL
- CGSize naturalSize
- 映像原本サイズ
- KollusContentType contentType
- コンテンツタイプ
- NSDate * DRMCheckDate
- DRM チェック日付
- NSDate * DRMExpireDate
- DRM 有効期限
- long DRMExpireCountMax
- DRM 最大再生回数
- long DRMExpireCount
- DRM 再生回数
- NSTimeInterval DRMTotalExpirePlayTime
- DRM 全体再生可能時間
- NSTimeInterval DRMExpirePlayTime
- DRM 再生可能時間
- BOOL DRMExpired
- DRM 有効性可否
- BOOL DRMExpireRefreshPopup
- DRM 有効期限更新ポップアップ表示有無
- NSTimeInterval duration
- コンテンツの長さ
- NSTimeInterval position
- 続き再生位置
- NSUInteger contentIndex
- コンテンツ index : ダウンロードコンテンツを再生する際に使用
- long long fileSize
- コンテンツ ファイルサイズ
- long long downloadSize
- ダウンロードされたファイルサイズ
- NSUInteger downloadProgress
- ダウンロード進行率
- BOOL downloaded
- ダウンロード完了有無
- int downloadedTime
- ファイルをダウンロードした日付
属性文書化
- - (NSString*) company[read], [nonatomic], [copy]
- 社名
- - (NSUInteger) contentIndex[read], [nonatomic], [unsafe_unretained]
- コンテンツ index : ダウンロードコンテンツを再生する際に使用
- - (KollusContentType) contentType[read], [nonatomic], [unsafe_unretained]
- コンテンツタイプ
- - (NSString*) course[read], [nonatomic], [copy]
- コース名
- - (NSString*) descriptionURL[read], [nonatomic], [copy]
詳細情報URL
- - (BOOL) downloaded[read], [nonatomic], [unsafe_unretained]
ダウンロード完了有無
- - (int) downloadedTime[read], [nonatomic], [unsafe_unretained]
- ファイルをダウンロードした日付
- - (NSUInteger) downloadProgress[read], [nonatomic], [unsafe_unretained]
- ダウンロード進行率
- - (long long) downloadSize[read], [nonatomic], [unsafe_unretained]
- ダウンロードされたファイルサイズ
- - (NSDate*) DRMCheckDate[read], [nonatomic], [strong]
- DRM チェック日付
- - (long) DRMExpireCount[read], [nonatomic], [unsafe_unretained]
- DRM再生回数
- - (long) DRMExpireCountMax[read], [nonatomic], [unsafe_unretained]
- DRM最大再生回数
- - (BOOL) DRMExpired[read], [nonatomic], [unsafe_unretained]
- DRM有効性可否
- - (NSDate*) DRMExpireDate[read], [nonatomic], [strong]
- DRM有効期限
- - (NSTimeInterval) DRMExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- DRM再生可能時間
- - (BOOL) DRMExpireRefreshPopup[read], [nonatomic], [unsafe_unretained]
- DRM 有効期限更新ポップアップ有無
- - (NSTimeInterval) DRMTotalExpirePlayTime[read], [nonatomic], [unsafe_unretained]
- DRM 全体再生可能時間
- - (NSTimeInterval) duration[read], [nonatomic], [unsafe_unretained]
- コンテンツの長さ
- - (long long) fileSize[read], [nonatomic], [unsafe_unretained]
- コンテンツのファイルサイズ
- - (NSString*) mediaContentKey[read], [nonatomic], [copy]
- メディアコンテンツキー
- - (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]
- 映像原本サイズ
- - (NSTimeInterval) position[read], [nonatomic], [unsafe_unretained]
- 続き再生位置
- - (NSString*) snapshot[read], [nonatomic], [copy]
スナップショットファイルのパス
- - (NSString*) synopsis[read], [nonatomic], [copy]
- シノプシス
- - (NSString*) teacher[read], [nonatomic], [copy]
- サービス提供者名
- - (NSString*) thumbnail[read], [nonatomic], [copy]
- サムネイルファイルのパス
- - (NSString*) title[read], [nonatomic], [copy]
- コンテンツタイトル
このクラスの文書化ページは以下のファイルから生成されています。
- KollusContent.h
<KollusPlayerBookmarkDelegate> プロトコル参照
#import <KollusPlayerBookmarkDelegate.h>
<KollusPlayerBookmarkDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - kollusPlayerView:bookmark:enabled:error:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView bookmark: (NSArray *) bookmarks enabled: (BOOL) enabled error: (NSError *) error
再生するコンテンツのブックマーク有無をリクエスト
パラメータ kollusPlayerView KollusPlayerView ID bookmarks KollusBookmark 配列 enabled YES: ブックマーク有 NO: ブックマーク無 error エラー内容
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerBookmarkDelegate.h
<KollusPlayerDelegate> プロトコル参照
#import <KollusPlayerDelegate.h>
<KollusPlayerDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - kollusPlayerView:prepareToPlayWithError:
- (void) - kollusPlayerView:play:error:
- (void) - kollusPlayerView:pause:error:
- (void) - kollusPlayerView:buffering:error:
- (void) - kollusPlayerView:stop:error:
- (void) - kollusPlayerView:position:error:
- (void) - kollusPlayerView:scroll:error:
- (void) - kollusPlayerView:zoom:error:
- (void) - kollusPlayerView:naturalSize:
- (void) - kollusPlayerView:playerContentMode:error:
- (void) - kollusPlayerView:playerContentFrame:error:
- (void) - kollusPlayerView:playbackRate:error:
- (void) - kollusPlayerView:repeat:error:
- (void) - kollusPlayerView:enabledOutput:error:
- (void) - kollusPlayerView:caption:text:position:error:
- (void) - kollusPlayerView:unknownError:
- (void) - kollusPlayerView:framerate:
- (void) - kollusPlayerView:lockedPlayer:
- (void) - kollusPlayerView:charset:caption:
- (void) - kollusPlayerView:thumbnail:error:
- (void) - kollusPlayerView:mck:
- (void) - kollusPlayerView:height:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL) buffering error: (NSError *) error
システムのデータバッファリングが停滞または停滞が解消された場合にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID buffering YES: バッファリング開始 buffering NO: バッファリング終了 error エラー内容 Remark
バッファリングがYESに変更される前にシステムからの一時停止デリケートがリクエストされた場合
バッファリングがNOに変更された場合にはUIでPlayWithError: メソッドをリクエストしてください。
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView caption: (KollusCaption *) caption text: (NSString *) text position: (NSTimeInterval) position error: (NSError *) error
字幕を表示する際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID caption 字幕情報 text 表示される字幕の内容 position 字幕が表示される位置 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *) charset caption: (char *) caption
コンテンツの字幕をリクエスト
パラメータ kollusPlayerView KollusPlayerView ID charset キャラクターセット caption 字幕情報
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL) enabledOutput error: (NSError *) error
外部ディスプライへの出力許可設定をリクエスト
パラメータ kollusPlayerView KollusPlayerView ID enabledOutput YES: 許可 enabledOutput NO: 禁止 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int) framerate
コンテンツのフレームレートをリクエスト
パラメータ kollusPlayerView KollusPlayerView ID framerate フレームレート
- - (void) kollusPlayerView: (KollusPlayerView *) view height: (int) height
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lockedPlayer: (KollusPlayerType) playerType
デバイスがロックされた際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID lockedPlayer 現在のplayerタイプ
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *) mck
メディアコンテンツキーをリクエスト
パラメータ kollusPlayerView KollusPlayerView ID mck メディアコンテンツキー
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize) naturalSize
コンテンツの原本映像サイズをリクエスト
パラメータ kollusPlayerView KollusPlayerView ID contentResolution 原本のサイズ
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView pause: (BOOL) userInteraction error: (NSError *) error
一時停止された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID userInteraction YES: ユーザーから一時停止 userInteraction NO: システムから一時停止 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView play: (BOOL) userInteraction error: (NSError *) error
再生が開始された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID userInteraction YES: ユーザーから開始 userInteraction NO: 全体繰り返しまたはシステムから開始 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playbackRate: (float) playbackRate error: (NSError *) error
倍速が変更された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID playbackRate 変更された倍速 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentFrame: (CGRect) contentFrame error: (NSError *) error
再生画面のサイズが変更された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID contentFrame 変更された画面サイズ error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentMode: (KollusPlayerContentMode) playerContentMode error: (NSError *) error
再生画面のモードが変更された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID playerContentMode 変更された画面モード error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView position: (NSTimeInterval) position error: (NSError *) error
再生位置を変更する前後にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID position 変更された再生位置の時間値 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView prepareToPlayWithError: (NSError *) error
prepareToPlayリクエスト後にコンテンツの再生準備完了可否をリクエスト
パラメータ kollusPlayerView KollusPlayerView ID error エラー内容 Remark
errorがnil以外の場合には再生準備に失敗
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView repeat: (BOOL) repeat error: (NSError *) error
リピート再生が開始または解除された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID repeat YES: リピート再生設定状態に変更 repeat NO: リピート再生解除状態に変更 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView scroll: (CGPoint) distance error: (NSError *) error
画面が移動される前後にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID distance 移動距離 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView stop: (BOOL) userInteraction error: (NSError *) error
再生が終了された際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID userInteraction YES: ユーザーから終了 userInteraction NO: 最後まで再生完了またはシステムから終了 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView thumbnail: (BOOL) isThumbnail error: (NSError *) error
サムネイルの非同期ダウンロード完了の際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID thumbnail 有無 error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error
その他のエラーが発生した際にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID error エラー内容
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
再生画面のズームインまたはズームアウトの前後にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID recognizer pinchズームを適用するUIPinchGestureRecognizerポインター error エラー内容 - リターン: YES=成功, NO=失敗
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerDelegate.h
<KollusPlayerDRMDelegate> プロトコル参照
#import <KollusPlayerDRMDelegate.h>
<KollusPlayerDRMDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - kollusPlayerView:request:json:error:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
DRM Callback 転送後にリクエスト
パラメータ kollusPlayerView KollusPlayerView ID json レスポンスされたJSONオブジェクト error エラー内容
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerDRMDelegate.h
<KollusPlayerLMSDelegate> プロトコル参照
#import <KollusPlayerLMSDelegate.h>
<KollusPlayerLMSDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - kollusPlayerView:json:error:
メソッド文書化
- - (void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView json: (NSDictionary *) json error: (NSError *) error
LMSデータをサーバーに転送してからリクエスト
パラメータ kollusPlayerView KollusPlayerView ID json リクエストしたJSONオブジェクト error エラー内容(nil: 成功)
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusPlayerLMSDelegate.h
KollusPlayerView クラス参照
#import <KollusPlayerView.h>
KollusPlayerViewの継承ダイヤグラム:
インスタンスメソッド
- (id) - initWithContentURL:
- (id) - initWithMediaContentKey:
- (BOOL) - prepareToPlayWithMode:error:
- (BOOL) - playWithError:
- (BOOL) - pauseWithError:
- (BOOL) - stopWithError:
- (BOOL) - scroll:error:
- (BOOL) - scrollStopWithError:
- (BOOL) - zoom:error:
- (BOOL) - addBookmark:value:error:
- (BOOL) - removeBookmark:error:
- (void) - setNetworkTimeOut:
- (void) - setBufferingRatio:
- (BOOL) - isOpened
- (BOOL) - setSkipPlay
- (void) - changeBandWidth:
- (bool) - setSubTitlePath:
- (CGRect) - getVideoPosition
- (CGFloat) - getZoomValue
- (void) - setPauseOnForeground:
属性
- id< KollusPlayerDelegate > delegate
- プレーヤー関連 デリゲート
- id< KollusPlayerDRMDelegate > DRMDelegate
- DRM情報関連 デリゲート
- id< KollusPlayerLMSDelegate > LMSDelegate
- LMS情報関連 デリゲート
- id< KollusPlayerBookmarkDelegate > bookmarkDelegate
- ブックマーク関連 デリゲート
- KollusStorage * storage
- KollusStorage ポインター
- NSString * contentURL
- 再生するコンテンツ URL (ストリーミング再生)
- NSString * mediaContentKey
- 再生するコンテンツのメディアコンテンツキー (ダウンロード再生)
- KollusContent * content
- 現在のコンテンツ情報
- NSTimeInterval currentPlaybackTime
- コンテンツの現在時間
- NSTimeInterval liveSeekableDuration
- ライブタイムシフト長さ
- float currentPlaybackRate
- コンテンツの倍速
- NSArray * bookmarks
- ブックマーク情報の配列
- KollusPlayerContentMode scalingMode
- コンテンツの出力モード
- CGRect playerContentFrame
- プレーヤー画面の領域
- KollusPlayerRepeatMode repeatMode
- 全体繰り返しモード
- BOOL screenConnectEnabled
- 画面出力許可設定
- BOOL bookmarkModifyEnabled
- ブックマーク編集権限の有無
- BOOL debug
- デバッグログ出力の有無
- BOOL isPreparedToPlay
- 再生準備完了状態かどうか
- BOOL isPlaying
- 再生中かどうか
- BOOL isBuffering
- バッファリング進行中かどうか
- BOOL isSeeking
- シーク中かどうか
- BOOL isScrolling
- 画面移動中かどうか
- BOOL isWaterMark
- Audio water mark設定の有無
- BOOL isAudioOnly
- オーディオコンテンツかどうか
- BOOL muteOnStart
- ミュートで再生開始設定の有無
- CGSize naturalSize
- 原本コンテンツ映像サイズ
- BOOL isZoomedIn
- ズームインかどうか
- KollusPlayerType playerType
- プレーヤータイプ
- NSString * customSkin
- プレーヤースキン情報のJSONデータ
- KPSection * playSection
- プレビュー情報
- BOOL audioBackgroundPlay
- オーディオファイルバックグラウンド再生
- BOOL lmsOffDownloadContent
- ダウンロードコンテンツのlms情報を無効化
- NSUInteger proxyPort
- プロキシサーバーポートを指定
- BOOL intro
- introかどうか
- BOOL seekable
- シーク可能かどうか
- NSInteger nSecSkip
- 指定されたn秒後にスキップ
- BOOL isLive
- ライブかどうか
- BOOL disablePlayRate
- 倍速調整可能設定の有無
- NSInteger nSeekableEnd
- 指定されたn秒までまたは現在再生秒までシークすることができる。seekableがfalseの場合のみ適用可能: -1=シーク不可
- NSString * strCaptionStyle
- Partner portalで設定: 字幕スタイル"bg"=字幕背景適用, "bg"以外=ユーザー設定
- BOOL forceNScreen
- 必ず続きから再生する
- BOOL isThumbnailEnable
- サムネイル有効化の有無
- BOOL isThumbnailSync
- サムネールダウンロード方式(sync, async)
- NSString * fpsCertURL
- FairPlaye認証URL
- NSString * fpsDrmURL
- FairPlaye DRM URL
- NSInteger nOfflineBookmarkUse
- オフラインブックマークはダウンロード再生のみ使用 (0: 使用しない, 1: 使用する)
- NSInteger nOfflineBookmarkDownload
- 1: Indexブックマークのみダウンロード, 2: Indexブックマークとユーザーブックマークを全てダウンロード
- NSInteger nOfflineBookmarkReadOnly
- ブックマーク編集権限の有無 (0: あり-default, 1: なし)
- NSString * strVideoWaterMark
- ビデオウォーターマークの文字
- NSInteger nVideoWaterMarkAlpha
- ビデオウォーターマークのalpha値
- NSInteger nVideoWaterMarkFontSize
- ビデオウォーターマークのフォントサイズ
- NSString * strVideoWaterMarkFontColor
- ビデオウォーターマークのカラー
- NSInteger nVideoWaterMarkShowTime
- ビデオウォーターマークの表示時間
- NSInteger nVideoWaterMarkHideTime
- ビデオウォーターマークの非表示時間
- NSString * extraDrmParam
- 追加DRMパラメータ
- NSMutableArray * streamInfoList
- HLS ABR Information.
- NSMutableArray * listSubTitle
- 字幕ファイルリスト
メソッド文書化
- - (BOOL) addBookmark: (NSTimeInterval) position value: (NSString *) value error: (NSError **) error
ブックマークを登録する
パラメータ position 追加する位置 value ブックマークのタイトル error エラー内容 リターン: YES=登録可能, NO=登録不可
指定したpositionに既にブックマークが登録されている場合、新たに入力したブックマークで入れ替わる。
- - (void) changeBandWidth: (int) bandWidth
- HLSストリーミングでbandwidthが変更された際にリクエスト
- - (CGRect) getVideoPosition
- ビデオ領域を取得する
- リターン: CGRect ビデオ再生位置
- - (CGFloat) getZoomValue
- 画面のズームイン/ズームアウト値を取得する
- リターン: CGFloat 画面の拡大/縮小比率値
- - (id) initWithContentURL: (NSString *) url
コンテンツURLを使用してプレーヤーを生成
パラメータ url 再生するコンテンツのURL - リターン: 生成されたPlayer ID
- - (id) initWithMediaContentKey: (NSString *) mck
コンテンツ indexを使用してプレーヤーを生成 (ダウンロードしたコンテンツのみ使用)
パラメータ mck 再生するコンテンツのメディアコンテンツキー - リターン: 生成されたPlayer ID
- - (BOOL) isOpened
- プレーヤー生成有無を取得
- リターン: YES=生成されている, NO=生成されていない
- - (BOOL) pauseWithError: (NSError **) error
一時停止
パラメータ error エラー内容 リターン: YES=成功, NO=失敗
prepareToPlayerWithError メソッドのリクエストに成功してから使用する
- - (BOOL) prepareToPlayWithMode: (KollusPlayerType) type error: (NSError **) error
再生準備完了 (KollusPlayer or Native player)
パラメータ type プレーヤータイプ error エラー内容 - リターン: YES=成功, NO=失敗
- - (BOOL) removeBookmark: (NSTimeInterval) position error: (NSError **) error
ブックマークを削除する
パラメータ position 削除するブックマークの位置 error エラー内容 リターン: YES=削除可能, NO=削除不可
ブックマークのkindがKollusBookmarkKindIndexの場合、削除されない
- - (BOOL) scroll: (CGPoint) distance error: (NSError **) error
ビデオ出力画面を移動
パラメータ distance 移動する距離 error エラー内容 - リターン: YES=成功, NO=失敗
- - (BOOL) scrollStopWithError: (NSError **) error
ビデオ出力画面の移動を中止 (画面位置固定)
パラメータ error エラー内容 - リターン: YES=成功, NO=失敗
- - (void) setBufferingRatio: (NSInteger) bufferingRatio
バッファリング倍数を設定
パラメータ bufferingRatio 設定するバッファリング倍数 prepareToPlayerWithError メソッドのリクエストに成功してから使用する
PlayerTypeKollusのみ使用可能
- - (void) setNetworkTimeOut: (NSInteger) timeOut
Playerのネットワークタイムアウト値を設定
パラメータ timeOut タイムアウト値(秒) retryCount リトライ回数
- (void) setPauseOnForeground: (BOOL) bPause
Foreground状態に変更した際にPlayerの再生状態をPauseのままに維持するAPI
パラメータ NO(default) Foregroundになると自動再生(既存動作) YES Foregroundになってもpause状態維持。APP側で必要に応じてPlay処理が必要
- - (BOOL) setSkipPlay
- play listの中で現在再生中のコンテンツをスキップ
- - (bool) setSubTitlePath: (char *) path
字幕ファイルを選択
パラメータ path 使用する字幕ファイルのパス - リターン: bool true=成功, false=失敗
- - (BOOL) pauseWithError: (NSError **) error
再生中断
パラメータ error エラー内容 リターン: YES=成功, NO=失敗
prepareToPlayerWithError メソッドのリクエストに成功してから使用する
- - (BOOL) zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
ビデオ出力画面の拡大/縮小
パラメータ recognizer pinchズームを適用するUIPinchGestureRecognizerポインター error エラー内容 - リターン: YES=成功, NO=失敗
属性文書化
- - (BOOL) audioBackgroundPlay[read], [write], [nonatomic], [unsafe_unretained]
- オーディオファイルバックグラウンド再生
- - (id) bookmarkDelegate[read], [write], [nonatomic], [weak]
- ブックマーク関連デリゲート
- - (BOOL) bookmarkModifyEnabled[read], [nonatomic], [unsafe_unretained]
- ブックマーク編集権限の有無
- - (NSArray*) bookmarks[read], [write], [nonatomic], [strong]
- ブックマーク情報の配列
- - (KollusContent*) content[read], [nonatomic], [weak]
- 使用中のコンテンツ情報
- - (NSString*) contentURL[read], [write], [nonatomic], [copy]
- 再生するコンテンツのURL (ストリーミング再生)
- - (float) currentPlaybackRate[read], [write], [nonatomic], [unsafe_unretained]
再生速度: 最大10倍速まで設定可能
速度が2倍を超える場合、画質低下、ビデオとオーディオのシンクが合わなくなる可能性がある
- - (NSTimeInterval) currentPlaybackTime[read], [write], [nonatomic], [unsafe_unretained]
- コンテンツの現在時間
- - (NSString*) customSkin[read], [write], [nonatomic], [copy]
- プレーヤースキン情報のJSONデータ
- - (BOOL) debug[read], [write], [nonatomic], [unsafe_unretained]
- デバッグログ出力の有無
- - (id) delegate[read], [write], [nonatomic], [weak]
- プレーヤー関連 デリゲート
- - (BOOL) disablePlayRate[read], [nonatomic], [unsafe_unretained]
- 倍速調整可能設定の有無
- - (id) DRMDelegate[read], [write], [nonatomic], [weak]
- DRM情報関連 デリゲート
- - (NSString*) extraDrmParam[read], [write], [nonatomic], [copy]
- 追加DRMパラメータ
- - (BOOL) forceNScreen[read], [nonatomic], [unsafe_unretained]
- 必ず続きから再生する
- - (NSString*) fpsCertURL[read], [write], [nonatomic], [copy]
- FairPlaye認証URL
- - (NSString*) fpsDrmURL[read], [write], [nonatomic], [copy]
- FairPlaye DRM URL
- - (BOOL) intro[read], [nonatomic], [unsafe_unretained]
- introかどうか
- - (BOOL) isAudioOnly[read], [nonatomic], [unsafe_unretained]
- オーディオコンテンツかどうか
- - (BOOL) isBuffering[read], [nonatomic], [unsafe_unretained]
- バッファリング進行中かどうか
- - (BOOL) isLive[read], [nonatomic], [unsafe_unretained]
- ライブかどうか
- - (BOOL) isPlaying[read], [nonatomic], [unsafe_unretained]
- 再生中かどうか
- - (BOOL) isPreparedToPlay[read], [nonatomic], [unsafe_unretained]
- 再生準備完了状態かどうか
- - (BOOL) isScrolling[read], [nonatomic], [unsafe_unretained]
- 画面移動中かどうか
- - (BOOL) isSeeking[read], [nonatomic], [unsafe_unretained]
- シーク中かどうか
- - (BOOL) isThumbnailEnable[read], [nonatomic], [unsafe_unretained]
- サムネイル有効化の有無
- - (BOOL) isThumbnailSync[read], [nonatomic], [unsafe_unretained]
- サムネールダウンロード方式(sync, async)
- - (BOOL) isWaterMark[read], [nonatomic], [unsafe_unretained]
- Audio water mark設定の有無
- - (BOOL) isZoomedIn[read], [nonatomic], [unsafe_unretained]
- ズームインかどうか
- - (NSMutableArray*) listSubTitle[read], [nonatomic], [assign]
- 字幕ファイルリスト
- - (NSTimeInterval) liveSeekableDuration[read], [nonatomic], [unsafe_unretained]
- ライブタイムシフト長さ
- - (id) LMSDelegate[read], [write], [nonatomic], [weak]
- LMS情報関連 デリゲート
- - (BOOL) lmsOffDownloadContent[read], [write], [nonatomic], [unsafe_unretained]
- ダウンロードコンテンツのlms情報を無効化
- - (NSString*) mediaContentKey[read], [write], [nonatomic], [assign]
- 再生するコンテンツのメディアコンテンツキー (ダウンロード再生)
- - (BOOL) muteOnStart[read], [nonatomic], [unsafe_unretained]
- ミュートで再生開始設定の有無
- - (CGSize) naturalSize[read], [nonatomic], [unsafe_unretained]
- 原本コンテンツ映像サイズ
- - (NSInteger) nOfflineBookmarkDownload[read], [nonatomic], [unsafe_unretained]
- 1: Indexブックマークのみダウンロード, 2: Indexブックマークとユーザーブックマークを全てダウンロード
- - (NSInteger) nOfflineBookmarkReadOnly[read], [nonatomic], [unsafe_unretained]
- ブックマーク編集権限の有無 (0: あり-default, 1: なし)
- - (NSInteger) nOfflineBookmarkUse[read], [nonatomic], [unsafe_unretained]
- オフラインブックマークはダウンロード再生のみ使用 (0: 使用しない, 1: 使用する)
- - (NSInteger) nSecSkip[read], [nonatomic], [unsafe_unretained]
- 指定されたn秒後にスキップ
- - (NSInteger) nSeekableEnd[read], [nonatomic], [unsafe_unretained]
- 指定されたn秒までまたは現在再生秒までシークすることができる。seekableがfalseの場合のみ適用可能: -1=シーク不可
- - (NSInteger) nVideoWaterMarkAlpha[read], [nonatomic], [unsafe_unretained]
- ビデオウォーターマークのalpha値
- - (NSInteger) nVideoWaterMarkFontSize[read], [nonatomic], [unsafe_unretained]
- ビデオウォーターマークのフォントサイズ
- - (NSInteger) nVideoWaterMarkHideTime[read], [nonatomic], [unsafe_unretained]
- ビデオウォーターマークの非表示時間
- - (NSInteger) nVideoWaterMarkShowTime[read], [nonatomic], [unsafe_unretained]
- ビデオウォーターマークの表示時間
- - (CGRect) playerContentFrame[read], [write], [nonatomic], [unsafe_unretained]
- プレーヤー画面の領域
- - (KollusPlayerType) playerType[read], [nonatomic], [assign]
- プレーヤータイプ
- - (KPSection*) playSection[read], [write], [nonatomic], [assign]
- プレビュー情報
- - (NSUInteger) proxyPort[read], [write], [nonatomic], [unsafe_unretained]
- プロキシサーバーポートを指定
- - (KollusPlayerRepeatMode) repeatMode[read], [write], [nonatomic], [unsafe_unretained]
- 全体繰り返しモード
- - (KollusPlayerContentMode) scalingMode[read], [write], [nonatomic], [unsafe_unretained]
- コンテンツの出力モード
- - (BOOL) screenConnectEnabled[read], [nonatomic], [unsafe_unretained]
- 画面出力許可設定
- - (BOOL) seekable[read], [nonatomic], [unsafe_unretained]
- シーク可能かどうか
- - (KollusStorage*) storage[read], [write], [nonatomic], [weak]
- 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]
- ビデオウォーターマークのカラー
このクラスの文書化ページは以下のファイルから生成されています。
- KollusPlayerView.h
KollusStorage クラス参照
#import <KollusContent.h>
KollusStorageの継承ダイヤグラム:
インスタンスメソッド
- (BOOL) - startStorage:
- (NSString *) - loadContentURL:error:
- (NSString *) - checkContentURL:error:
- (BOOL) - downloadContent:error:
- (BOOL) - removeContent:error:
- (BOOL) - removeCacheWithError:
- (BOOL) - downloadCancelContent:error:
- (void) - setNetworkTimeOut:retry:
- (void) - updateDownloadDRMInfo:
- (void) - setCacheSize:
- (void) - setBackgroundDownload:
- (NSMutableArray *) - contents
- (void) - sendStoredLms
属性
- id< KollusStorageDelegate > delegate
- ダウンロード状態情報 デリゲート
- NSString * applicationVersion
- 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 long storageSize
- ダウンロードしたコンテンツの全体サイズ (bytes)
- long long cacheDataSize
- キャッシュデータの全体サイズ (bytes)
- NSInteger serverPort
- ハイブリッドアプリで使用するポート番号
- NSString * extraDrmParam
- 追加DRMパラメータ
- NSString * appUserAgent
- ユーザーエージェント
- NSString * deviceType
- デバイスタイプ (kp-mobile, kp-tablet)
メソッド文書化
- - (NSString*) checkContentURL: (NSString *) URL error: (NSError **) error
コンテンツ ダウンロードを確認: 転送されたURLに該当するコンテンツのダウンロード有無及びメディアコンテンツキーを確認する際に使用する。
パラメータ url ダウンロードするコンテンツのURL error エラー内容 - リターン: ダウンロード完了されたコンテンツのメディアコンテンツキー
- - (NSMutableArray*) contents
- ダウンロードコンテンツ情報の配列
- - (BOOL) downloadCancelContent: (NSString *) mediaContentKey error: (NSError **) error
コンテンツ ダウンロードを中止
パラメータ mediaContentKey ダウンロードを中止するコンテンツのメディアコンテンツキー error エラー内容 - リターン: YES=成功, NO=失敗
- - (BOOL) downloadContent: (NSString *) mediaContentKey error: (NSError **) error
コンテンツ ダウンロード: コンテンツIndexにダウンロード
パラメータ mediaContentKey ダウンロードするコンテンツのメディアコンテンツキー - リターン: YES=成功, NO=失敗
- - (NSString *) loadContentURL: (NSString *) URL error: (NSError **) error
コンテンツ ダウンロードを初期化
パラメータ url ダウンロードを初期化するコンテンツのURL error エラー内容 - リターン: ダウンロード初期化が完了されたコンテンツのメディアコンテンツキー
- - (BOOL) removeCacheWithError: (NSError **) error
ストリーミング再生したコンテンツのキャッシュデータを削除する。
パラメータ error エラー内容 - リターン: YES=成功, NO=失敗
- - (BOOL) removeContent: (NSString *) mediaContentKey error: (NSError **) error
指定したコンテンツを削除する。
パラメータ mediaContentKey 削除するコンテンツのメディアコンテンツキー error エラー内容 - リターン: YES=成功, NO=失敗
- - (void) sendStoredLms
- 残っているLMSデータを転送する。
- - (void) setBackgroundDownload: (BOOL) bBackground
- ストレージのコンテンツのバックグラウンドダウンロード設定の有無
- - (void) setCacheSize: (NSInteger) cacheSizeMB
ストレージのキャッシュサイズを設定する。
パラメータ cacheSizeMB ストリーミングコンテンツのキャッシュサイズ(Mega Bytes)
- - (void) setNetworkTimeOut: (NSInteger) timeOut retry: (NSInteger) retryCount
ストレージのネットワークタイムアウト値を設定
パラメータ timeOut タイムアウト値(秒) retryCount リトライ回数
- - (BOOL) startStorage: (NSError **) error
KollusStorageを開始する。
パラメータ error エラー内容 リターン: YES=成功, NO=失敗
このメソッドをリクエストしない場合、コンテンツ情報配列(contents)がnilでリターンされる。
- - (void) updateDownloadDRMInfo: (BOOL) bAll
DRMコンテンツリストを更新
パラメータ expired YES=全てのコンテンツ, NO=有効期限切れのコンテンツのみ
属性文書化
- - (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]
- ユーザーエージェント
- - (long long) cacheDataSize[read], [nonatomic], [unsafe_unretained]
- キャッシュデータの全体サイズ (bytes)
- - (id) delegate[read], [write], [nonatomic], [weak]
- ダウンロード状態情報 デリゲート
- - (NSString*) deviceType[read], [nonatomic], [copy]
- デバイスタイプ (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]
- ハイブリッドアプリで使用するポート番号
- - (long long) storageSize[read], [nonatomic], [unsafe_unretained]
- ダウンロードしたコンテンツの全体サイズ (bytes)
このクラスの文書化ページは以下のファイルから生成されています。
- KollusStorage.h
<KollusStorageDelegate> プロトコル参照
#import <KollusStorageDelegate.h>
<KollusStorageDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - kollusStorage:downloadContent:error:
- (void) - kollusStorage:request:json:error:
- (void) - kollusStorage:cur:count:error:
- (void) - kollusStorage:lmsData:resultJson:
- (void) - onSendCompleteStoredLms:failCount:
メソッド文書化
- - (void) kollusStorage: (KollusStorage *) kollusStorage cur: (int) cur count: (int) count error: (NSError *) error
DRMコンテンツリストを一括更新する場合、各コンテンツ別の更新が終わる度にリクエスト
パラメータ KollusStorage KollusStorage ID cur 現在項目 count 全体件数 error エラー内容: nilではない場合エラー発生
- - (void) kollusStorage: (KollusStorage *) kollusStorage downloadContent: (KollusContent *) content error: (NSError *) error
コンテンツ ダウンロード途中で状態に変化があった場合リクエスト
パラメータ KollusStorage KollusStorage ID content 状態が変更されたコンテンツの情報 error エラー内容: nilではない場合エラー発生
- - (void) kollusStorage: (KollusStorage *) kollusStorage lmsData: (NSString *) lmsData resultJson: (NSDictionary *) resultJson
LMS Callbackの処理後にリクエスト
パラメータ KollusStorage KollusStorage ID lmsData LMSデータ情報 lmsResult LMS結果情報
- - (void) kollusStorage: (KollusStorage *) kollusStorage request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
DRM Callbackの処理後にリクエスト
パラメータ KollusStorage KollusStorage ID request リクエスト情報 json レスポンスされたJSON error エラー内容: nilではない場合エラー発生
- - (void) onSendCompleteStoredLms: (int) successCount failCount: (int) failCount
残っているLMSデータを転送してからリクエスト
パラメータ successCount 転送成功回数 failCount 転送失敗回数
このプロトコルの文書化ページは以下のファイルから生成されています。
- KollusStorageDelegate.h
KPSection クラス参照
#import <KPSection.h>
KPSectionの継承ダイヤグラム:
属性
- 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.
このクラスの文書化ページは以下のファイルから生成されています。
- KPSection.h
LogUtil クラス参照
#import <LogUtil.h>
LogUtilの継承ダイヤグラム:
クラスメソッド
- (instancetype) + sharedUtil
- (void) + utilLog:
メソッド文書化
- + (instancetype) sharedUtil
- + (void) utilLog: (NSString *) logContent , ...
属性文書化
- - (id) utilDelegate[read], [write], [nonatomic], [weak]
このクラスの文書化ページは以下のファイルから生成されています。
- LogUtil.h
SubTitleInfo クラス参照
#import <SubTitleInfo.h>
SubTitleInfoの継承ダイヤグラム:
属性
- NSString * strName
- 字幕のタイトル
- NSString * strUrl
- 字幕のパス
- NSString * strLanguage
- 字幕の言語
書斎説明
字幕の情報
属性文書化
- - (NSString*) strLanguage[read], [write], [nonatomic], [retain]
- 字幕の言語
- - (NSString*) strName[read], [write], [nonatomic], [retain]
- 字幕のタイトル
- - (NSString*) strUrl[read], [write], [nonatomic], [retain]
- 字幕のパス
このクラスの文書化ページは以下のファイルから生成されています。
- SubTitleInfo.h
<UtilDelegate> プロトコル参照
#import <LogUtil.h>
<UtilDelegate>の継承ダイヤグラム:
インスタンスメソッド
- (void) - onLogUtil:
メソッド文書化
- - (void) onLogUtil: (NSString *) logData[required]
このプロトコルの文書化ページは以下のファイルから生成されています。
- LogUtil.h
ファイル文書化
._KollusPlayerLMSDelegate.h ファイル参照
変数
- Mac OS X ? ? ATTR
変数文書化
- Mac OS X ? ? ATTR
._LogUtil.h ファイル参照
変数
- Mac OS X ? ? ATTR
変数文書化
- Mac OS X ? ? ATTR
KollusBookmark.h ファイル参照
#import "KollusSDK.h"
クラス
- class KollusBookmark
関数
- typedef NS_ENUM (NSInteger, KollusBookmarkKind)
- ユーザーブックマーク
- Indexブックマーク
KollusContent.h ファイル参照
#import "KollusSDK.h"
- class KollusContent
KollusPlayerBookmarkDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerBookmarkDelegate>
KollusPlayerDelegate.h ファイル参照
クラス
- protocol <KollusPlayerDelegate>
KollusPlayerDRMDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerDRMDelegate>
KollusPlayerLMSDelegate.h ファイル参照
#import "KollusSDK.h"
クラス
- protocol <KollusPlayerDRMDelegate>
KollusPlayerView.h ファイル参照
#import <AVFoundation/AVFoundation.h>
#import "KollusSDK.h"
#import "KollusPlayerDelegate.h"
#import "KollusPlayerDRMDelegate.h"
#import "KollusPlayerLMSDelegate.h"
#import "KollusPlayerBookmarkDelegate.h"
#import "KPSection.h"
クラス
- class KollusPlayerView
KollusSDK.h ファイル参照
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
関数
- typedef NS_ENUM (NSInteger, KollusPlayerType)
- プレーヤータイプ
- typedef NS_ENUM (NSInteger, KollusContentType)
- コンテンツタイプ
- typedef NS_ENUM (NSInteger, KollusPlayerContentMode)
- プレーヤー画面出力モード
- typedef NS_ENUM (NSInteger, KollusPlayerRepeatMode)
- リピート再生モード
関数文書化
- typedef NS_ENUM (NSInteger , KollusPlayerType )
- プレーヤータイプ
- Kollus Player
- Native player
- HLS player
- プレーヤータイプ
- typedef NS_ENUM (NSInteger , KollusContentType )
- コンテンツタイプ
- ストリーミングコンテンツ
- ダウンロードコンテンツ
- コンテンツタイプ
- typedef NS_ENUM (NSInteger , KollusPlayerContentMode )
- プレーヤー画面出力モード
画面サイズに合わせる
画面サイズに埋める
コンテンツ原本サイズ(画面サイズより小さい場合KollusPlayerContentModeScaleAspectFitを適用)
画面比率を無視して画面サイズに埋める
- プレーヤー画面出力モード
- typedef NS_ENUM (NSInteger , KollusPlayerRepeatMode )
- リピート再生モード
- リピート再生しない
- リピート再生する
- リピート再生モード
KollusStorage.h ファイル参照
#import <AVKit/AVKit.h>
#import "KollusSDK.h"
#import "KollusStorageDelegate.h"
クラス
- class KollusStorage
KollusStorageDelegate.h ファイル参照
クラス
protocol <KollusStorageDelegate>
KPSection.h ファイル参照
#import <Foundation/Foundation.h>
クラス
- class KPSection
LogUtil.h ファイル参照
#import <Foundation/Foundation.h>
クラス
- class LogUtil
- protocol <UtilDelegate>
SubTitleInfo.h ファイル参照
#import <Foundation/Foundation.h>
クラス
- class SubTitleInfo
Copyright © CATENOID, lnc. All Rights Reserved.
E-mail. jp_sales@catenoid.net | Tel. 03-4405-8462