メインコンテンツまでスキップ

KollusPlayerView

お知らせ

このドキュメントは機械翻訳で作成された下書きであり、現在レビュー中です。機械翻訳の特性上、一部の内容が不正確であったり、韓国語の原文と異なる場合があります。より正確な情報については、韓国語のドキュメントをご参照ください。

KollusPlayerView Class​

#import <KollusPlayerView.h>

コンテンツ再生、画面出力制御、イベントデリゲート設定などプレイヤーのすべての機能を制御するコアクラスです。

Instance Methods​

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

Properties​

  • id<KollusPlayerDelegate> delegate
  • id<KollusPlayerDRMDelegate> DRMDelegate
  • id<KollusPlayerLMSDelegate> LMSDelegate
  • id<KollusPlayerBookmarkDelegate> bookmarkDelegate
  • KollusStorage * storage
  • NSString * contentURL
  • NSString * mediaContentKey
  • KollusContent * content
  • BOOL AIRateEnable
  • NSTimeInterval currentPlaybackTime
  • NSTimeInterval liveDuration
  • 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
  • CGSize naturalSize
  • BOOL isZoomedIn
  • KollusPlayerType playerType
  • NSString * customSkin
  • KPSection * playSection
  • NSInteger nRepeatStartTime
  • NSInteger nRepeatEndTime
  • NSInteger nPlaybackLimitDuration
  • NSString * strPlaybackLimitMessage
  • BOOL audioBackgroundPlay
  • BOOL lmsOffDownloadContent
  • NSUInteger proxyPort
  • BOOL intro
  • BOOL seekable
  • NSInteger nSecSkip
  • BOOL isLive
  • BOOL disablePlayRate
  • NSInteger nSeekableEnd
  • NSString * strCaptionStyle
  • BOOL forceNScreen
  • BOOL ignoreZero
  • BOOL isThumbnailEnable
  • BOOL isThumbnailSync
  • NSString * fpsCertURL
  • NSString * fpsDrmURL
  • NSInteger nOfflineBookmarkUse
  • NSInteger nOfflineBookmarkDownload
  • NSInteger nOfflineBookmarkReadOnly
  • NSMutableDictionary * chapterInfo
  • NSString * strVideoWaterMark
  • NSInteger nVideoWaterMarkAlpha
  • NSInteger nVideoWaterMarkFontSize
  • NSString * strVideoWaterMarkFontColor
  • NSInteger nVideoWaterMarkShowTime
  • NSInteger nVideoWaterMarkHideTime
  • NSString * extraDrmParam
  • NSMutableArray * streamInfoList
  • KollusChat * kollusChat
  • NSInteger nextEpisodeShowTime
  • NSString * nextEpisodeCallbackURL
  • NSMutableDictionary * nextEpisodeCallbackParams
  • BOOL nextEpisodeShowButton
  • NSString *contentProviderKey
  • NSString *contentProviderName
  • BOOL disableBackgroundAudio
  • NSInteger maxPlaybackRate
  • NSMutableArray * listSubTitle
  • NSMutableArray * listSubTitleSub

Method Details​

(id) initWithContentURL: (NSString *) url

コンテンツ URL を基にプレイヤーを初期化します。

  • パラメーター
    • url: コンテンツ URL
  • 戻り値: 生成されたプレイヤー ID
(id) initWithMediaContentKey: (NSString *) mck

メディアコンテンツキーを基にプレイヤーを初期化します。オフライン（ダウンロード）コンテンツ再生時に使用します。

  • パラメーター
    • mck: メディアコンテンツキー
  • 戻り値: 生成されたプレイヤー ID
(BOOL) prepareToPlayWithMode: (KollusPlayerType) type error: (NSError **) error

プレイヤータイプ（Kollus または Native）でコンテンツ再生を準備します。

  • パラメーター
    • type: プレイヤータイプ
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) playWithError: (NSError **) error

prepareToPlayWithMode:error: の呼び出しが成功した場合、再生を開始します。

  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) pauseWithError: (NSError **) error

prepareToPlayWithMode:error: の呼び出しが成功した場合、再生を一時停止します。

  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) stopWithError: (NSError **) error

prepareToPlayWithMode:error: の呼び出しが成功した場合、再生を停止します。プレイヤータイプが PlayerTypeKollus の場合にのみ適用されます。

  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) scroll: (CGPoint) distance error: (NSError **) error

