AgoraRtcMediaPlayerProtocol
提供媒体播放器功能的类,支持多实例。
adjustPlayoutVolume
调节本地播放音量。
- (int)adjustPlayoutVolume:(int)volume;
参数
- volume
- 本地播放音量,取值范围从 0 到 100:
- 0: 无声。
- 100: (默认)媒体文件的原始播放音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
adjustPublishSignalVolume
调节远端用户听到的音量。
- (int)adjustPublishSignalVolume:(int)volume;
连接到 Agora 服务器后,你可以调用该方法,调节远端用户听到的媒体文件的音量。
参数
- volume
- 信号音量,取值范围从 0 到 400:
- 0: 无声。
- 100: (默认)媒体文件的原始音量。
- 400: 原始音量的四倍(自带溢出保护)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
destroyMediaPlayer
销毁媒体播放器。
- (int)destroyMediaPlayer:(id<AgoraRtcMediaPlayerProtocol>_Nullable)mediaPlayer;
参数
- mediaPlayer
返回值
- ≥ 0: 方法调用成功,返回媒体播放器 ID
- < 0: 方法调用失败
enableAutoSwitchAgoraCDN
开启/关闭自动切换媒体资源的 CDN 线路。
- (int)enableAutoSwitchAgoraCDN:(BOOL)enable;
如果你想设置 SDK 根据网络情况自动切换媒体资源 CDN 线路,你可以调用该方法。
请在 openWithAgoraCDNSrc 前调用该方法。
参数
- enable
- 设置是否开启自动切换媒体资源的 CDN 线路:
YES
:开启自动切换媒体资源的 CDN 线路。NO
:(默认) 关闭自动切换媒体资源的 CDN 线路。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
getAgoraCDNLineCount
获取媒体资源的 CDN 线路数量。
- (int)getAgoraCDNLineCount;
返回值
- > 0:方法调用成功,返回媒体资源的 CDN 线路数量。
- ≤ 0:方法调用失败。
getCurrentAgoraCDNIndex
获取当前使用的媒体资源的 CDN 线路索引。
- (int)getCurrentAgoraCDNIndex;
返回值
- ≥ 0: 方法调用成功,返回媒体资源的 CDN 线路索引。数值范围为 [0, getAgoraCDNLineCount
()
)。 - < 0: 方法调用失败。
getDuration
获取媒体文件总时长。
- (NSInteger)getDuration;
返回值
- 方法调用成功时,返回媒体资源的总时长,单位毫秒。
- ≤ 0:方法调用失败。
getMediaPlayerId
获取播放器 ID。
- (int)getMediaPlayerId;
返回值
- 方法调用成功,返回播放器 ID。
- < 0: 方法调用失败。
getPlayoutVolume
获取当前本地播放音量。
- (int)getPlayoutVolume;
返回值
- 0: 无声。
- 100: (默认)媒体文件的原始播放音量。
getPosition
getPublishSignalVolume
获取远端用户听到的音量。
- (int)getPublishSignalVolume;
返回值
- ≥ 0: 播放文件的远端播放音量。
- < 0: 方法调用失败。
getPlayerState
getStreamCount
获取当前媒体文件中媒体流的数量。
- (NSInteger)getStreamCount;
返回值
- 方法调用成功,返回该媒体文件中媒体流的数量。
- < 0: 方法调用失败,详见 AgoraMediaPlayerError。
getStreamByIndex
通过媒体流的索引值获取媒体流信息。
- (AgoraMediaStreamInfo *_Nullable)getStreamByIndex:(int)index;
参数
- index
- 媒体流索引值。
返回值
- 方法调用成功,返回媒体流信息,详见 AgoraRtcMediaStreamInfo。
- 方法调用失败,返回
nil
。
getMute
获取当前播放的媒体文件是否静音。
- (bool)getMute;
返回值
YES
:当前播放的媒体文件为静音。NO
:当前播放的媒体文件没有静音。
mute
设置是否静音。
- (int)mute:(bool)isMute;
参数
- isMute
- 静音选项。
YES
:静音。NO
:(默认)不静音。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
didReceiveAudioFrame
已获取音频帧回调。
- (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveAudioFrame:(CMSampleBufferRef _Nonnull)audioFrame;
注册音频数据观测器后,每次接收到一帧音频帧时,都会触发该回调,报告音频帧信息。
参数
- audioFrame
- 音频帧信息(CMSampleBufferRef)。
- playerKit
- 详见 AgoraRtcMediaPlayerProtocol。
didReceiveVideoFrame
已获取视频帧回调。
- (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveVideoFrame:(CVPixelBufferRef _Nonnull)pixelBuffer;public virtual bool OnFrame(VideoFrame audioFrame, VideoFrameBufferConfig config) { return true; }
注册视频数据观测器后,每次接收到一帧视频帧时,都会触发该回调,报告视频帧信息。
参数
- playerKit
- 详见 AgoraRtcMediaPlayerProtocol。
- pixelBuffer
- 纹理的 Buffer(CVPixelBufferRef)。
AgoraRtcMediaPlayerCustomSourceOnReadCallback
读取媒体资源数据回调。
typedef int(^AgoraRtcMediaPlayerCustomSourceOnReadCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, unsigned char * _Nullable buffer, int bufferSize);
使用 openWithCustomSourceAtStartPos 打开自定义媒体资源时,SDK 会触发该回调,向你请求定位到媒体资源中的指定位置。
参数
- playerKit
- 媒体播放器协议。详见 AgoraRtcMediaPlayerProtocol。
- buffer
- 输入参数,数据 Buffer,单位为字节。请将 SDK 报告的 bufferSize 数据写入到此参数中。
- bufferSize
- 数据 Buffer 的长度,单位为字节。
返回值
- 如果读取数据成功,请在返回值中传入你实际读取的数据长度,单位为字节。
- 如果读取数据失败,请在返回值中传入 0。
AgoraRtcMediaPlayerCustomSourceOnSeekCallback
定位媒体资源数据回调。
typedef long long(^AgoraRtcMediaPlayerCustomSourceOnSeekCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, long long offset, int whence);
使用 openWithCustomSourceAtStartPos 打开自定义媒体资源时,SDK 会触发该回调,向你请求定位到媒体资源中的指定位置。
参数
- playerKit
- 媒体播放器协议。详见 AgoraRtcMediaPlayerProtocol。
- offset
- 输入参数。定位位置相对于起点的偏移量,单位为字节。取值可正可负。
- whence
- 输入参数。表示定位的起点位置。可以为如下值:
- 0:起点为数据的头,定位后的实际数据偏移量为 offset。
- 1:起点为当前位置,定位后的实际数据偏移量为当前位置加上 offset。
- 2:起点为数据的尾,定位后的实际数据偏移量为文件长度加上 offset。
- 65536:不执行定位操作,返回文件大小。建议在播放 MP3、WAV 等纯音频文件时使用该参数值。
返回值
- 当 whence 为 65536 时,返回媒体文件大小。
- 当 whence 为 0/1/2 时,返回实际定位后的数据偏移量。
- -1:定位失败。
open
打开媒体资源。
- (int)open:(NSString *)url startPos:(NSInteger)startPos;
如果用户需要自定义播放线路,你可以调用 openWithAgoraCDNSrc。Agora 会通过自研调度中心支持调度线路,提升观看用户体验。如果用户不需要自定义播放线路,你可以调用 open。
该方法为异步调用。
如需播放媒体文件,请在收到 didChangedToState 回调报告播放状态为 AgoraMediaPlayerStateOpenCompleted 后再调用 play 方法播放媒体文件。
参数
- url
- 设置媒体文件的路径,支持本地和在线文件。
- startPos
- 设置起始播放位置(毫秒),默认值为 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
openWithAgoraCDNSrc
打开媒体资源,并通过自研调度中心请求媒体资源的所有 CDN 线路。
- (int)openWithAgoraCDNSrc:(NSString *)src startPos:(NSInteger)startPos;
该方法为异步调用。
如需播放媒体文件,请在收到 didChangedToState 回调报告播放状态为 AgoraMediaPlayerStateOpenCompleted 后再调用 play 方法播放媒体文件。
调用该方法后,Agora 会打开媒体资源并通过自研调度中心请求媒体资源的所有 CDN 线路。Agora 默认使用第一个线路,你也可以通过 switchAgoraCDNLineByIndex 自行切换线路。
query parameter
以更新媒体资源的网路路径。例如:
- 媒体资源网络路径为
rtmp://$domain/$appName/$streamName
- 通过鉴权信息更新过的媒体资源网络路径为
rtmp://$domain/$appName/$streamName?ts=$ts&sign=$sign
- sign : 通过
authKey
+appName
+streamName
+ts
进行 md5 算法加密得出的鉴权字段。你需要联系技术支持咨询你的authKey
字段内容。 - ts : 鉴权过期时间。你可以指定再过多久鉴权过期。例如,
24h
或1h30m20s
。
参数
- src
- 媒体资源的网络路径。
- startPos
- 设置起始播放位置 (毫秒),默认值为 0。如果媒体资源为直播流,则无需赋值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
openWithMediaSource
打开媒体资源并进行播放设置。
- (int)openWithMediaSource:(AgoraMediaSource *)source;
该方法支持你打开不同类型的媒体资源,包括自定义的媒体资源文件,并可进行播放设置。
参数
- source
- 媒体资源,详见 AgoraMediaSource。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
pause
暂停播放。
- (int)pause;
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
play
playPreloadedSrc
播放预加载的媒体资源。
- (int)playPreloadedSrc:(NSString *)src;
调用 preloadSrc 方法将媒体资源预加载到播放列表后,可以调用该方法播放已预加载的媒体资源。调用该方法后,如果你收到 didChangedToState 回调报告状态 AgoraMediaPlayerStatePlaying,则表示播放成功。
如果你想更换播放的预加载媒体资源,你可以再次调用该方法并指定新的媒体资源路径。如果你想重新播放媒体资源,你需要在播放前调用 preloadSrc 重新将该媒体资源预加载到播放列表。如果你想清空播放列表,请调用 stop。
如果你在播放暂停时调用该方法,该方法会在恢复播放后才生效。
参数
- src
- 播放列表中的媒体资源 URL 地址,必须与 preloadSrc 方法设置的 src 一致,否则无法播放。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
preloadSrc
预加载媒体资源。
- (int)preloadSrc:(NSString *)src startPos:(int)startPos;
你可以调用该方法将一个媒体资源预加载到播放列表中。如果需要预加载多个媒体资源,你可以多次调用该方法。
调用该方法后,如果收到 didPreloadEvent 回调报告事件 AgoraMediaPlayerPreloadEventComplete,则预加载成功;如果你收到 didPreloadEvent 回调报告事件 AgoraMediaPlayerPreloadEventError,则预加载失败。
预加载成功后,如果你想播放媒体资源,请调用 playPreloadedSrc;如果你想清空播放列表,请调用 stop。
Agora 不支持你预加载重复的媒体资源到播放列表,但支持你将正在播放的媒体资源再次预加载到播放列表。
参数
- src
- 媒体资源的网络路径。
- startPos
- 预加载到播放列表后,开始播放时的起始位置(毫秒)。预加载直播流时,将该参数设置为 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
renewAgoraCDNSrcToken
更新媒体资源网络路径的鉴权信息。
- (int)renewAgoraCDNSrcToken:(NSString *)token ts:(NSInteger)ts;
当鉴权信息过期(超出 ts 时间)时,你可以调用 openWithAgoraCDNSrc 或 switchAgoraCDNSrc 重新打开或切换媒体资源,并传入带新鉴权信息(如更新 ts 字段内容)的媒体资源网络路径。
如果你在切换媒体资源线路 (switchAgoraCDNLineByIndex) 时遇到鉴权信息过期,你需要调用该方法并传入新的鉴权信息,以更新该媒体资源网络路径的鉴权信息。更新鉴权信息后,你还需调用 switchAgoraCDNLineByIndex 才能完成线路切换。
为避免鉴权信息频繁过期,请务必根据场景需求设置合适的 ts 字段内容或联系技术支持。
参数
- token
- 鉴权字段。即鉴权信息中的 sign 字段。
- ts
- 鉴权过期时间。即鉴权信息中的 ts 字段。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
resume
暂停后恢复播放。
- (int)resume;
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
seekToPosition
定位到媒体文件的指定播放位置。
- (void)seekToPosition:(NSInteger)position;
成功调用该方法后,你会收到 didOccurEvent 回调,报告当前播放器发生的事件,如定位开始、定位成功或定位失败。
- 调用该方法定位。
- 定位完成后,调用 play 方法播放。
参数
- position
- 指定的位置(毫秒)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
selectAudioTrack
指定当前音频文件的播放音轨。
- (int)selectAudioTrack:(int)index;
获取音频文件的音轨索引后,你可以调用该方法指定任一音轨进行播放。例如,如果一个多音轨文件的不同音轨存放了不同语言的歌曲,则你可以调用该方法设置播放语言。
参数
- index
- 音轨的索引值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setAudioDualMonoMode
设置当前音频文件的声道模式。
- (int)setAudioDualMonoMode:(AgoraAudioDualMonoMode)mode;
在双声道音频文件中,左声道和右声道可以存储不同的音频数据。根据实际需要,你可以设置声道模式为原始模式、左声道模式、右声道模式或混合模式。例如,在 KTV 场景中,音频文件的左声道存储了伴奏,右声道存储了原唱的歌声。如果你只需听伴奏,调用该方法设置音频文件的声道模式为左声道模式;如果你需要同时听伴奏和原唱,调用该方法设置声道模式为混合模式。
- 你需要在调用 open 后调用该方法。
- 该方法仅适用于双声道的音频文件。
参数
- mode
- 声道模式。详见 AgoraAudioDualMonoMode。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setAudioPitch
调整当前播放的媒体资源的音调。
- (int)setAudioPitch:(NSInteger)pitch;
参数
- pitch
- 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
setLoopCount
设置循环播放。
- (void)setLoopCount:(NSInteger)loopCount;
如果你希望循环播放,请调用该方法并设置循环播放次数。
循环播放结束时,SDK 会触发 didChangedToState 回调,向你报告播放状态为 AgoraMediaPlayerStatePlayBackAllLoopsCompleted。
参数
- loopCount
- 循环播放的次数。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setPlaybackSpeed
设置当前音频文件的播放速度。
- (int)setPlaybackSpeed:(int)speed;
你需要在 open 后调用该方法。
参数
- speed
- 播放速度。推荐取值范围为 [50,400],其中:
- 50: 0.5 倍速。
- 100: 原始速度。
- 400: 4 倍速。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setPlayerOption
设置媒体播放器的私有选项。
- (void)setPlayerOptionInt:(NSString *)key value:(NSInteger)value;
媒体播放器支持通过 key 和 value 来设置私有选项。 一般情况下,你无需知晓私有选项设置,使用媒体播放器默认的选项设置即可。
- 请确保在 open 之前调用该方法。
- 如果你使用客户端旁路推流功能,且在推流过程中发送 SEI 信息,你需要调用 setPlayerOption
("sei_data_with_uuid", 1)
方法,否则会导致 SEI 信息的丢失。
参数
- key
- key 值。
- value
- value 值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setRenderMode
设置播放器视图的渲染模式。
- (void)setRenderMode:(AgoraMediaPlayerRenderMode)mode;
参数
- mode
-
播放器视图的渲染模式。详见 AgoraVideoRenderMode。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setView
设置播放器渲染视图。
- (void)setView:(View *_Nullable)view;
参数
- view
- 渲染视图。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
stop
停止播放。
- (void)stop;
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
switchAgoraCDNLineByIndex
切换媒体资源的 CDN 线路。
- (int)switchAgoraCDNLineByIndex:(int)index;
- 请在 openWithAgoraCDNSrc 后调用该方法。
- 该方法在 play 前后均可调用。如果你在 play 前调用该方法,切换不会立即生效。SDK 会等待播放完成后再切换媒体资源的 CDN 线路。
参数
- index
- CDN 线路索引。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
switchAgoraCDNSrc
切换媒体资源。
- (int)switchAgoraCDNSrc:(NSString *)src syncPts:(BOOL)syncPts;
如果用户需要自定义播放线路,你可以调用该方法实现媒体资源切换。Agora 会通过自研调度中心支持调度线路,提升观看用户体验。如果用户不需要自定义播放线路,你可以调用 switchSrc 实现媒体资源切换。
- 请在 openWithAgoraCDNSrc 后调用该方法。
- 该方法在 play 前后均可调用。如果你在 play 前调用该方法,SDK 会等你调用 play 后再完成线路切换。
query parameter
以更新媒体资源的网路路径。例如:
- 媒体资源网络路径为
rtmp://$domain/$appName/$streamName
- 通过鉴权信息更新过的媒体资源网络路径为
rtmp://$domain/$appName/$streamName?ts=$ts&sign=$sign
- sign : 通过
authKey
+appName
+streamName
+ts
进行 md5 算法加密得出的鉴权字段。你需要联系技术支持咨询你的authKey
字段内容。 - ts : 鉴权过期时间。你可以指定再过多久鉴权过期。例如,
24h
或1h30m20s
。
参数
- src
- 媒体资源的网络路径。
- syncPts
- 是否同步切换前后的起始播放位置:
YES
:同步。NO
:(默认) 不同步。
如果媒体资源为直播流,你只能将该参数设置为
NO
,否则 SDK 切换媒体资源会失败。如果媒体资源为点播流,你可以根据场景需求对该参数赋值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
switchSrc
切换媒体资源。
- (int)switchSrc:(NSString *)src syncPts:(BOOL)sync;
- 在网络较差时,将播放的媒体资源切换为较低码率的媒体资源地址。
- 在网络较好时,将播放的媒体资源切换为较高码率的媒体资源地址。
调用该方法后,如果你收到 didOccurEvent 回调报告事件 AgoraMediaPlayerEventSwitchComplete,则媒体资源切换成功;如果你收到 didOccurEvent 回调报告事件 AgoraMediaPlayerEventSwitchError,则媒体资源切换失败。
如果用户需要自定义播放线路,你可以调用 switchAgoraCDNSrc 实现媒体资源切换。Agora 会通过自研调度中心支持调度线路,提升观看用户体验。如果用户不需要自定义播放线路,你可以调用 switchSrc 实现媒体资源切换。
- 请确保在 open 之后调用该方法。
- 为保证播放正常,请在调用该方法时注意如下:
- 不要在播放暂停时调用该方法。
- 不要在切换码率过程中调用 seekToPosition。
- 确保切换码率前的播放位置不大于待切换的媒体资源总时长。
参数
- src
- 媒体资源的网络路径。
- syncPts
- 是否同步切换前后的起始播放位置:
YES
:同步。NO
:(默认) 不同步。
如果媒体资源为直播流,你只能将该参数设置为
NO
,否则 SDK 切换媒体资源会失败。如果媒体资源为点播流,你可以根据场景需求对该参数赋值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
unloadSrc
释放预加载的媒体资源。
- (int)unloadSrc:(NSString *)src;
该方法不支持释放当前播放的媒体资源。
参数
- src
- 媒体资源的网络路径。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。