有关API的详细说明，可参见下方的链接，点开即可。

播放器 iOS SDK API 文档详见API文档

API概览

全局方法

类别	API名称	功能
设置日志等级	+ (void)setLogLevel: (NELPLogLevel) logLevel	设置的日志级别
SDK版本信息	+ (void)getSDKVersion	查询SDK的版本信息
日志文件路径	+ (void)getLogPath	查询日志文件路径
日志信息回调	+ (void)setLogCallback:    (NELivePlayerLogCallback)logCallBack	设置日志回调
增加预调度任务	+ (void)addPreloadUrls:	增加预调度任务
删除预调度任务	+ (void)removePreloadUrls:	删除预调度任务
查询预调度任务	+ (void)queryPreloadTasks:	查询预调度任务
设置预调度结果有效期	+ (void)setPreloadResultValidityS:	预调度结果有效期
设置外部配置Audiosession	+ (void)setExternConfigAudioSession:	是否外部配置Audiosession

初始化方法

类别	API名称	功能
创建实例1	- (instancetype)init + (instancetype)new	系统初始化方法, 需要配合setUrl:接口使用
创建实例2	- (instancetype)initWithContentURL: (NSURL *) aUrl                                                  error: (NSError ##) error	aUrl：待播放的URL error：返回失败原因
创建实例3	- (instancetype)initWithContentURL: (NSURL *) aUrl                                                config: (NELPUrlConfig *)config                                                  error: (NSError ##) error	aUrl：待播放的URL config: 缓存和解密配置 error：返回失败原因

操作方法

类别	API名称	功能
显示	（属性）UIView *view	SDK生成, 只用于显示视频图像。
准备播放	- (void) prepareToPlay	初始化视频文件为播放做准备。设置数据源之后，播放前调用。
播放	- (void) play	播放。收到Prepare通知之后调用。
暂停	- (void) pause	暂停。直播该接口无效，仅针对点播。
关闭	- (void) shutdown	关闭。释放播放器之前调用，用于播放器资源释放。
截图	- (UIImage *)getSnapshot	截图。收到Prepare通知之后调用，纯音频文件该接口无效。
换源 （常规视频）	- (int)switchContentUrl: (NSURL *) aUrl	播放过程中切换播放地址。 ##注##：只能用于常规视频的相互切换。
换源 （通用）	- (int)switchContentUrl: (NSURL *) aUrl                         config:(NELPUrlConfig *)config	播放过程中切换播放地址。
换源 （加密视频） (即将废弃)	- (void)switchDecryptionUrl:(NSURL *)aUrl            transferToken:(NSString *)transferToken                         accid:(NSString *)accid                     appKey:(NSString *)appKey                        token:(NSString *)token                  complete: (void(^)(NELPKeyCheckResult ret))complete	加密视频，播放过程中切换播放地址。 aUrl: 目标地址。 transferToken: 获取密钥的令牌。 accid: 视频云用户创建的其子用户id。 appKey: 开发者平台分配的AppKey。 token: 视频云用户子用户的token。 complete: 异步返回密钥检测结果。 ##注##：只能用于服务端管理密钥的类的加密视频相互切换。
换源 （加密视频） （已知密钥） (即将废弃)	- (void)switchDecryptionKeyUrl:(NSURL *)aUrl                            key:(NSString *)key                   complete: (void(^)(NELPKeyCheckResult ret))complete	已知密钥的加密视频，播放过程中切换播放地址。 aUrl: 目标地址。 complete: 异步返回密钥检测结果。 ##注##：只能用于已知密钥视频的相互切换。

参数设置／查询

类别	API名称	功能
设置播放的Url	- (NSError *)setPlayUrl: (NSURL *) url	url: 播放Url ##注##：与创建实例方法1一同使用， 仅限初始化后调用，不可用于URL切换。
设置播放的Url (带参)	- (NSError *)setPlayUrl: (NSURL *) url                            config: (NELPUrlConfig *)config	url: 播放Url config: 缓存和解密配置 ##注##：与创建实例方法1一同使用， 仅限初始化后调用，不可用于URL切换。
设置缓冲策略	- (void)setBufferStrategy: (NELPBufferStrategy) bufferStrategy	bufferStrategy: 播放时的缓冲策略 ##注1##：静态参数，在播放器初始化后           prepareToPlay之前调用。 ##注2##：直播类缓存2M，点播类缓存200M。
设置缓冲区大小	- (void)setBufferSize:(int)size	size: 缓冲区大小 ##注1##：动态参数，初始化之后随时可以设置。 ##注2##: 只针对NELPAntiJitte缓冲模式有效。 ##注3##: 5M - 150M
设置精确seek开关	- (void)setAccurateSeek:(BOOL)isOpen	isOpen: 是否开启 ##注1##：静态参数，需在开始播放之前设置。 ##注2##: 默认：开。
设置开启硬件编码	- (void)setHardwareDecoder: (BOOL) isOpen	isOpen：开启 or 关闭 ##注##：静态参数，需在开始播放之前设置。
设置拉流超时时间	- (void)setPlaybackTimeout:(long)timeout	timeout：超时时长。取值：[0, 30000] 毫秒 ##注##：静态参数，需在开始播放之前设置。
设置是否自动播放	（属性）BOOL shouldAutoplay	收到Prepared通知后是否需要调用play。 shouldAutoplay：自动 or 手动。 ##注##：静态参数，需在开始播放之前设置。
设置重试配置	- (void)setRetryConfig:(NELPRetryConfig *)config;	##注##：静态参数，需在开始播放之前设置。
设置后台是否暂停	- (void)setPauseInBackground:(BOOL)pause	pause: YES: 后台暂停   NO：后台继续 ##注1##： 设置NO。SDK不做前后台事件监听。 设置YES。   点播在后台暂停，回到前台恢复。   直播在后台停止拉流，回到前台重新拉流 ##注2##：动态参数，初始化之后随时可以设置。
设置屏幕显示模式	- (void)setScalingMode: (NELPMovieScalingMode) aScalingMode	aScalingMode：显示填充模式 ##注##：动态参数，初始化之后随时可以设置。
设置解密信息	- (void)setDecryptionTransferToken:                      (NSString *) transferToken             accid:(NSString *) accid         appKey:(NSString *) appKey            token:(NSString *) token complete:(void(^)(NELPKeyCheckResult ret))complete	transferToken：密钥的令牌。 accid：视频云用户创建的其子用户id。 appKey：开发者平台分配的AppKey token：视频云用户子用户的token complete：异步返回密钥检测结果 ##注1##：不可与setDecryptionKey同时使用。 ##注2##：静态参数。开始播放之前设置。
设置FLV解密信息 （已知密钥）	- (void)setDecryptionKey:(NSString *) key complete:(void(^)(NELPKeyCheckResult ret))complete	key：密钥。 complete：异步返回密钥检测结果 ##注1##：不可与setDecryptionTransferToken          同时使用。 ##注2##：静态接口。开始播放之前设置。
设置PCM数据回调格式	- - (int)setAudioPcmDataConfig:          (NELivePlayerPcmConfig *) audioRawDataCB	解码后的音频数据回调格式。 ##注##：静态参数。开始播放之前设置。
设置PCM数据回调	- (int)registerGetAudioRawDataCB:          (NELPAudioRawDataCB) audioRawDataCB	解码后的音频数据回调。 ##注##：动态参数，初始化之后随时可以设置。
设置YUV数据回调	- (int)registerGetVideoRawDataCB:          (NELPVideoFormat) neVFormat         and: (NELPVideoRawDataCB) videoRawDataCB	解码后的视频数据回调。 neVFormat：YUV格式 ##注##：仅限软解码方式。 ##注##：动态参数，初始化之后随时可以设置。
设置静音	- (void)setMute: (BOOL)isMute	isMute：YES：静音   NO：非静音 ##注##：动态参数，初始化之后随时可以设置。
设置音量	- (void)setVolume:(float)volume	volume：音量大小。[0, 1] ##注##：动态参数，初始化之后随时可以设置。
设置播放速度	（属性）float playbackSpeed	playbackSpeed：播放速度。[0.5, 2.0] ##注1##：仅针对点播文件生效。 ##注2##：动态参数，初始化之后随时可以设置。
设置/获取 当前播放时间	（属性）NSTimeInterval currentPlaybackTime	get方法返回当前播放时间点，单位秒. set方法用于seek操作，单位秒。 ##注1##：直播不支持seek操作。 ##注2##：接收到Prepared通知之后才允许seek。
查询文件时长	（属性）NSTimeInterval duration	get方法返回文件时长，单位秒。 ##注##：直播该接口返回0。
查询缓冲的时长	（属性）NSTimeInterval playableDuration	get方法返回已经缓冲的视频时长，单位秒。 ##注##：若网络断开，只能播放到该时刻。
查询视频文件 是否完成初始化	（属性）BOOL isPreparedToPlay	调用prepareToPlay方法后，进行视频初始化操作 如果完成初始化，会发送Prepared通知， 并将isPreparedToPlay置为YES
查询当前 是否正在播放	（属性）(BOOL)isPlaying	YES：正在播放 NO：未在播放
查询当前播放状态	（属性）NELPMoviePlaybackState playbackState	播放状态变化： 1）调用initWithContentURL -> Paused状态 2)  调用prepareToPlay -> Playing状态 3）调用setCurrentPlaybackTime -> seeking状态 4）调用shutdown -> Stopped状态
查询当前加载状态	（属性）NELPMovieLoadState loadState	加载状态变化： 1)  调用prepareToPlay -> Playable状态 2）缓冲开始 -> Stalled状态 3）缓冲结束 -> PlaythroughOK状态
查询视频信息	- (void)getVideoInfo: (NELPVideoInfo *) videoInfo	获取视频信息。 ##注##：收到Prepared之后，可以查询。
查询音频信息	- (void)getAudioInfo: (NELPAudioInfo *) audioInfo	获取音频信息。 ##注##：收到Prepared之后，可以查询。
查询真实时间戳	（属性）NSTimeInterval currentPlaybackRealTime	（直播校时方案一）获取CDN透传的时间。 ##注##：收到Prepared之后，可以查询。
监听真实时间戳	- (void)setRealTimeListenerWithIntervalMS:            (NSTimeInterval)intervalMS callback:(NELPCurrentTimestampCallCB)callback	（直播校时方案一）轮询真实时间戳。 intervalMS：查询间隔，单位毫秒 callback：查询结果 ##注##：收到Prepared之后，可以查询。
查询同步时间戳	（属性）NSTimeInterval currentSyncTimestamp	（直播校时方案二）获取推流时间戳。 ##注##：收到Prepared之后，可以查询。
监听同步时间戳	- (void)setSyncTimestampListenerWithIntervalMS:            (NSTimeInterval)intervalMS callback:(NELPCurrentTimestampCallCB)callback	（直播校时方案二）轮询同步时间戳。 intervalMS：查询间隔，单位毫秒 callback：查询结果 ##注##：收到Prepared之后，可以查询。
透传自定义信息回调	- (void)registerSyncContentCB: (NELPSyncContentCB)contentCB	透传的自定义信息显示。 contentCB：信息播放回调
设置外挂字幕	- (NSError *)setLocalSubtitleFile: (NSString *)file	设置外挂字幕。 file：字幕路径 ##注##： 1. 目前只支持SRT格式字幕。 2. 设置为NULL关闭字幕。 3. 字幕中的特殊格式需要应用层处理
字幕显示回调	- (void)registSubtitleStatBlock:(NELivePlayerSubtitleBlock)block	设置字幕显示回调。 block：字幕显示／隐藏回调

