ARMediaPlayer

最近更新时间:2022-09-20 05:17:40

概览

提供所有可供 App 调用的方法

anyRTC 通过全球部署的虚拟网络专为 WebRTC 以及移动端到移动端的 App 进行过优化。可以为全世界的音视频通信提供质量保证的体验(QoE)。

ARMediaPlayer 是媒体播放器的入口类。它为媒体播放器提供了快速搭建的 API。

核心方法

initWithDelegate

- (instancetype)initWithDelegate:(id<ARMediaPlayerDelegate>)delegate;

初始化一个 ARMediaPlayer 实例

参数描述
delegateARMediaPlayerDelegate 回调

返回值

一个 ARMediaPlayer 实例

注意事项: 请确保在调用前先初始化 ARtcEngineKit。 返回时必须先调用 destroy 销毁当前实例。


destory

- (void)destroy;

销毁 ARMediaPlayer 实例

该方法用于释放ARMediaPlayer 使用的所有对象资源。一旦 App 调用了 destroy 接口销毁创建的 ARMediaPlayerKit 实例,将无法调用 SDK 内的任何方法也不再会有任何回调产生。如需重启通话,请调用初始化方法initWithDelegate 创建一个新的 ARMediaPlayer 实例。

setView

- (void)setView:(View *_Nullable)view;

设置播放器的渲染视图

该方法用于创建视频渲染视图

setRenderMode

- (void)setRenderMode:(ARMediaPlayerRenderMode)mode;

设置播放器视图的渲染模式

该方法用于设置视图的渲染模式详见 ARMediaPlayerRenderMode

渲染模式描述
ARMediaPlayerRenderModeHidden视频尺寸等比缩放,优先保证视窗被填满,因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉。
ARMediaPlayerRenderModeFit视频尺寸等比缩放,优先保证视频内容全部显示,因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充黑色。

open

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

打开媒体文件

参数描述
url设置媒体文件的路径,本地路径或网络路径
startPos设置起始播放位置 (s),默认值为 0

play

- (void)play;

播放媒体文件

注意事项: 打开 open 媒体文件或暂停 pause 播放媒体文件后,你可以调用该方法播放媒体文件。


pause

- (void)pause;

暂停播放媒体文件

注意事项: 如果你想恢复播放,请调用 play() 方法。


stop

- (void)stop;

停止播放媒体文件


seekToPosition

- (void)seekToPosition:(NSInteger)position;

从指定的位置播放媒体文件

参数描述
position指定的位置 (s)

成功调用该方法后,将收到didOccurEvent回调


mute

- (int)mute:(bool)isMute;

设置是否静音

参数描述
isMuteYES: 静音 NO: (默认)不静音

返回值

0方法调用成功,<0方法调用失败

getMute

- (bool)getMute;

获取当前的静音状态

返回值

方法调用成功,返回:YES: 静音 NO: (默认)不静音
方法调用失败,返回 NO

adjustVolume

- (int)adjustVolume:(int)volume;

调节本地播放音量

参数描述
volume本地播放音量,取值范围从 0100
0: 无声 100: (默认)媒体文件的原始播放音量

返回值

0方法调用成功,<0方法调用失败

getPosition

- (NSInteger)getPosition;

获取当前播放进度

返回值

< 0: 方法调用失败,详见 ARMediaPlayerError
其它:播放进度 (s)

getDuration

- (NSInteger)getPosition;

获取媒体文件总时长

返回值

< 0: 方法调用失败,详见 ARMediaPlayerError
其它:媒体文件总时长 (s)

getPlayerState

- (ARMediaPlayerState)getPlayerState;

获取播放器当前状态

返回值

方法调用成功,返回播放器当前状态 详见 ARMediaPlayerState
方法调用失败,返回 nil

getStreamCount

- (NSInteger)getStreamCount;

获取该媒体文件中媒体流的数量

返回值

< 0: 方法调用失败,详见 ARMediaPlayerError
其它:该媒体文件中媒体流的数量

getStreamByIndex

- (ARMediaStreamInfo *_Nullable)getStreamByIndex:(int)index;

通过此条媒体流的索引值获取媒体流信息

参数描述
index媒体流索引值

返回值

方法调用成功,返回媒体流信息,详见 ARMediaStreamInfo
方法调用失败,返回 nil