<AVPDelegate> Protocol Reference

#include "AVPDelegate.h"

Inheritance diagram for <AVPDelegate>:

Instance Methods
(void)	- onBufferedPositionUpdate:position:
	Current cache position callback.
(void)	- onCaptureScreen:image:
	Snapshot retrieval callback.
(int)	- onChooseTrackIndex:info:
(void)	- onCurrentDownloadSpeed:speed:
	current download speed callback.
(void)	- onCurrentPositionUpdate:position:
	Current playback position callback.
(void)	- onCurrentUtcTimeUpdate:time:
	Current playback utc time callback.
(void)	- onError:errorModel:
	Proxy error callback.
(void)	- onGetThumbnailFailed:
	Thumbnail image retrieval failure callback.
(void)	- onGetThumbnailSuc:fromPos:toPos:image:
	Thumbnail image retrieval success callback.
(void)	- onLoadingProgress:progress:
	Buffer progress callback.
(void)	- onLocalCacheLoaded:size:
	Video playback cache hit callback.
(void)	- onNetworkStat:stat:
	Network stat information callback.
(void)	- onPlayerEvent:eventType:
	Player event callback.
(void)	- onPlayerEvent:eventWithString:description:
	Player event callback.
(void)	- onPlayerStatusChanged:oldStatus:newStatus:
	Player status update callback.
(void)	- onSEIData:type:uuid:data:
	SEI callback.
(void)	- onStreamSwitchedFail:URL:errorModel:
	Stream switch by url fail callback.
(void)	- onStreamSwitchedSuccess:URL:
	Stream switch by url success callback.
(void)	- onSubtitleExtAdded:trackIndex:URL:
	External subtitles have been added.
(void)	- onSubtitleHeader:trackIndex:Header:
	subtitle header info callback, for ass, player will not render the subtitle when this is implemented by user
(void)	- onSubtitleHide:trackIndex:subtitleID:
	Hide subtitle callback.
(void)	- onSubtitleShow:trackIndex:subtitleID:subtitle:
	Show subtitle callback.
(void)	- onSubTrackReady:info:
	Track information callback.
(void)	- onTrackChanged:info:
	Track switchover completion callback.
(void)	- onTrackReady:info:
	Track information callback.
(void)	- onVideoRendered:timeMs:pts:
	Player render info callback.
(void)	- onVideoSizeChanged:width:height:rotation:
	Video size change callback.

Method Documentation

onBufferedPositionUpdate:position:

- (void) onBufferedPositionUpdate: (AliPlayer *) player position: (int64_t) position

optionalrequired

Current cache position callback.

Parameters

player	Player pointer.
position	Current cache position.

onCaptureScreen:image:

- (void) onCaptureScreen: (AliPlayer *) player image: (AVPImage *) image

optionalrequired

Snapshot retrieval callback.

Parameters

player	Player pointer.
image	Snapshot.

See also

AVPImage

onChooseTrackIndex:info:

- (int) onChooseTrackIndex: (AliPlayer *) player info: (NSArray< AVPTrackInfo * > *) info

optionalrequired

onCurrentDownloadSpeed:speed:

- (void) onCurrentDownloadSpeed: (AliPlayer *) player speed: (int64_t) speed

optionalrequired

current download speed callback.

Parameters

player	Player pointer.
speed	bits per second.

onCurrentPositionUpdate:position:

- (void) onCurrentPositionUpdate: (AliPlayer *) player position: (int64_t) position

optionalrequired

Current playback position callback.

Parameters

player	Player pointer.
position	Current playback position.

onCurrentUtcTimeUpdate:time:

- (void) onCurrentUtcTimeUpdate: (AliPlayer *) player time: (int64_t) time

optionalrequired

Current playback utc time callback.

Parameters

player	Player pointer.
position	Current utc time.

onError:errorModel:

- (void) onError: (AliPlayer *) player errorModel: (AVPErrorModel *) errorModel

optionalrequired

Proxy error callback.

Parameters

player	Player pointer.
errorModel	Player error description. See AVPErrorModel.

See also

AVPErrorModel

onGetThumbnailFailed:

- (void) onGetThumbnailFailed: (int64_t) positionMs

optionalrequired

Thumbnail image retrieval failure callback.

Parameters

positionMs

The specified thumbnail image position.

onGetThumbnailSuc:fromPos:toPos:image:

- (void) onGetThumbnailSuc: (int64_t) positionMs fromPos: (int64_t) fromPos toPos: (int64_t) toPos image: (id) image

optionalrequired

Thumbnail image retrieval success callback.

Parameters

positionMs	The specified thumbnail image position.
fromPos	The initial position of the thumbnail image.
toPos	The end position of the thumbnail image.
image	Thumbnail image pointer. Mac: NSImage. iOS: UIImage.

onLoadingProgress:progress:

- (void) onLoadingProgress: (AliPlayer *) player progress: (float) progress

optionalrequired

Buffer progress callback.

Parameters

player	Player pointer.
progress	Buffer progress: from 0 to 100.

onLocalCacheLoaded:size:

- (void) onLocalCacheLoaded: (AliPlayer *) player size: (int64_t) size

optionalrequired

Video playback cache hit callback.

Parameters

player	Player pointer.
size	File size, measured in bytes; a value greater than 0 indicates a cache hit.