ビデオが出力される画面領域の座標を移動させます。

  • パラメーター
    • distance: 移動する距離
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) scrollStopWithError: (NSError **) error

ビデオ画面の移動を停止し、現在の位置に画面を固定します。

  • パラメーター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error

ユーザーのピンチジェスチャーを基にビデオ画面を動的に拡大または縮小します。

  • パラメーター
    • recognizer: 拡大のためのピンチジェスチャー情報を保持するオブジェクトポインター
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) addBookmark: (NSTimeInterval) position value: (NSString *) value error: (NSError **) error

ブックマークを追加します。ブックマークがすでに存在する場合は上書きします。

  • パラメーター
    • position: ブックマークを追加する位置
    • value: ブックマークの内容
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(BOOL) removeBookmark: (NSTimeInterval) position error: (NSError **) error

ブックマークを削除します。KollusBookmarkKindIndex タイプのブックマークは削除されません。

  • パラメーター
    • position: 削除するブックマークの位置
    • error: エラー詳細
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(void) setNetworkTimeOut: (NSInteger) timeOut

プレイヤーネットワークの Timeout を設定します。

  • パラメーター
    • timeOut: Timeout 値(sec)
(void) setBufferingRatio: (NSInteger) bufferingRatio

prepareToPlayWithMode:error: の呼び出しが成功した場合、バッファリング倍数を設定します。PlayerTypeKollus の場合にのみ適用されます。

  • パラメーター
    • bufferingRatio: 設定するバッファリング倍数
(BOOL) isOpened

プレイヤーの生成有無を確認します。

  • 戻り値: 生成有無（YES: 生成済み、NO: 未生成）
(BOOL) setSkipPlay

再生リストで現在再生中の動画をスキップします。

  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(void) changeBandWidth: (int) bandWidth

HLS 再生中に帯域幅(bandwidth)を変更します。

  • パラメーター
    • bandWidth: 設定する帯域幅の値
(bool) setSubTitlePath: (char *) path

使用する字幕ファイルを選択します。

  • パラメーター
    • path: 使用する字幕ファイルのパス
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(bool) setSubTitleSubPath: (char *) path

使用するサブ字幕ファイルを選択します。

  • パラメーター
    • path: 使用する字幕ファイルのパス
  • 戻り値: 処理結果（YES: 成功、NO: 失敗）
(CGRect) getVideoPosition

現在のビデオ再生領域の座標を返します。

  • 戻り値: ビデオ再生領域
(CGFloat) getZoomValue

ビデオ出力画面の拡大・縮小比率を返します。

  • 戻り値: 出力画面の拡大・縮小比率値
(void) setPauseOnForeground: (BOOL) bPause

アプリがフォアグラウンド状態に移行する際に、プレイヤーを一時停止状態に維持するかどうかを設定します。

  • パラメーター
    • bPause
      • YES: フォアグラウンド移行時に一時停止状態を維持する（アプリから直接 playWithError: を呼び出す必要があります）
      • NO（デフォルト）: フォアグラウンド移行時に自動再生
(void) setDisableZoomOut: (BOOL) bDisable

ズーム機能において縮小(zoom out)動作を無効化します。

  • パラメーター
    • bDisable: 縮小動作の有効・無効（YES: 無効、NO（デフォルト）: 有効）
(void) setDecoder: (bool) bHW

使用するコーデックを設定します。

  • パラメーター
    • bHW: コーデック種別（YES（デフォルト）: ハードウェアコーデック、NO: ソフトウェアコーデック）
(void) setAIRate: (bool) bAIRate

AI 倍速の使用有無を設定します。

  • パラメーター
    • bAIRate: AI 倍速の使用有無（YES（デフォルト）: AI 倍速、NO: 通常の再生速度）

Property Details​