通知介绍

通知	说明
NELivePlayerDidPreparedToPlayNotification	调用prepareToPlay之后，文件初始化完成后发出
NELivePlayerLoadStateChangedNotification	加载状态发生改变时发出
NELivePlayerPlaybackFinishedNotification	播放完成时发送。携带UserInfo字典: {         NELivePlayerPlaybackDidFinishReasonUserInfoKey : [NSNumber],         NELivePlayerPlaybackDidFinishErrorKey : [NSNumber] } NELivePlayerPlaybackDidFinishReasonUserInfoKey：结束原因 NELivePlayerPlaybackDidFinishErrorKey：错误码。播放完成时，无此字段。
NELivePlayerPlaybackStateChangedNotification	播放状态发生改变时发出
NELivePlayerHardwareDecoderOpenNotification	硬件解码器打开后发出
NELivePlayerFirstVideoDisplayedNotification	第一帧视频显示时发出
NELivePlayerFirstAudioDisplayedNotification	第一帧音频播放时发出
NELivePlayerReleaseSueecssNotification	资源释放时发出
NELivePlayerMoviePlayerSeekCompletedNotification	seek完成时发出，仅用于点播。携带UserInfo字典: {         NELivePlayerMoviePlayerSeekCompletedErrorKey : [NSNumber],         NELivePlayerMoviePlayerSeekCompletedTargetKey : [NSNumber] } NELivePlayerMoviePlayerSeekCompletedErrorKey：seek失败原因 NELivePlayerMoviePlayerSeekCompletedTargetKey：seek完成时的时间
NELivePlayerHttpCodeResponseNotification	播放过程中的Http状态信息通知。携带UserInfo字典。 NELivePlayerHttpCodeResponseInfoKey：HTTP状态信息key，value类型详见头文件
NELivePlayerRetryNotification	播放器失败重试通知。携带UserInfo字典。 NELivePlayerPlaybackDidRetryCountKey：播放器失败当前的重试次数

