Player Delegates
KollusPlayerBookmarkDelegate Protocol
#import <KollusPlayerBookmarkDelegate.h>
A protocol for receiving bookmark information of the content being played.
Instance Methods
(void) kollusPlayerView:bookmark:enabled:error:
Method Details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView bookmark: (NSArray *) bookmarks enabled: (BOOL) enabled error: (NSError *) error
Called when bookmark information for the content being played is loaded.
- Parameters
kollusPlayerView:KollusPlayerViewIDbookmarks: Array ofKollusBookmarkobjectsenabled: Whether bookmarks exist (YES: bookmarks present,NO: no bookmarks)error: Error details
KollusPlayerDelegate Protocol
#import <KollusPlayerDelegate.h>
A protocol for receiving player playback lifecycle events such as play, pause, stop, and buffering.
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
Called when playback preparation has fully completed or failed after the prepareToPlayWithMode:error: method is invoked.
- Parameters
kollusPlayerView:KollusPlayerViewIDerror: Error details (if notnil, playback preparation has failed)
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView play: (BOOL) userInteraction error: (NSError *) error
Called when playback of the content has actually started.
- Parameters
kollusPlayerView:KollusPlayerViewIDuserInteraction: Who initiated playback (YES: user started playback,NO: system started playback)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView pause: (BOOL) userInteraction error: (NSError *) error
Called when the content being played transitions to a paused state.
- Parameters
kollusPlayerView:KollusPlayerViewIDuserInteraction: Who initiated the pause (YES: user paused,NO: system paused)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView buffering: (BOOL) buffering prepared: (BOOL) prepared error: (NSError *) error
Called when data buffering occurs or is resolved due to network conditions or other factors.
- Note: If
bufferingchanges toYESafter being paused by the system, you must manually call theplayWithError:method to resume playback when buffering completes (whenbufferingbecomesNO). - Parameters
kollusPlayerView:KollusPlayerViewIDbuffering: Buffering state (YES: buffering in progress,NO: buffering resolved)prepared: Playback readiness state (YES: ready to play,NO: not yet ready)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView stop: (BOOL) userInteraction error: (NSError *) error
Called when content playback has completely stopped.
- Parameters
kollusPlayerView:KollusPlayerViewIDuserInteraction: Who initiated the stop (YES: user stopped,NO: content playback completed or system forced stop)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView position: (NSTimeInterval) position error: (NSError *) error
Called when the playback position changes due to a user seek action or internal logic.
- Parameters
kollusPlayerView:KollusPlayerViewIDposition: The playback position after the changeerror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView scroll: (CGPoint) distance error: (NSError *) error
Called when the video screen is scrolled due to a user drag action or similar.
- Parameters
kollusPlayerView:KollusPlayerViewIDdistance: The distance value by which the screen movederror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView zoom: (UIPinchGestureRecognizer *) recognizer error: (NSError **) error
Called when the video screen is zoomed in or out via a pinch gesture.
- Parameters
kollusPlayerView:KollusPlayerViewIDrecognizer: The gesture recognizer object that delivers the zoom eventerror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView naturalSize: (CGSize) naturalSize
Called when the original resolution information of the content to be played is confirmed.
- Parameters
kollusPlayerView:KollusPlayerViewIDnaturalSize: Original video resolution
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentMode: (KollusPlayerContentMode) playerContentMode error: (NSError *) error
Called when the playback screen mode has changed.
- Parameters
kollusPlayerView:KollusPlayerViewIDplayerContentMode: The newly applied screen modeerror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playerContentFrame: (CGRect) contentFrame error: (NSError *) error
Called when the view's layout or frame size has actually changed.
- Parameters
kollusPlayerView:KollusPlayerViewIDcontentFrame: The updated screen size and position informationerror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView playbackRate: (float) playbackRate error: (NSError *) error
Called when the playback speed setting has changed and the video playback speed has been updated.
- Parameters
kollusPlayerView:KollusPlayerViewIDplaybackRate: The updated playback speederror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView repeat: (BOOL) repeat error: (NSError *) error
Called when the loop section or full repeat playback setting for the content has changed.
- Parameters
kollusPlayerView:KollusPlayerViewIDrepeat: Whether repeat playback mode is enabled (YES: repeat enabled,NO: repeat disabled)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView enabledOutput: (BOOL) enabledOutput error: (NSError *) error
Called when it is determined whether TV output via external devices such as HDMI or AirPlay is allowed.
- Parameters
kollusPlayerView:KollusPlayerViewIDenabledOutput: External device output permission state (YES: output allowed,NO: output blocked)error: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView unknownError: (NSError *) error
Called when an undefined exception or unknown error occurs.
- Parameters
kollusPlayerView:KollusPlayerViewIDerror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView framerate: (int) framerate
Called when the frames per second (FPS) information of the currently playing content is confirmed.
- Parameters
kollusPlayerView:KollusPlayerViewIDframerate: The frame rate of the video
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lockedPlayer: (KollusPlayerType) playerType
Called when the device system lock occurs or the player screen is locked.
- Parameters
kollusPlayerView:KollusPlayerViewIDplayerType: Player type
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charset: (char *) charset caption: (char *) caption
Called when the main subtitle data is updated and new subtitles need to be rendered on screen.
- Parameters
kollusPlayerView:KollusPlayerViewIDcharset: The character encoding set (Character Set) of the subtitle datacaption: The subtitle text data to be rendered on screen
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView charsetSub: (char *) charsetSub captionSub: (char *) captionSub
Called when the sub subtitle data is updated.
- Parameters
kollusPlayerView:KollusPlayerViewIDcharsetSub: The character encoding set (Character Set) of the sub subtitle datacaptionSub: The sub subtitle text data to be rendered on screen
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView thumbnail: (BOOL) isThumbnail error: (NSError *) error
Called when the asynchronous download of the requested thumbnail image has completed.
- Parameters
kollusPlayerView:KollusPlayerViewIDisThumbnail: Whether a thumbnail existserror: Error details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView mck: (NSString *) mck
Called when the media content key of the content being played is confirmed.
- Parameters
kollusPlayerView:KollusPlayerViewIDmck: Media content key
(void) kollusPlayerView: (KollusPlayerView *) view height: (int) height
Called when the resolution (vertical height) of the currently output video changes according to network conditions during HLS content playback.
- Parameters
kollusPlayerView:KollusPlayerViewIDheight: The vertical resolution value of the currently playing video (px)
(void) kollusPlayerView: (KollusPlayerView *) view bitrate: (int) bitrate
Called when bitrate information is updated due to bandwidth changes during HLS streaming.
- Parameters
kollusPlayerView:KollusPlayerViewIDbitrate: The current bitrate value (kbps)
KollusPlayerDRMDelegate Protocol
#import <KollusPlayerDRMDelegate.h>
A protocol for receiving the results of DRM callback transmissions.
Instance Methods
(void) kollusPlayerView:request:json:error:
Method Details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView request: (NSDictionary *) request json: (NSDictionary *) json error: (NSError *) error
Called after server communication (callback) for DRM license verification has completed.
- Parameters
kollusPlayerView:KollusPlayerViewIDrequest: The DRM request data that was sent to the serverjson: The DRM response result data received from the servererror: Error details
KollusPlayerLMSDelegate Protocol
#import <KollusPlayerLMSDelegate.h>
A protocol for receiving the results of LMS data transmissions.
Instance Methods
(void) kollusPlayerView:lmsData:resultJson:
Method Details
(void) kollusPlayerView: (KollusPlayerView *) kollusPlayerView lmsData:(NSString *)lmsData resultJson:(NSDictionary *)resultJson
Called after LMS data transmission is complete.
- Parameters
kollusPlayerView:KollusPlayerViewIDlmsData: The LMS data string that was sent to the serverresultJson: The processing result data received from the LMS server