属性説明
(id<KollusPlayerDelegate>) delegate
[read, write, nonatomic, weak]		プレイヤー関連デリゲート
(id<KollusPlayerDRMDelegate>) DRMDelegate
[read, write, nonatomic, weak]		DRM 情報関連デリゲート
(id<KollusPlayerLMSDelegate>) LMSDelegate
[read, write, nonatomic, weak]		LMS 情報関連デリゲート
(id<KollusPlayerBookmarkDelegate>) bookmarkDelegate
[read, write, nonatomic, weak]		ブックマーク関連デリゲート
(KollusStorage*) storage
[read, write, nonatomic, weak]		KollusStorage ポインター
(NSString*) contentURL
[read, write, nonatomic, copy]		再生するコンテンツ URL(Stream Play)
(NSString*) mediaContentKey
[read, write, nonatomic, assign]		再生するコンテンツのメディアコンテンツキー(Local Play)
(KollusContent*) content
[read, nonatomic, weak]		使用中のコンテンツ情報
(BOOL) AIRateEnable
[read, write, nonatomic, unsafe_unretained]		AI 倍速対応有無
(NSTimeInterval) currentPlaybackTime
[read, write, nonatomic, unsafe_unretained]		コンテンツの現在時刻
(NSTimeInterval) liveDuration
[read, nonatomic, unsafe_unretained]		ライブタイムシフト再生時間
(float) currentPlaybackRate
[read, write, nonatomic, unsafe_unretained]		コンテンツの再生速度。最大 10 倍速をサポート。2 倍速を超えると品質低下およびオーディオ/ビデオ同期の問題が発生する場合があります。
(NSArray*) bookmarks
[read, write, nonatomic, strong]		ブックマーク情報配列
(KollusPlayerContentMode) scalingMode
[read, write, nonatomic, unsafe_unretained]		コンテンツ出力モード
(CGRect) playerContentFrame
[read, write, nonatomic, unsafe_unretained]		プレイヤー画面領域
(KollusPlayerRepeatMode) repeatMode
[read, write, nonatomic, unsafe_unretained]		全体リピートモード
(BOOL) screenConnectEnabled
[read, nonatomic, unsafe_unretained]		画面出力許可有無
(BOOL) bookmarkModifyEnabled
[read, nonatomic, unsafe_unretained]		ブックマーク編集権限有無
(BOOL) debug
[read, write, nonatomic, unsafe_unretained]		デバッグログ出力有無
(BOOL) isPreparedToPlay
[read, nonatomic, unsafe_unretained]		再生準備完了有無
(BOOL) isPlaying
[read, nonatomic, unsafe_unretained]		再生中有無
(BOOL) isBuffering
[read, nonatomic, unsafe_unretained]		バッファリング進行有無
(BOOL) isSeeking
[read, nonatomic, unsafe_unretained]		シーク中有無
(BOOL) isScrolling
[read, nonatomic, unsafe_unretained]		画面移動中有無
(BOOL) isAudioOnly
[read, nonatomic, unsafe_unretained]		オーディオコンテンツ有無
(BOOL) muteOnStart
[read, nonatomic, unsafe_unretained]		開始時ミュート有無
(CGSize) naturalSize
[read, nonatomic, unsafe_unretained]		元のコンテンツの動画サイズ
(BOOL) isZoomedIn
[read, nonatomic, unsafe_unretained]		拡大(zoom in)有無
(KollusPlayerType) playerType
[read, nonatomic, assign]		プレイヤータイプ
(NSString*) customSkin
[read, write, nonatomic, copy]		プレイヤースキン情報 JSON
(KPSection*) playSection
[read, write, nonatomic, assign]		プレビュー情報
(NSInteger) nRepeatStartTime
[read, nonatomic, unsafe_unretained]		リピート再生開始時間
(NSInteger) nRepeatEndTime
[read, nonatomic, unsafe_unretained]		リピート再生終了時間
(NSInteger) nPlaybackLimitDuration
[read, nonatomic, unsafe_unretained]		再生制限時間
(NSString *) strPlaybackLimitMessage
[read, nonatomic, copy]		再生制限案内メッセージ
(BOOL) audioBackgroundPlay
[read, write, nonatomic, unsafe_unretained]		バックグラウンドオーディオファイル再生
(BOOL) lmsOffDownloadContent
[read, write, nonatomic, unsafe_unretained]		ダウンロードコンテンツの LMS 無効化有無
(NSUInteger) proxyPort
[read, write, nonatomic, unsafe_unretained]		プロキシサーバーポート番号
(BOOL) intro
[read, nonatomic, unsafe_unretained]		イントロ有無
(BOOL) seekable
[read, nonatomic, unsafe_unretained]		シーク(Seek)可能有無
(NSInteger) nSecSkip
[read, nonatomic, unsafe_unretained]		イントロスキップ待機時間(sec)
(BOOL) isLive
[read, nonatomic, unsafe_unretained]		ライブ有無
(BOOL) disablePlayRate
[read, nonatomic, unsafe_unretained]		再生速度コントロール無効化有無
(NSInteger) nSeekableEnd
[read, nonatomic, unsafe_unretained]		シーク(Seek)許可終了時点(sec)。seekable が false の場合にのみ適用。-1: シーク不可
(NSString*) strCaptionStyle
[read, nonatomic, copy]		Kollus Partner Portal で設定した字幕スタイル（"bg": 字幕背景適用、それ以外: ユーザー定義設定）
(BOOL) forceNScreen
[read, nonatomic, unsafe_unretained]		続きから再生の開始時点をユーザー確認なしに自動適用するかどうか
(BOOL) ignoreZero
[read, nonatomic, unsafe_unretained]		続きから再生の位置が基準時間より短くても続きから再生を有効化する
(BOOL) isThumbnailEnable
[read, nonatomic, unsafe_unretained]		サムネイル使用有無
(BOOL) isThumbnailSync
[read, nonatomic, unsafe_unretained]		サムネイルダウンロード方式（YES: 同期、NO: 非同期）
(NSString*) fpsCertURL
[read, write, nonatomic, copy]		FairPlay 認証 URL
(NSString*) fpsDrmURL
[read, write, nonatomic, copy]		FairPlay DRM URL
(NSInteger) nOfflineBookmarkUse
[read, nonatomic, unsafe_unretained]		オフラインブックマーク使用有無。ダウンロードコンテンツにのみ適用（0: 使用しない、1: 使用）
(NSInteger) nOfflineBookmarkDownload
[read, nonatomic, unsafe_unretained]		1: インデックスのみダウンロード、2: インデックス・ブックマーク両方ダウンロード
(NSInteger) nOfflineBookmarkReadOnly
[read, nonatomic, unsafe_unretained]		オフラインブックマークの追加・削除使用有無（0（デフォルト）: 使用、1: 使用しない）
(NSMutableDictionary*) chapterInfo
[read, nonatomic, assign]		チャプター情報リスト
(NSString*) strVideoWaterMark
[read, nonatomic, copy]		ビデオウォーターマークに表示する文字列
(NSInteger) nVideoWaterMarkAlpha
[read, nonatomic, unsafe_unretained]		ビデオウォーターマークの透明度
(NSInteger) nVideoWaterMarkFontSize
[read, nonatomic, unsafe_unretained]		ビデオウォーターマークのフォントサイズ
(NSString*) strVideoWaterMarkFontColor
[read, nonatomic, copy]		ビデオウォーターマークのテキスト色
(NSInteger) nVideoWaterMarkShowTime
[read, nonatomic, unsafe_unretained]		ビデオウォーターマークの表示時間
(NSInteger) nVideoWaterMarkHideTime
[read, nonatomic, unsafe_unretained]		ビデオウォーターマークの非表示時間
(NSString*) extraDrmParam
[read, write, nonatomic, copy]		動的 DRM パラメーター
(NSMutableArray*) streamInfoList
[read, nonatomic, assign]		HLS ABR 情報リスト
(KollusChat*) kollusChat
[read, write, nonatomic, assign]		ライブチャットオブジェクト
(NSInteger) nextEpisodeShowTime
[read, nonatomic, unsafe_unretained]		次の動画再生表示時間
(NSString*) nextEpisodeCallbackURL
[read, nonatomic, copy]		次の動画再生 URL
(NSMutableDictionary*) nextEpisodeCallbackParams
[read, nonatomic, assign]		次の動画再生パラメーター
(BOOL) nextEpisodeShowButton
[read, nonatomic, unsafe_unretained]		次の動画再生ボタンの表示有無
(NSString *) contentProviderKey
[read, nonatomic, copy]		コンテンツプロバイダーキー
(NSString *) contentProviderName
[read, nonatomic, copy]		コンテンツプロバイダー名
(BOOL) disableBackgroundAudio
[read, nonatomic, unsafe_unretained]		バックグラウンドオーディオ再生制限有無
(NSInteger) maxPlaybackRate
[read, nonatomic, unsafe_unretained]		コンテンツ再生速度の最大値
(NSMutableArray*) listSubTitle
[read, nonatomic, assign]		字幕ファイルリスト
(NSMutableArray*) listSubTitleSub
[read, nonatomic, assign]		サブ字幕ファイルリスト