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

Player Delegates

KollusPlayerBookmarkDelegate Protocol​

#import <KollusPlayerBookmarkDelegate.h>

再生コンテンツのブックマーク情報を受信するプロトコルです。

Instance Methods​

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

Method Details​

(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView bookmark: (NSArray *) bookmarks enabled: (BOOL) enabled error: (NSError *) error

再生中のコンテンツのブックマーク情報がロードされたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • bookmarks: KollusBookmark オブジェクトの配列
    • enabled: ブックマークの有無 (YES: ブックマークあり、NO: ブックマークなし)
    • error: エラー詳細

KollusPlayerDelegate Protocol​

#import <KollusPlayerDelegate.h>

再生・一時停止・停止・バッファリングなど、プレイヤーの再生ライフサイクルイベントを受信するプロトコルです。

Instance Methods​

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

Method Details​

(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView prepareToPlayWithError: (NSError *) error

prepareToPlayWithMode:error: メソッド呼び出し後、再生準備が最終的に完了したか失敗したときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • error: エラー詳細 (nil でない場合、再生準備に失敗)
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView play: (BOOL) userInteraction error: (NSError *) error

コンテンツの再生が実際に開始されたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • userInteraction: 再生開始の主体 (YES: ユーザーが再生、NO: システムが開始)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView pause: (BOOL) userInteraction error: (NSError *) error

再生中のコンテンツが一時停止状態に移行するときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • userInteraction: 一時停止の主体 (YES: ユーザーが一時停止、NO: システムが一時停止)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL) buffering prepared: (BOOL) prepared error: (NSError *) error

ネットワーク環境などによりデータのバッファリングが発生したか、状態が解消されたときに呼び出されます。

  • 注意: システムによって一時停止された後に buffering の値が YES に変更された場合、バッファリングが完了 (buffering の値が NO) するタイミングで手動で playWithError: メソッドを呼び出して再生を再開する必要があります。
  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • buffering: バッファリング状態 (YES: バッファリング中、NO: バッファリング解除)
    • prepared: 再生準備状態 (YES: 再生準備完了、NO: 準備前)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView stop: (BOOL) userInteraction error: (NSError *) error

コンテンツの再生が完全に停止されたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • userInteraction: 停止の主体 (YES: ユーザーが終了、NO: コンテンツ再生完了またはシステムによる強制終了)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView position: (NSTimeInterval) position error: (NSError *) error

ユーザーのシーク (Seek) 操作や内部ロジックによって再生位置が変更されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • position: 変更後の再生位置
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView scroll: (CGPoint) distance error: (NSError *) error

ユーザーのドラッグ操作などにより映像画面がスクロール (Scroll) するときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • distance: 画面が移動した距離の値
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error

ピンチジェスチャー (Pinch Gesture) によって映像画面が拡大または縮小されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • recognizer: ズームイベントを伝えるジェスチャー認識オブジェクト
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize) naturalSize

再生しようとするコンテンツの元の解像度情報が確認されるタイミングで呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • naturalSize: 元の映像解像度
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentMode: (KollusPlayerContentMode) playerContentMode error: (NSError *) error

再生画面モードが変更されたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • playerContentMode: 新たに適用された画面モード
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentFrame: (CGRect) contentFrame error: (NSError *) error

ビューのレイアウトやフレームサイズが実際に変更されたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • contentFrame: 変更された画面サイズと位置情報
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playbackRate: (float) playbackRate error: (NSError *) error

再生速度の設定が変更され、映像の再生速度が変わったときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • playbackRate: 変更された再生速度
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView repeat: (BOOL) repeat error: (NSError *) error

コンテンツの区間リピートまたは全体リピート再生の設定が変更されたときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • repeat: リピート再生モードの有効・無効 (YES: リピート設定、NO: リピート解除)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL) enabledOutput error: (NSError *) error

HDMI 接続・ AirPlay などの外部デバイスを介した TV 出力の許可状態が決定されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • enabledOutput: 外部デバイス出力の許可状態 (YES: 出力許可、NO: 出力遮断)
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error

その他の未定義の例外や不明なエラーが発生したときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int) framerate

現在再生中のコンテンツの 1 秒あたりのフレーム数 (FPS) 情報が確認されるタイミングで呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • framerate: 映像のフレームレート
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lockedPlayer: (KollusPlayerType) playerType

デバイスのシステムロック (Lock) が発生したか、プレイヤー画面がロックされるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • playerType: プレイヤータイプ
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *) charset caption: (char *) caption

メイン字幕データが更新され、画面に新しい字幕を表示する必要があるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • charset: 字幕データの文字エンコーディングセット (Character Set)
    • caption: 実際に画面にレンダリングされる字幕テキストデータ
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charsetSub: (char *) charsetSub captionSub: (char *) captionSub

サブ字幕データが更新されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • charsetSub: サブ字幕データの文字エンコーディングセット (Character Set)
    • captionSub: 実際に画面にレンダリングされるサブ字幕テキストデータ
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView thumbnail: (BOOL) isThumbnail error: (NSError *) error

リクエストしたサムネイル画像の非同期ダウンロードが完了したときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • isThumbnail: サムネイルの有無
    • error: エラー詳細
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *) mck

再生中のコンテンツのメディアコンテンツキーが確認されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • mck: メディアコンテンツキー
(void) kollusPlayerView: (KollusPlayerView *) view height: (int) height

HLS コンテンツ再生中、ネットワーク状態に応じて現在出力されている映像の解像度 (垂直の高さ) が変更されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • height: 現在再生中の映像の垂直解像度値 (px)
(void) kollusPlayerView: (KollusPlayerView *) view bitrate: (int) bitrate

HLS ストリーミング中、帯域幅の変化に応じてビットレート (Bitrate) 情報が更新されるときに呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • bitrate: 現在のビットレート値 (kbps)

KollusPlayerDRMDelegate Protocol​

#import <KollusPlayerDRMDelegate.h>

DRM Callback 送信結果を受信するプロトコルです。

Instance Methods​

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

Method Details​

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

DRM ライセンス検証のためのサーバー通信 (Callback) が完了した後に呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • request: サーバーに送信した DRM リクエストデータ
    • json: サーバーから受信した DRM レスポンス結果データ
    • error: エラー詳細

KollusPlayerLMSDelegate Protocol​

#import <KollusPlayerLMSDelegate.h>

LMS 情報送信結果を受信するプロトコルです。

Instance Methods​

  • (void) kollusPlayerView:lmsData:resultJson:

Method Details​

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

LMS データ送信完了後に呼び出されます。

  • パラメーター
    • kollusPlayerView: KollusPlayerView ID
    • lmsData: サーバーに送信された LMS データ文字列
    • resultJson: LMS サーバーから受信した処理結果データ