AliyunPlayer v7.10.0
Aliyun Player API Reference Manual for iOS Platforms
Loading...
Searching...
No Matches
<AVPDelegate> Protocol Reference

#include "AVPDelegate.h"

Inheritance diagram for <AVPDelegate>:

Instance Methods

(void) - onBufferedPositionUpdate:position:
 视频缓冲位置回调
(void) - onCaptureScreen:image:
 获取截图回调,触发自Aliplayer::snapShot
(int) - onChooseTrackIndex:info:
 选择希望播放的流
(void) - onCurrentDownloadSpeed:speed:
 当前下载速度回调
(void) - onCurrentPositionUpdate:position:
 视频当前播放位置回调
(void) - onCurrentUtcTimeUpdate:time:
 视频当前播放内容对应的utc时间回调
(void) - onError:errorModel:
 错误代理回调
(void) - onGetThumbnailFailed:
 获取缩略图失败回调
(void) - onGetThumbnailSuc:fromPos:toPos:image:
 获取缩略图成功回调
(void) - onLoadingProgress:progress:
 视频缓冲进度回调,用于显示Loading进度
(void) - onLocalCacheLoaded:size:
 视频起播缓存命中回调
(void) - onNetworkStat:stat:
 获取网络质量信息回调, 当前该监听器仅对超低延时直播(RTS)拉流场景生效。
(void) - onPlayerEvent:eventType:
 播放器事件回调
(void) - onPlayerEvent:eventWithString:description:
 播放器事件回调(带字符串描述)
(void) - onPlayerStatusChanged:oldStatus:newStatus:
 播放器状态改变回调
(void) - onSEIData:type:uuid:data:
 SEI回调
(void) - onStreamSwitchedFail:URL:errorModel:
 根据url切换清晰度流失败通知
(void) - onStreamSwitchedSuccess:URL:
 根据url切换清晰度流成功通知
(void) - onSubtitleExtAdded:trackIndex:URL:
 外挂字幕被添加
(void) - onSubtitleHeader:trackIndex:Header:
 字幕头信息回调。用于ASS或VTT字幕等需要头信息的格式。如果实现此回调,播放器将不会自动渲染字幕,需要调用者自行完成字幕渲染。
(void) - onSubtitleHide:trackIndex:subtitleID:
 字幕隐藏回调
(void) - onSubtitleShow:trackIndex:subtitleID:subtitle:
 字幕显示回调
(void) - onSubTrackReady:info:
 获取子流track信息回调
(void) - onTrackChanged:info:
 track切换完成回调
(void) - onTrackReady:info:
 获取track信息回调
(void) - onUrlExpired:expiredUrl:callback:
 URL过期回调
(void) - onURLSourceExpired:expiredSource:callback:
 URL源过期回调
(void) - onVidAuthExpired:expiredSource:callback:
 VidAuth源过期回调
(void) - onVideoRendered:timeMs:pts:
 播放器渲染信息回调
(void) - onVideoSizeChanged:width:height:rotation:
 视频大小变化回调

Method Documentation

◆ onBufferedPositionUpdate:position:

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

视频缓冲位置回调

Parameters
player播放器player指针
position视频当前缓冲位置,单位毫秒 表示当前已缓冲到的位置,可用于显示缓冲进度条,触发频率可通过AVPConfig::positionTimerIntervalMs调整
See also
AliPlayer::bufferedPosition

◆ onCaptureScreen:image:

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

获取截图回调,触发自Aliplayer::snapShot

Parameters
player播放器player指针
image图像,iOS平台返回UIImage,而mac平台返回NSImage
See also
- snapShot (AliPlayer)

◆ onChooseTrackIndex:info:

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

选择希望播放的流

Parameters
player播放器player指针
infotrack流信息数组
Returns
返回要播放的流索引
See also
AVPTrackInfo
AliPlayer::selectTrack

◆ onCurrentDownloadSpeed:speed:

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

当前下载速度回调

Parameters
player播放器player指针
speed当前下载速度,单位bits per second
See also
AliPlayer::currentDownloadSpeed 直播场景下,会持续有数据;而点播场景下,可能因使用的缓存而无下载速度,是正常情况。

◆ onCurrentPositionUpdate:position:

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

视频当前播放位置回调

Parameters
player播放器player指针
position视频当前播放位置,单位毫秒 触发频率:通过AVPConfig::positionTimerIntervalMs调整
See also
AliPlayer::currentPosition

◆ onCurrentUtcTimeUpdate:time:

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

视频当前播放内容对应的utc时间回调

Parameters
player播放器player指针
timeutc时间,单位毫秒 适用于直播场景,获取当前播放内容对应的UTC时间戳
See also
AliPlayer::currentUtcTime

◆ onError:errorModel:

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

错误代理回调

Parameters
player播放器player指针
errorModel播放器错误描述,参考AVPErrorModel 触发时机:播放过程中发生错误时回调,包括网络错误、解码错误、文件错误等
See also
AVPErrorModel

◆ onGetThumbnailFailed:

- (void) onGetThumbnailFailed: (int64_t) positionMs
optionalrequired

获取缩略图失败回调

Parameters
positionMs指定的缩略图位置 触发时机:调用AliPlayer::getThumbnail失败后回调
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

获取缩略图成功回调

Parameters
positionMs指定的缩略图位置
fromPos此缩略图的开始位置
toPos此缩略图的结束位置
image缩图略图像指针,对于mac是NSImage,iOS平台是UIImage指针 触发时机:调用AliPlayer::getThumbnail成功后回调
See also
AliPlayer::getThumbnail

◆ onLoadingProgress:progress:

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

视频缓冲进度回调,用于显示Loading进度

Parameters
player播放器player指针
progress缓存进度0-100,表示缓冲完成的百分比