总体参数介绍

枚举值参数介绍

日志级别 NELPLogLevel

参数	说明
NELP_LOG_DEFAULT	log输出模式：默认
NELP_LOG_VERBOSE	log输出模式：输出详细
NELP_LOG_DEBUG	log输出模式：输出调试信息
NELP_LOG_INFO	log输出模式：输出标准信息
NELP_LOG_WARN	log输出模式：输出警告
NELP_LOG_ERROR	log输出模式：输出错误
NELP_LOG_FATAL	log输出模式：log输出模式：一些错误信息，如头文件找不到，非法参数使用
NELP_LOG_SILENT	log输出模式：不输出

错误码对照 NELPPLayerErrorCode

参数	说明
NELP_INIT_URL_FORMAT_ERROR	初始化的URL格式错误
NELP_INIT_URL_ISPUSH_ERROR	初始化的URL是推流地址
NELP_INIT_URL_PARSE_ERROR	初始化的URL解析错误（idx文件）
NELP_DECRYPTION_UNSUPPORT_PROTOCAL_ERROR	解密视频，协议不支持
NELP_DECRYPTION_KEY_CHECK_ERROR	解密视频，密钥错误
NELP_DECRYPTION_INPUT_INVALIED_ERROR	解密视频，输入错误
NELP_DECRYPTION_GET_KEY_TIMEOUT_ERROR	解密视频，获取密钥超时
NELP_DECRYPTION_UNKNOWN_ERROR	解密视频，未知错误
NELP_PLAY_HTTP_CONNECT_ERROR	播放过程中，HTTP连接失败
NELP_PLAY_RTMP_CONNECT_ERROR	播放过程中，RTMP连接失败
NELP_PLAY_STREAM_PARSE_ERROR	播放过程中，解析失败
NELP_PLAY_BUFFING_ERROR	播放过程中，缓冲失败
NELP_PLAY_AUDIO_OPEN_ERROR	播放过程中，音频相关操作初始化失败
NELP_PLAY_VIDEO_OPEN_ERROR	播放过程中，视频相关操作初始化失败
NELP_PLAY_STREM_IS_ERROR	播放过程中，没有音视频流
NELP_PLAY_AUDIO_DECODE_ERROR	播放过程中，音频解码失败
NELP_PLAY_VIDEO_DECODE_ERROR	播放过程中，视频解码失败
NELP_PLAY_AUDIO_RENDER_ERROR	播放过程中，音频播放失败
NELP_PLAY_VIDEO_RENDER_ERROR	播放过程中，视频播放失败
NELP_PLAY_UNKNOWN_ERROR	播放过程中，未知错误

