iOS播放器SDK说明__SDK文档及下载_API及SDK_视频直播-阿里云

接口说明

SDK中提供了类AliVcMediaPlayer来实现播放器各种功能接口，同时，我们还提供了播放器的各种状态通知，以及播放器的各种错误代码。

下面详细介绍一下各个成员函数的具体使用：

create

- (AliVcMovieErrorCode) create: (UIView*)view

功能：创建播放器，并设置播放器显示窗口。播放器内部会新建各个播放器变量并初始化，并启动播放器内部流水线线程等。

参数：UIView* view，播放器显示窗口

备注：如果创建播放器的时候view没有，则可以传递nil，可以在后续需要设置view。

prepareToPlay

- (AliVcMovieErrorCode) prepareToPlay: (NSURL*)dataSource

功能：根据视频文件内容初始化播放器实例，包括读取视频头，解析视频和音频信息，并根据视频和音频信息初始化解码器，创建下载（或读取本地文件）、解码、渲染线程等。

参数：(NSURL*)dataSource，当前播放视频的文件名或URL

返回值：若播放器初始化成功，返回ALIVC_SUCCESS；否则返回失败。

prepareToPlay的具体过程为：

1. 验证用户是否有权限调用该函数。
2. 验证参数dataSource是否为空。
3. 如果播放器是正在播放或者正在暂停状态，则不能够进行prepare，此时返回非法的播放流程错误ALIVC_ ERR_ ILLEGALSTATUS，如果播放器状态是已经是准备完成状态，则返回ALIVC_SUCCESS。
4. 对视频进行初始化，如果成功，则会发送LoadDidPreparedNotification通知，表示视频初始化完成。如果失败则会发送PlaybackErrorNotification通知，在错误通知中可以获取到错误代码。

备注：该函数是异步函数，需要等待播放准备完成通知AliVcMediaPlayerLoadDidPreparedNotification，收到该通知后代表视频初始化完成，同事还可以获取到视频的相关信息如：duration、videoWidth、videoHeight。

play

- (AliVcMovieErrorCode) play

功能：播放当前视频

返回值：当播放视频成功，返回ALIVC_SUCCESS，否则返回失败。

play的具体过程为：

1. 验证是否有权限调用该函数
2. 如果播放器是停止的状态，则直接返回ALIVC_ ERR_ ILLEGALSTATUS错误；如果此时播放器为播放的状态，直接返回ALIVC_SUCCESS。
3. 如果播放器在暂停或者准备完成的状态，则直接启动视频播放。

备注：播放器调用play进行播放，必须在播放器状态为准备完成的状态或者暂停的状态才能进行播放，其他情况都不能够将视频播放起来。

pause

- (AliVcMovieErrorCode) pause

功能：暂停当前视频播放

返回值：暂停视频播放成功ALIVC_SUCCESS。否则返回失败。

pause的具体过程为：

1. 验证是否有权限调用该函数。
2. 如果此时播放器为暂停状态，直接返回ALIVC_SUCCESS。
3. 如果播放器状态为停止或者准备完成状态则返回错误的播放器状态ALIVC_ ERR_ ILLEGALSTATUS。
4. 其他情况则暂停视频播放，并将播放器状态设置为暂停状态。

备注：调用pause函数将暂停视频播放。一般在视频正在播放的情况下调用此函数。

stop

- (AliVcMovieErrorCode) stop

功能：停止当前视频播放，调用此函数则是结束视频播放，视频显示为黑屏，并回到视频播放起始点。

返回值：停止视频播放成功ALIVC_SUCCESS。否则返回失败。

stop的具体过程为：

1. 验证是否有权限调用该函数。
2. 如果此时播放器的状态为停止状态，直接返回ALIVC_SUCCESS。
3. 其他情况则停止视频播放，并将播放器状态设置为停止状态，视频停止后会发送视频结束通知。

备注：调用该函数会释放音视频解码、渲染线程。如果需要重新进行播放，则需要再调用prepareToPlay重新对视频进行初始化。

seekTo

(AliVcMovieErrorCode) seekTo: (NSTimeInterval) newPos

功能：跳转指定的播放位置附近

参数：newPos，单位为毫秒

返回值：跳转成功ALIVC_SUCCESS。否则返回失败。

seekTo的具体过程为：

1. 验证是否有权限调用该函数。
2. 如果此时播放器的状态为停止或准备完成状态，返回错误的播放器状态ALIVC_ ERR_ ILLEGALSTATUS。
3. 其他情况则进行视频跳转，跳转完成后会发送视频跳转结束通知AliVcMediaPlayerSeekingDidFinishNotification。

备注：该函数仅允许在点播或播放本地视频过程中调用（直播禁用）。调用后视频会跳转到指定位置前最近的一个关键帧。参数的范围为[0,duration]（duration为视频的时长）。如果传入的参数小于0，则播放器会自动将该参数修正到0；如果传入参数大于duration，则修正到duration。

seekToAccurate

- (AliVcMovieErrorCode) seekToAccurate: (NSTimeInterval) newPos

功能：视频跳转到指定的播放位置。此函数能够精确的跳转到指定的位置，而seekTo只能跳转到附近的关键帧。

参数：newPos，单位为毫秒

备注：相比于seekTo函数，该函数跳转的位置更精准，但是函数执行的时间也更长。

destroy

(AliVcMovieErrorCode) destroy

功能：销毁播放器，该函数用来释放播放器的所有资源。

备注：在退出播放器的时候必须调用该函数，用来进行内存释放，否则会存在内存泄露。

reset

(AliVcMovieErrorCode) reset

功能：重置播放器。当播放的过程中调用该函数，会先停止当前的播放行为，销毁当前的播放器，然后创建一个新的播放器。

返回值：如果权限验证通过，则会返回ALIVC_SUCCESS。

view

UIView *view

功能：设置包含视频内容的view。

备注：需要在调用prepareToPlay之前设置view，当前view只有视频帧图像，没有相关控制组件，相当于iOS系统播放器MPMoviePlayerController的控制方式controlStyle为MPMovieControlStyleNone的效果。

currentPosition

NSTimeInterval currentPosition

功能：获取当前视频播放位置，只读属性，获取单位为毫秒。

备注：当播放器状态为正在播放或暂停的状态，能够获取到有效值，否则获取值为无效的0。

videoWidth

int videoWidth

功能：获取视频宽度，只读属性。

备注：当调用了prepareToPlay后，并不能立即获得videoWidth的值，只有当播放器发送了prepared通知后，videoWidth的值才有效，否则为默认值0。

videoHieght

int videoHeight

功能：获取视频高度，只读属性。

备注：当调用了prepareToPlay后，并不能立即获得videoHeight的值，只有当播放器发送了prepared通知后，videoHeight的值才有效，否则为默认值0。

livePlayer

int livePlayer

功能：设置播放器是直播还是点播模式，设置为1为直播，设置为0为点播.默认值为-1不进行设置，由播放器自动判决。

备注：播放器自动判决会根据是否存在视频长度来判定是直播还是点播，此时会存在一定的偏差。如果用户知道自己的应用场景，应该设置此值使得播放器行为表现更加精确。

timeout

int timeout

功能：设置播放器网络超时时间，默认为15000毫秒。

备注：当播放网络视频时候，如果网络较差或者无网络的情况下，播放器此时会等待timeout的时间才会抛出网络异常的通知，用户收到此通知后进行处理，否则会一直等待。

dropBufferDuration

int dropBufferDuration

功能：当播放器处理直播模式时，设置缓冲区开始丢帧的起始长度，默认为8000毫秒。

备注：当缓冲区的长度大于dropBufferDuration时候，播放器开始启动丢帧策略，此时必须要保证缓冲区至少有一个I帧，否则会引起花屏，所以此值必须大于一个GOP的长度。

duration

NSTimeInterval duration

功能：获取视频时长，只读属性，单位为毫秒。

备注：当调用了prepareToPlay后，并不能立即获得duration的值，只有当播放器发送了prepared通知后，duration的值才有效，否则为默认值0。

bufferingPosition

NSTimeInterval bufferingPostion

功能：获取当前播放器已经缓冲好的位置。

备注：开始播放后，可以获取此值，用来获取已经下载好的位置。

muteMode

BOOL muteMode

功能：设置播放器是否静音，YES位静音。

备注：静音指播放器的静音，并不会影响系统音量。

scalingMode

ScalingMode scalingMode

功能：设置播放器渲染时的缩放模式，目前有两种模式，scalingModeAspectFit：等比例缩放显示，如果视频长宽比和屏幕长宽比不一致时，会存在黑边；scalingModeAspectFitWithCropping：带裁边的等比例缩放，如果视频长宽比和屏幕长宽比不一致时，会进行裁边处理以保持全屏显示。

备注：默认为scalingModeAspectFitWithCropping模式，可以动态改变。

errorCode

AliVcMovieErrorCode errorCode

功能：播放器错误代码，只读属性。

备注：当播放器出现错误时，可以通过获取这个属性来获取到错误的代码，通过错误代码可以了解到具体的错误原因。

getSDKVersion

- (NSString *) getSDKVersion

功能：获取SDK版本号。

返回值：返回NSString类型的版本号。

备注：当开发者反馈问题时，请使用该方法获得SDK版本号并随同问题一起反馈。

getPropertyDouble

-(double) getPropertyDouble:(int)property defaultValue:(double)defaultValue

功能：获取一些性能参数。

返回值：返回double型的参数。

备注：同类型的函数还有getPropertyLong，getPropertyString等。这些键值如下：

版本更新说明

1.0 原始版本，调用硬件的mediaPlayer接口实现

2.0 改用硬件的mediaCodec接口实现

2.1 增加直播秒开功能、缓冲区丢帧策略等。

2.2 支持模拟器、支持多实例、支持https、增加静音功能、添加视频渲染时的缩放模式

2.2.1 支持苹果2017年1月1号后强制使用HTTPS的要求

最后更新：2016-12-06 17:59:56

  上一篇： Android播放器SDK说明__SDK文档及下载_API及SDK_视频直播-阿里云

  下一篇： 直播API概述__直播API_API及SDK_视频直播-阿里云