◆ onLocalCacheLoaded:size:

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

视频起播缓存命中回调

Parameters
player播放器player指针
size文件大小,单位为字节。大于0代表命中缓存,此时值代表命中缓存的字节数。 触发时机:播放器开始播放时,如果使用了本地缓存文件,则会回调此方法
See also
AliPlayer::localCacheLoadedSize

◆ onNetworkStat:stat:

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

获取网络质量信息回调, 当前该监听器仅对超低延时直播(RTS)拉流场景生效。

Parameters
player播放器player指针
stat网络质量信息,包含丢包率、延迟等指标
See also
AVPNetworkStat

◆ onPlayerEvent:eventType:

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

播放器事件回调

Parameters
player播放器player指针
eventType播放器事件类型
See also
AVPEventType

◆ onPlayerEvent:eventWithString:description:

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

播放器事件回调(带字符串描述)

Parameters
player播放器player指针
eventWithString播放器事件类型字符串
description播放器事件详细说明
See also
AVPEventType

◆ onPlayerStatusChanged:oldStatus:newStatus:

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

播放器状态改变回调

Parameters
player播放器player指针
oldStatus老的播放器状态 参考AVPStatus
newStatus新的播放器状态 参考AVPStatus 触发时机:播放器状态发生变化时回调,包括idle、prepared、started、paused、stopped、completed、error等状态
See also
AVPStatus
AliPlayer::playerStatus

◆ onSEIData:type:uuid:data:

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

SEI回调

Parameters
player播放器player指针
type类型
uuid数据(当type=5时,uuid值有效,播放器sdk 6.11.0及之后的版本新增)
data数据(不包含uuid部分,跟6.10.0及之前的版本语义保持一致) 触发时机:解码器解析到SEI数据时回调

◆ onStreamSwitchedFail:URL:errorModel:

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

根据url切换清晰度流失败通知

Parameters
player播放器player指针
URL切换的url
errorModel播放器错误描述,参考AVPErrorModel 触发时机:调用AliPlayer::switchStream失败后回调
See also
AliPlayer::switchStream

◆ onStreamSwitchedSuccess:URL:

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

根据url切换清晰度流成功通知

Parameters
player播放器player指针
url切换后的url 触发时机:调用AliPlayer::switchStream成功后回调 注意:仅适用于阿里云直播地址的多清晰度切换
See also
AliPlayer::switchStream

◆ onSubtitleExtAdded:trackIndex:URL:

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

外挂字幕被添加

Parameters
player播放器player指针
trackIndex字幕轨道索引
URL字幕url 触发时机:调用AliPlayer::addExtSubtitle成功后回调
See also
AliPlayer::addExtSubtitle

◆ onSubtitleHeader:trackIndex:Header:

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

字幕头信息回调。用于ASS或VTT字幕等需要头信息的格式。如果实现此回调,播放器将不会自动渲染字幕,需要调用者自行完成字幕渲染。

Parameters
player播放器实例指针
trackIndex字幕轨道索引
header字幕头信息内容 外挂字幕用法参考外挂字幕

◆ onSubtitleHide:trackIndex:subtitleID:

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

字幕隐藏回调

Parameters
player播放器player指针
trackIndex字幕流索引.
subtitleID字幕ID. 触发时机:字幕需要隐藏时回调
See also
AliPlayer::selectExtSubtitle

◆ onSubtitleShow:trackIndex:subtitleID:subtitle:

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

字幕显示回调

Parameters
player播放器player指针
trackIndex字幕流索引.
subtitleID字幕ID.
subtitle字幕显示的字符串 触发时机:字幕需要显示时回调
See also
AliPlayer::selectExtSubtitle

◆ onSubTrackReady:info:

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

获取子流track信息回调

Parameters
player播放器player指针
info子流track信息数组 适用于HLS打包多清晰度流。
See also
AVPTrackInfo
- getSubMediaInfo (AliPlayer)

◆ onTrackChanged:info:

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

track切换完成回调

Parameters
player播放器player指针
info切换后的信息 参考AVPTrackInfo 触发时机:调用AliPlayer::selectTrack后切换完成时回调
See also
AVPTrackInfo
AliPlayer::selectTrack

◆ onTrackReady:info:

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

获取track信息回调

Parameters
player播放器player指针
infotrack流信息数组,包含视频、音频、字幕等轨道信息 触发时机:prepare完成后,获取到媒体信息时回调
See also
AVPTrackInfo
- getMediaInfo (AliPlayer)
- prepare (AliPlayer)

◆ onUrlExpired:expiredUrl:callback:

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

URL过期回调

Parameters
player播放器player指针
expiredUrl过期的URL
callbackURL刷新回调 触发时机:播放器检测到URL过期时回调,可用于实现URL自动刷新功能

◆ onURLSourceExpired:expiredSource:callback:

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

URL源过期回调

Parameters
player播放器player指针
expiredSource过期的URL源对象
callback源刷新回调

◆ onVidAuthExpired:expiredSource:callback:

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

VidAuth源过期回调

Parameters
player播放器player指针
expiredSource过期的VidAuth源对象
callback源刷新回调

◆ onVideoRendered:timeMs:pts:

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

播放器渲染信息回调

Parameters
player播放器player指针
timeMs渲染时的系统时间,单位毫秒
pts视频帧pts 触发时机:每帧视频渲染完成时回调,可用于帧级监控和性能分析
See also
AliPlayer::setOnVideoRenderedListener

◆ onVideoSizeChanged:width:height:rotation:

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

视频大小变化回调

Parameters
player播放器player指针
width视频宽度
height视频高度
rotation视频旋转角度 触发时机:视频元数据加载完成或视频分辨率发生变化时回调

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