缓冲模式 NELPBufferStrategy

参数	说明
NELPTopSpeed	极速模式，适用于视频直播，延时最小，网络抖动时容易发生卡顿，丢帧追赶
NELPLowDelay	网络直播低延时，适用于视频直播，延时低，网络抖动时偶尔有卡顿，丢帧追赶
NELPFluent	网络直播流畅，适用于视频直播，流畅性好，延时比低延时模式稍大，丢帧追赶
NELPAntiJitter	网络点播抗抖动，适用于视频点播和本地视频，抗抖动性强
NELPDelayPullUp	网络直播, 延时追赶策略，不丢帧1.2倍速播放追赶

显示模式 NELPMovieScalingMode

参数	说明
NELPMovieScalingModeNone	无缩放
NELPMovieScalingModeAspectFit	等比例缩放，某一边会有黑边填充
NELPMovieScalingModeAspectFill	等比例缩放，某一边可能会被裁减
NELPMovieScalingModeFill	全屏显示，画面宽高比可能与视频原始宽高比不一致

播放状态 NELPMoviePlaybackState

参数	说明
NELPMoviePlaybackStateStopped	停止状态
NELPMoviePlaybackStatePlaying	播放状态
NELPMoviePlaybackStatePaused	暂停状态，可调play继续播放
NELPMoviePlaybackStateSeeking	Seek状态