onNetworkStat:stat:

- (void) onNetworkStat: (AliPlayer *) player stat: (AVPNetworkStat *) stat

optionalrequired

Network stat information callback.

Parameters

player	Player pointer.
stat	Network stat information.

See also

AVPNetworkStat

onPlayerEvent:eventType:

- (void) onPlayerEvent: (AliPlayer *) player eventType: (AVPEventType) eventType

optional

Player event callback.

Parameters

player	Player pointer.
eventType	Player event type.

See also

AVPEventType

onPlayerEvent:eventWithString:description:

- (void) onPlayerEvent: (AliPlayer *) player eventWithString: (AVPEventWithString) eventWithString description: (NSString *) description

optionalrequired

Player event callback.

Parameters

player	Player pointer.
eventWithString	Player event type.
description	Player event description.

See also

AVPEventType

onPlayerStatusChanged:oldStatus:newStatus:

- (void) onPlayerStatusChanged: (AliPlayer *) player oldStatus: (AVPStatus) oldStatus newStatus: (AVPStatus) newStatus

optionalrequired

Player status update callback.

Parameters

player	Player pointer.
oldStatus	The previous status. See AVPStatus.
newStatus	The updated status. See AVPStatus.

See also

AVPStatus

onSEIData:type:uuid:data:

- (void) onSEIData: (AliPlayer *) player type: (int) type uuid: (NSData *) uuid data: (NSData *) data

optionalrequired

SEI callback.

Parameters

player	Player pointer.
type	Type.
uuid	Data.(valid only when type=5, added in player sdk 6.11.0 and later)
data	Data.(not included uuid part, the same semantic with player sdk 6.10.0 and before)

See also

AVPImage

onStreamSwitchedFail:URL:errorModel:

- (void) onStreamSwitchedFail: (AliPlayer *) player URL: (NSString *) URL errorModel: (AVPErrorModel *) errorModel

optionalrequired

Stream switch by url fail callback.

Parameters

player	Player pointer.
url	Switched url.

onStreamSwitchedSuccess:URL:

- (void) onStreamSwitchedSuccess: (AliPlayer *) player URL: (NSString *) URL

optionalrequired

Stream switch by url success callback.

Parameters

player	Player pointer.
url	Switched url.

onSubtitleExtAdded:trackIndex:URL:

- (void) onSubtitleExtAdded: (AliPlayer *) player trackIndex: (int) trackIndex URL: (NSString *) URL

optionalrequired

External subtitles have been added.

Parameters

player	Player pointer.
trackIndex	Subtitle index.
URL	subtitle url

onSubtitleHeader:trackIndex:Header:

- (void) onSubtitleHeader: (AliPlayer *) player trackIndex: (int) trackIndex Header: (NSString *) header

optionalrequired

subtitle header info callback, for ass, player will not render the subtitle when this is implemented by user

Parameters

player	Player pointer.
trackIndex	Subtitle index.
URL	subtitle url

onSubtitleHide:trackIndex:subtitleID:

- (void) onSubtitleHide: (AliPlayer *) player trackIndex: (int) trackIndex subtitleID: (long) subtitleID

optionalrequired

Hide subtitle callback.

Parameters

player	Player pointer.
trackIndex	Subtitle stream index.
subtitleID	Subtitle ID.

onSubtitleShow:trackIndex:subtitleID:subtitle:

- (void) onSubtitleShow: (AliPlayer *) player trackIndex: (int) trackIndex subtitleID: (long) subtitleID subtitle: (NSString *) subtitle

optionalrequired

Show subtitle callback.

Parameters

player	Player pointer.
trackIndex	Subtitle stream index.
subtitleID	Subtitle ID.
subtitle	Subtitle string.

onSubTrackReady:info:

- (void) onSubTrackReady: (AliPlayer *) player info: (NSArray< AVPTrackInfo * > *) info

optionalrequired

Track information callback.

Parameters

player	Player pointer.
info	An array of track information.

See also

AVPTrackInfo

onTrackChanged:info:

- (void) onTrackChanged: (AliPlayer *) player info: (AVPTrackInfo *) info

optionalrequired

Track switchover completion callback.

Parameters

player	Player pointer.
info	Track switchover completion information. See AVPTrackInfo.

See also

AVPTrackInfo

onTrackReady:info:

- (void) onTrackReady: (AliPlayer *) player info: (NSArray< AVPTrackInfo * > *) info

optionalrequired

Track information callback.

Parameters

player	Player pointer.
info	An array of track information.

See also

AVPTrackInfo

onVideoRendered:timeMs:pts:

- (void) onVideoRendered: (AliPlayer *) player timeMs: (int64_t) timeMs pts: (int64_t) pts

optionalrequired

Player render info callback.

Parameters

player	Player pointer.
timeMs	system time when render.
pts	video frame pts

See also

AVPEventType

onVideoSizeChanged:width:height:rotation:

- (void) onVideoSizeChanged: (AliPlayer *) player width: (int) width height: (int) height rotation: (int) rotation

optionalrequired

Video size change callback.

Parameters

player	Player pointer.
width	Video width.
height	Video height.
rotation	Video rotate angle.

---

The documentation for this protocol was generated from the following file:

• AVPDelegate.h