播放器控制

adjustPlayoutVolume:

调整本地播放音量。

Objective-C

- (int)adjustPlayoutVolume:(int)volume NS_SWIFT_NAME(adjustPlayoutVolume(_:));

调用时机

你可以在加入频道前或加入频道后调用该方法。

参数

volume

本地播放音量，取值范围为 0 到 100：

• 0：静音。
• 100：（默认）原始音量。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

adjustPublishSignalVolume:

调节用于发布的媒体文件音量。

Objective-C

- (int)adjustPublishSignalVolume:(int)volume NS_SWIFT_NAME(adjustPublishSignalVolume(_:));

你可以调用该方法调节远端用户听到的媒体文件音量。该方法可以在加入频道前或加入频道后调用。

调用时机

该方法可以在加入频道前或加入频道后调用。

参数

volume

音量，取值范围为 0 到 400：

• 0：静音。
• 100：（默认）原始音量。
• 400：原始音量的四倍（将音频信号放大四倍）。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

mute:

设置是否静音媒体文件。

Objective-C

- (int)mute:(BOOL)isMute NS_SWIFT_NAME(mute(_:));

调用时机

你可以在加入频道前或加入频道后调用该方法。

参数

isMute

是否静音媒体文件：

• YES：静音媒体文件。
• NO：（默认）取消静音媒体文件。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

pause

暂停播放。

Objective-C

- (int)pause NS_SWIFT_NAME(pause());

调用时机

你可以在加入频道前或后调用该方法。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

play

播放媒体文件。

Objective-C

- (int)play NS_SWIFT_NAME(play());

你可以调用该方法播放媒体文件。

调用时机

• 在调用 open:startPos: 或 openWithMediaSource: 打开媒体文件，并收到 didChangedToState:reason: 回调报告状态为 AgoraMediaPlayerStateOpenCompleted 后调用该方法。
• 在调用 seekToPosition: 后调用该方法。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

playPreloadedSrc:

播放已预加载的媒体资源。

Objective-C

- (int)playPreloadedSrc:(NSString *)src NS_SWIFT_NAME(playPreloadedSrc(_:));

调用 preloadSrc:startPos: 方法将媒体资源预加载到播放列表后，可以调用此方法播放已预加载的媒体资源。如果调用该方法后收到 AgoraRtcMediaPlayer:didChangedToState:reason: 回调并报告 AgoraMediaPlayerStatePlaying 状态，表示播放成功。

• 如果想更换播放的预加载媒体资源，可以再次调用此方法并指定要预加载的新媒体资源的 URL。
• 如果想重新播放媒体资源，需要再次调用 preloadSrc:startPos: 方法将媒体资源重新预加载到播放列表中。
• 如果想清空播放列表，请调用 stop 方法。

信息

如果在播放暂停时调用此方法，该方法在播放恢复前不会生效。

参数

src

播放列表中媒体资源的 URL，必须与调用 preloadSrc:startPos: 方法时设置的 src 保持一致，否则无法播放该媒体资源。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

resume

恢复播放媒体文件。

Objective-C

- (int)resume NS_SWIFT_NAME(resume());

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

seekToPosition:

跳转到新的播放位置。

Objective-C

- (int)seekToPosition:(NSInteger)position NS_SWIFT_NAME(seek(toPosition:));

• 如果你在播放完成后调用该方法（收到回调 didChangedToState:reason:，播放状态为 AgoraMediaPlayerStatePlayBackCompleted 或 AgoraMediaPlayerStatePlayBackAllLoopsCompleted），SDK 会从指定位置开始播放媒体文件。此时，你会收到回调 didChangedToState:reason:，播放状态为 AgoraMediaPlayerStatePlaying。
• 如果你在播放暂停时调用该方法，调用成功后，SDK 会跳转到指定位置。要恢复播放，请调用 resume 或 play 方法。

调用时机

你可以在加入频道前或后调用该方法。

参数

position

新的播放位置（单位为毫秒）。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol

stop:

停止播放媒体轨道。

Objective-C

- (int)stop NS_SWIFT_NAME(stop());

调用该方法停止播放后，如果你需要再次播放，需要调用 open:startPos: 或 openWithMediaSource: 方法重新打开媒体资源。

调用时机

请在播放后调用该方法。

返回值

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

所属接口类

• AgoraRtcMediaPlayerProtocol