加载状态 NELPMovieLoadState

参数	说明
NELPMovieLoadStatePlayable	在该状态下，播放器初始化完成，可以播放。 若shouldAutoplay 设置成YES，播放器初始化完成后会自动播放
NELPMovieLoadStatePlaythroughOK	在该状态下，在网络不好的情况下缓冲完成，可以播放
NELPMovieLoadStateStalled	在播放过程中网络不好需要缓冲数据的时候播放会自动暂停

加载状态 NELPMovieFinishReason

参数	说明
NELPMovieFinishReasonPlaybackEnded	正常播放结束
NELPMovieFinishReasonPlaybackError	播放发生错误导致结束
NELPMovieFinishReasonUserExited	人为退出(暂未使用，保留值)

回调视频的数据格式 NELPVideoFormat

参数	说明
NELP_YUV420	YUV 420

密钥校验结果 NELPKeyCheckResult

参数	说明
NELP_NO_ENCRYPTION	没有加密
NELP_ENCRYPTION_CHECK_OK	密钥正确
NELP_ENCRYPTION_UNSUPPORT_PROTOCAL	协议不支持
NELP_ENCRYPTION_KEY_CHECK_ERROR	密钥错误
NELP_ENCRYPTION_INPUT_INVALIED	输入错误
NELP_ENCRYPTION_GET_KEY_TIMEOUT	获取密钥超时
NELP_ENCRYPTION_UNKNOWN_ERROR	未知错误

切片清晰度 NELPMultiMediaType

参数	说明
NELP_MEDIA_INVALID	无效的
NELP_MEDIA_SD	低清
NELP_MEDIA_MD	标清
NELP_MEDIA_HD	高清
NELP_MEDIA_SHD	超清

切换切片结果 NELPSwitchStreamState

参数	说明
NELP_SWITCH_SUCCESS	切换成功
NELP_SWITCH_NO_STREAM	没有对应的流
NELP_SWITCH_FAILED	切换失败

结构体值参数介绍

视频信息 NELPVideoInfo

参数	说明
codec_type	视频编码器类型 如: h264
width	视频宽度
height	视频高度
fps	视频的帧率
bitrate	码率 (单位: kb/s)

视频信息 NELPAudioInfo

参数	说明
codec_type	音频编码器类型 如: aac
sample_rate	音频的采样率
bitrate	码率 (单位: kb/s)
numOfChannels	音频的通道数

回调的视频数据结构 NELPVideoRawData

参数	说明
width	视频宽度
height	视频高度
UsrData	视频数据

回调的音频数据结构 NELPAudioRawData

参数	说明
channels	通道数
samplerate	采样率
data_size	数据长度
usrData	音频数据

选择流的状态 NELPSwitchStreamResult

参数	说明
state	状态

更新日志

2.4.1 API变更

• 增加预调度结果查询接口 queryPreloadUrlResult:completion:
• 增加调度结果切换接口 switchWitGslbResultSession:address:

2.4.0 API变更

• 增加多播放器同步播放接口 syncClockToPlayer:
• 增加当前播放点回调接口 setPlaybackTimeListenerWithIntervalMS:callback:
• 增加DataSource回调接口 setMediaDataSource:(id)mediaDataSource

2.3.0 API变更

• 正式删除方法initWithNeedConfigAudioSession:
• 正式删除方法initWithContentURL:needConfigAudioSession:error:
• 正式删除加密切换方法 switchDecryptionUrl:transferToken:accid:appKey:token:complete://统一使用NELPUrlConfig设置
• 正式删除加密切换方法 switchDecryptionKeyUrl:key:complete://统一使用NELPUrlConfig设置
• 正式删除加密设置方法 setDecryptionTransferToken:accid:appKey:token:complete://统一使用NELPUrlConfig设置
• 正式删除加密设置方法 setDecryptionKey:complete: //统一使用NELPUrlConfig设置
• 正式删除getAudioQueue方法
• 增加setLogUserId:方法可协助问题排查

2.2.0 API变更

• 新增实时信息查询接口 getMediaRealTimeInfo

2.1.0 API变更

• 新增全局设置AudioSession接口 setExternConfigAudioSession:
• 新增带配置的设置Url接口 setPlayUrl:config:
• 新增带配置的switch接口 switchContentUrl:config:
• 新增设置缓冲长度接口 setBufferSize:
• 新增设置精确seek接口 setAccurateSeek:
• 新增设置自动重试接口 setRetryConfig:
• 即将废弃加密切换方法 switchDecryptionUrl:transferToken:accid:appKey:token:complete:
• 即将废弃加密切换方法 switchDecryptionKeyUrl:key:complete:
• 即将废弃加密设置方法 setDecryptionTransferToken:accid:appKey:token:complete:
• 即将废弃加密设置方法 setDecryptionKey:complete:
• 即将废弃初始化方法 initWithNeedConfigAudioSession:
• 即将废弃初始化方法 initWithContentURL:needConfigAudioSession:error:

2.0.0 API变更

• 增加音轨个数获取接口 getSelectedAudioTrack
• 增加PCM回调数据声道数和采样率设置接口 setAudioPcmDataConfig
• 增加设置音轨接口 setSelectedAudioTrack

1.9.0 API变更

• 增加循环播放设置接口：setLoopPlayCount:
• 增加镜像显示接口：setMirrorDisplay:

1.7.0 API 变更

• 增加同步信息开关。setOpenReceiveSyncData:
• 增加预调度系列接口addPreloadUrls、removePreloadUrls、queryPreloadTasks

1.6.0 API 变更

• 增加透传自定义通道的回调registerSyncContentCB：
• 增加本地外挂字幕文件的设置setLocalSubtitleFile：
• 增加外挂字幕显示／隐藏回调registSubtitleStatBlock：
• 增加日志接口回调setLogCallback：

1.4.1 -> 1.4.6 API 变更

• 缓冲策略增加NELPDelayPullUp类型
• 增加currentSyncTimestamp同步时间戳查询接口
• 增加setSyncTimestampListenerWithIntervalMS:callback 轮询上报同步时间戳接口
• 增加currentPlaybackRealTime 真实时间戳查询接口
• 增加setRealTimeListenerWithIntervalMS:callback 轮询上报真实时间戳接口

1.4.0 -> 1.4.1 API 变更

• 新增initWithContentURL:error:logCallBack:接口
• 新增initWithContentURL:needConfigAudioSession:error:logCallBack:接口

1.3.2 -> 1.4.0 API 变更

• 开放init 接口，new接口
• 增加initWithNeedConfigAudioSession: 接口
• 增加setPlayUrl:接口 。
• 所有增加接口均是基于原有接口- (id)initWithContentURL:进行的拆分，详细使用方法请参照NELivePlayerController.h介绍

1.3.1 -> 1.3.2 API 变更

• autoSwitchDefinition 增加自动切换多分辨率的开关接口
• 增加通知：NELivePlayerWillAutoSwitchDefinitionNotification 即将自动切换分辨率通知

1.3.0 -> 1.3.1 API变更

• getSDKVersion 获取版本号修改为类方法
• setLogLevel：设置日志级别修改为类方法
• getLogPath 新增日志路径获取接口，类方法
• 增加通知：NELivePlayerMulitDefinitionMediaNotification 多分辨率解析完毕，返回列表
• 增加通知：NELivePlayerHttpCodeResponseNotification 播放器网络请求状态码通知，返回状态码