#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:
	Select the stream to play.
(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, used to display Loading progress.
(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 with string description.
(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 information callback.
(void)	- onSubtitleHide:trackIndex:subtitleID:
	Hide subtitle callback.
(void)	- onSubtitleShow:trackIndex:subtitleID:subtitle:
	Show subtitle callback.
(void)	- onSubTrackReady:info:
	Sub-stream track information callback.
(void)	- onTrackChanged:info:
	Track switchover completion callback.
(void)	- onTrackReady:info:
	Track information callback.
(void)	- onUrlExpired:expiredUrl:callback:
	URL expired callback.
(void)	- onURLSourceExpired:expiredSource:callback:
	URL source expired callback.
(void)	- onVidAuthExpired:expiredSource:callback:
	VidAuth source expired 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 in milliseconds. Indicates the current buffered position, can be used to display buffer progress bar. The callback frequency can be adjusted via AVPConfig::positionTimerIntervalMs.

See also: AliPlayer::bufferedPosition

◆ onCaptureScreen:image:

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

optionalrequired

Snapshot retrieval callback.

Triggered by Aliplayer::snapShot

Parameters

player	Player pointer.
image	Snapshot. For Mac platform, AVPImage is UIImage for iOS platform while it's NSImage for Mac platform.

See also: - snapShot (AliPlayer)

◆ onChooseTrackIndex:info:

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

optionalrequired

Select the stream to play.

Parameters

player	Player pointer.
info	An array of track information, including video, audio, subtitle tracks, etc.

Returns: The index of the stream to play.

See also: AVPTrackInfo; AliPlayer::selectTrack

◆ onCurrentDownloadSpeed:speed:

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

optionalrequired

current download speed callback.

Parameters

player	Player pointer.
speed	Current download speed in bits per second.

See also: AliPlayer::currentDownloadSpeed In live streaming, there will be data continuously; while in on-demand streaming, there may be no download speed because of the cache used, which is a normal situation.

◆ onCurrentPositionUpdate:position:

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

optionalrequired

Current playback position callback.

Parameters

player	Player pointer.
position	Current playback position in milliseconds. Callback frequency: Default once per second, can be adjusted via configuration.

See also: AliPlayer::currentPosition

◆ onCurrentUtcTimeUpdate:time:

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

optionalrequired

Current playback utc time callback.

Parameters

player	Player pointer.
time	Current UTC time in milliseconds. Applicable to live streaming scenarios to get the UTC timestamp corresponding to the current playback content.

See also: AliPlayer::currentUtcTime

◆ onError:errorModel:

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

optionalrequired

Proxy error callback.

Parameters

player	Player pointer.
errorModel	Player error description. See AVPErrorModel. Triggered when errors occur during playback, including network errors, decoding errors, file errors, etc.

See also: AVPErrorModel

◆ onGetThumbnailFailed:

- (void) onGetThumbnailFailed: (int64_t) positionMs

optionalrequired

Thumbnail image retrieval failure callback.

Parameters

positionMs The specified thumbnail image position. Triggered after calling AliPlayer::getThumbnail fails.

See also: AliPlayer::getThumbnail

◆ 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. Triggered after successfully calling `AliPlayer::getThumbnail`.

See also: AliPlayer::getThumbnail

◆ onLoadingProgress:progress:

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

optionalrequired

Buffer progress callback, used to display Loading progress.

Parameters

player	Player pointer.
progress	Buffer progress: from 0 to 100, representing the percentage of buffer completion.

◆ 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, and the value represents the number of bytes hit the cache. Triggered when the player starts playback and uses a local cache file.

See also: AliPlayer::localCacheLoadedSize

◆ onNetworkStat:stat:

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

optionalrequired

Network stat information callback.

Currently only effective for Real-time Streaming(RTS)

Parameters

player	Player pointer.
stat	Network quality information, including packet loss rate, latency, etc.

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 with string description.

Parameters

player	Player pointer.
eventWithString	Player event type string.
description	Player event detailed 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. Triggered when player status changes, including idle, prepared, started, paused, stopped, completed, error, etc.

See also: AVPStatus; AliPlayer::playerStatus

◆ 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) Triggered when the decoder parses SEI data.

◆ 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.
errorModel	Player error description. See AVPErrorModel. Triggered after calling `AliPlayer::switchStream` fails.

See also: AliPlayer::switchStream

◆ onStreamSwitchedSuccess:URL:

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

optionalrequired

Stream switch by url success callback.

Parameters

player	Player pointer.
url	Switched url. Triggered after successfully calling `AliPlayer::switchStream`. Note: Only applicable to Aliyun live streaming addresses for multi-definition switching.

See also: AliPlayer::switchStream

◆ 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 track index.
URL	subtitle url Triggered after successfully calling `AliPlayer::addExtSubtitle`.

See also: AliPlayer::addExtSubtitle

◆ onSubtitleHeader:trackIndex:Header:

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

optionalrequired

Subtitle header information callback.

Used for formats like ASS subtitles that require header information. If this callback is implemented, the player will not automatically render subtitles, and the caller needs to handle subtitle rendering.

Parameters

player	Player instance pointer
trackIndex	Subtitle track index
header	Subtitle header information content For external subtitle usage, refer to External Subtitles

◆ 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. Triggered when subtitles need to be hidden.

See also: AliPlayer::selectExtSubtitle

◆ 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. Triggered when subtitles need to be displayed.

See also: AliPlayer::selectExtSubtitle

◆ onSubTrackReady:info:

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

optionalrequired

Sub-stream track information callback.

Parameters

player	Player pointer.
info	An array of sub-stream track information. Applicable to HLS packaged multi-bitrate streams.

See also: AVPTrackInfo; - getSubMediaInfo (AliPlayer)

◆ 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. Triggered after calling `AliPlayer::selectTrack` and the switch is completed.

See also: AVPTrackInfo; AliPlayer::selectTrack

◆ onTrackReady:info:

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

optionalrequired

Track information callback.

Parameters

player	Player pointer.
info	An array of track information, including video, audio, subtitle tracks, etc. Triggered after prepare is completed and media information is obtained.

See also: AVPTrackInfo; - getMediaInfo (AliPlayer); - prepare (AliPlayer)

◆ onUrlExpired:expiredUrl:callback:

- (void) onUrlExpired:	(AliPlayer *)	player
expiredUrl:	(NSString *)	expiredUrl
callback:	(id< AVPUrlRefreshCallback >)	callback

optionalrequired

URL expired callback.

Parameters

player	Player pointer.
expiredUrl	Expired URL.
callback	URL refresh callback. Triggered when the player detects that the URL has expired, can be used to implement automatic URL refresh functionality.

◆ onURLSourceExpired:expiredSource:callback:

- (void) onURLSourceExpired:	(AliPlayer *)	player
expiredSource:	(id)	expiredSource
callback:	(id< AVPSourceRefreshCallback >)	callback

optionalrequired

URL source expired callback.

Parameters

player	Player pointer.
expiredSource	Expired URL source object.
callback	Source refresh callback.

◆ onVidAuthExpired:expiredSource:callback:

- (void) onVidAuthExpired:	(AliPlayer *)	player
expiredSource:	(id)	expiredSource
callback:	(id< AVPSourceRefreshCallback >)	callback

optionalrequired

VidAuth source expired callback.

Parameters

player	Player pointer.
expiredSource	Expired VidAuth source object.
callback	Source refresh callback.

◆ 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 in milliseconds.
pts	video frame pts Triggered when each video frame rendering is completed, can be used for frame-level monitoring and performance analysis.

See also: AliPlayer::setOnVideoRenderedListener

◆ 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. Triggered when video metadata is loaded or video resolution changes.

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

AVPDelegate.h

Instance Methods

Method Documentation

◆ onBufferedPositionUpdate:position:

◆ onCaptureScreen:image:

◆ onChooseTrackIndex:info:

◆ onCurrentDownloadSpeed:speed:

◆ onCurrentPositionUpdate:position:

◆ onCurrentUtcTimeUpdate:time:

◆ onError:errorModel:

◆ onGetThumbnailFailed:

◆ onGetThumbnailSuc:fromPos:toPos:image:

◆ onLoadingProgress:progress:

◆ onLocalCacheLoaded:size:

◆ onNetworkStat:stat:

◆ onPlayerEvent:eventType:

◆ onPlayerEvent:eventWithString:description:

◆ onPlayerStatusChanged:oldStatus:newStatus:

◆ onSEIData:type:uuid:data:

◆ onStreamSwitchedFail:URL:errorModel:

◆ onStreamSwitchedSuccess:URL:

◆ onSubtitleExtAdded:trackIndex:URL:

◆ onSubtitleHeader:trackIndex:Header:

◆ onSubtitleHide:trackIndex:subtitleID:

◆ onSubtitleShow:trackIndex:subtitleID:subtitle:

◆ onSubTrackReady:info:

◆ onTrackChanged:info:

◆ onTrackReady:info:

◆ onUrlExpired:expiredUrl:callback:

◆ onURLSourceExpired:expiredSource:callback:

◆ onVidAuthExpired:expiredSource:callback:

◆ onVideoRendered:timeMs:pts:

◆ onVideoSizeChanged:width:height:rotation: