媒体资源打开

open

打开媒体资源。

Objective-C

- (int)open:(NSString *)url startPos:(NSInteger)startPos;

注意：
该方法为异步调用。
如需播放媒体文件，请在收到 didChangedToState 回调报告播放状态为 AgoraMediaPlayerStateOpenCompleted 后再调用 play 方法播放媒体文件。

参数

参数名	描述
url	设置媒体文件的路径，支持本地和在线文件。
startPos	设置起始播放位置（毫秒），默认值为 0。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

openWithCustomSourceAtStartPos

打开自定义媒体资源文件。

Objective-C

- (int)openWithCustomSourceAtStartPos:(NSInteger)startPos
                 withPlayerOnReadData:(AgoraRtcMediaPlayerCustomSourceOnReadCallback)onReadDataCallback
                      andPlayerOnSeek:(AgoraRtcMediaPlayerCustomSourceOnSeekCallback)onSeekCallback;

弃用

该方法已废弃，请改用 openWithMediaSource。

该方法支持你打开自定义的媒体资源文件。例如，你可以调用该方法打开已加密的媒体资源。

参数

参数名	描述
startPos	设置起始播放位置（毫秒），默认值为 0。
onReadDataCallBack	读取媒体资源数据回调。详见 AgoraRtcMediaPlayerCustomSourceOnReadCallback。
onSeekCallBack	定位媒体资源数据回调。详见 AgoraRtcMediaPlayerCustomSourceOnSeekCallback。

返回值

• 0：方法调用成功。

• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

openWithMediaSource

打开媒体资源并进行播放设置。

Objective-C

- (int)openWithMediaSource:(AgoraMediaSource *)source;

该方法支持你打开不同类型的媒体资源，包括自定义的媒体资源文件，并可进行播放设置。

参数

参数名	描述
source	媒体资源，详见 AgoraMediaSource。

返回值

• 0：方法调用成功。

• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

preloadSrc

预加载媒体资源。

Objective-C

- (int)preloadSrc:(NSString *)src startPos:(int)startPos;

你可以调用该方法将一个媒体资源预加载到播放列表中。如果需要预加载多个媒体资源，你可以多次调用该方法。

调用该方法后，如果收到 didPreloadEvent 回调报告事件 AgoraMediaPlayerPreloadEventComplete，则预加载成功；如果你收到 didPreloadEvent 回调报告事件 AgoraMediaPlayerPreloadEventError，则预加载失败。

预加载成功后，如果你想播放媒体资源，请调用 playPreloadedSrc；如果你想清空播放列表，请调用 stop。

注：
SDK 不支持你预加载重复的媒体资源到播放列表，但支持你将正在播放的媒体资源再次预加载到播放列表。

参数

参数名	描述
src	媒体资源的网络路径。
startPos	预加载到播放列表后，开始播放时的起始位置（毫秒）。预加载直播流时，将该参数设置为 0。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

switchSrc

切换媒体资源。

Objective-C

- (int)switchSrc:(NSString *)src syncPts:(BOOL)sync;

你可以根据当前网络状态调用该方法切换播放的媒体资源的码率。例如：

• 在网络较差时，将播放的媒体资源切换为较低码率的媒体资源地址。

• 在网络较好时，将播放的媒体资源切换为较高码率的媒体资源地址。

调用该方法后，如果你收到 didOccurEvent 回调报告事件 AgoraMediaPlayerEventSwitchComplete，则媒体资源切换成功；如果你收到 didOccurEvent 回调报告事件 AgoraMediaPlayerEventSwitchError，则媒体资源切换失败。

注意：

• 请确保在 open 之后调用该方法。

• 为保证播放正常，请在调用该方法时注意如下：

  • 不要在播放暂停时调用该方法。

  • 不要在切换码率过程中调用 seekToPosition。

  • 确保切换码率前的播放位置不大于待切换的媒体资源总时长。

参数

参数名	描述
src	媒体资源的网络路径。
syncPts	是否同步切换前后的起始播放位置: YES：同步。 NO：(默认) 不同步。 如果媒体资源为直播流，你只能将该参数设置为 NO，否则 SDK 切换媒体资源会失败。如果媒体资源为点播流，你可以根据场景需求对该参数赋值。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol

unloadSrc

释放预加载的媒体资源。

Objective-C

- (int)unloadSrc:(NSString *)src;

注意：
该方法不支持释放当前播放的媒体资源。

参数

参数名	描述
src	媒体资源的网络路径。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcMediaPlayerProtocol