内置媒体播放器
介绍内置媒体播放器相关的方法和回调。
你可以通过调用媒体播放器相关的 API 播放本地或在线媒体资源,或将媒体资源分享给频道内的远端用户观看或收听。
AdjustPlayoutVolume
调节本地播放音量。
public abstract int AdjustPlayoutVolume(int volume);
参数
- volume
- 本地播放音量,取值范围从 0 到 100:
- 0: 无声。
- 100: (默认)媒体文件的原始播放音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
AdjustPublishSignalVolume
调节远端用户听到的音量。
public abstract int AdjustPublishSignalVolume(int volume);
详情
连接到声网服务器后,你可以调用该方法,调节远端用户听到的媒体文件的音量。
参数
- volume
- 信号音量,取值范围从 0 到 400:
- 0: 无声。
- 100: (默认)媒体文件的原始音量。
- 400: 原始音量的四倍(自带溢出保护)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
CreateMediaPlayer
创建媒体播放器。
public abstract IMediaPlayer CreateMediaPlayer();
返回值
- 方法调用成功:返回 IMediaPlayer 对象。
- 方法调用失败:返回空指针。
DestroyMediaPlayer
销毁媒体播放器。
public abstract int DestroyMediaPlayer(IMediaPlayer mediaPlayer);
参数
- mediaPlayer
-
IMediaPlayer 对象。
返回值
- ≥ 0: 方法调用成功,返回媒体播放器 ID
- < 0: 方法调用失败
Dispose
释放媒体播放器占用的所有资源。
public abstract void Dispose();
EnableAutoRemoveCache
设置是否开启自动清除缓存文件功能。
public abstract int EnableAutoRemoveCache(bool enable);
详情
开启自动清除缓存文件后,当播放器中缓存的媒体文件超过你设置的文件数量或总缓存大小的上限时,SDK 会自动清除近期最少使用的一个缓存文件。
参数
- enable
- 是否自动清除缓存文件:
true
:开启自动清除缓存文件功能。false
:(默认)关闭自动清除缓存文件功能。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetCacheDir
获取缓存文件的储存路径。
public abstract int GetCacheDir(out string path, int length);
详情
如果你在调用该方法前未曾调用 SetCacheDir 方法自定义缓存文件的储存路径,该方法返回的为 SDK 默认的缓存文件储存路径。
参数
- path
- 输出参数,缓存文件的储存路径。
- length
- 输入参数,缓存文件储存路径字符串的最大长度。根据你在 path 中获得的缓存文件储存路径字符串来填写。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetCacheFileCount
获取当前已缓存的媒体文件的总数量。
public abstract int GetCacheFileCount();
返回值
- ≥ 0:方法调用成功,返回当前已缓存的媒体文件的总数量。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetDuration
获取媒体文件总时长。
public abstract int GetDuration(ref Int64 duration);
参数
- duration
- 输出参数。媒体文件总时长(毫秒)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
GetMaxCacheFileCount
获取所设置的缓存文件数量上限。
public abstract int GetMaxCacheFileCount();
详情
SDK 默认的缓存文件数量上限为 1000。
返回值
- > 0:方法调用成功,返回缓存文件数量的上限。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetMaxCacheFileSize
获取所设置的缓存文件总缓存的上限。
public abstract Int64 GetMaxCacheFileSize();
详情
SDK 默认的缓存文件总缓存上限为 1GB。你可以调用 SetMaxCacheFileSize 方法自定义总缓存大小的上限。
返回值
- > 0:方法调用成功,返回缓存文件的总缓存上限,单位为字节。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetMediaPlayerCacheManager
获取 IMediaPlayerCacheManager 实例。
public abstract IMediaPlayerCacheManager GetMediaPlayerCacheManager();
详情
当你调用该方法后,SDK 会返回一个媒体播放器缓存管理器的实例。由于媒体播放器缓存管理器对象是单例模式,因此多次调用该方法将返回同一个实例。
请在初始化 IRtcEngine 后调用该方法。
返回值
GetId
获取播放器 ID。
public abstract int GetId();
返回值
- 方法调用成功,返回播放器 ID。
- < 0: 方法调用失败。
GetMute
获取当前播放的媒体文件是否静音。
public abstract int GetMute(ref bool muted);
参数
- muted
- 输出参数。静音状态:
true
: 静音。false
: 不静音。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
GetPlayoutVolume
获取当前本地播放音量。
public abstract int GetPlayoutVolume(ref int volume);
参数
- volume
- 输出参数。本地播放音量,取值范围从 0 到 100:
- 0: 无声。
- 100: (默认)媒体文件的原始播放音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
GetPlayPosition
获取当前播放进度。
public abstract int GetPlayPosition(ref Int64 pos);
参数
- pos
- 媒体资源文件当前的播放位置,单位为毫秒。
返回值
- 方法调用成功,返回当前播放进度(毫秒)。
- < 0: 方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetPlaySrc
获取播放的媒体资源的路径。
public abstract string GetPlaySrc();
返回值
播放的媒体资源的路径。
GetPublishSignalVolume
获取远端用户听到的音量。
public abstract int GetPublishSignalVolume(ref int volume);
参数
- volume
- 输出参数。播放文件的远端播放音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
GetState
GetStreamCount
获取当前媒体文件中媒体流的数量。
public abstract int GetStreamCount(ref Int64 count);
详情
参数
- count
- 输出参数。当前媒体文件中媒体流的数量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败,详见 MEDIA_PLAYER_ERROR。
GetStreamInfo
通过媒体流的索引值获取媒体流信息。
public abstract int GetStreamInfo(Int64 index, ref PlayerStreamInfo info);
详情
参数
- index
- 媒体流索引值。
- info
- 输出参数。媒体流的所有信息,详见 PlayerStreamInfo。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
InitEventHandler
添加媒体播放器的回调事件。
public abstract int InitEventHandler(IMediaPlayerSourceObserver engineEventHandler);
参数
- engineEventHandler
- 待添加的回调事件,详见 IMediaPlayerSourceObserver。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
Mute
设置是否静音。
public abstract int Mute(bool muted);
参数
- muted
- 静音选项。
true
:静音。false
:(默认)不静音。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
Open
打开媒体资源。
public abstract int Open(string url, Int64 startPos);
详情
该方法为异步调用。
如需播放媒体文件,请在收到 OnPlayerSourceStateChanged 回调报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后再调用 Play 方法播放媒体文件。
参数
- url
- 设置媒体文件的路径,支持本地和在线文件。
- startPos
- 设置起始播放位置(毫秒),默认值为 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
OpenWithCustomSource
打开自定义媒体资源文件。
public abstract int OpenWithCustomSource(Int64 startPos, IMediaPlayerCustomDataProvider provider);
详情
- 弃用:
- 该方法已废弃,请改用 OpenWithMediaSource。
该方法支持你打开自定义的媒体资源文件。例如,你可以调用该方法打开已加密的媒体资源。
参数
- startPos
- 设置起始播放位置(毫秒),默认值为 0。
- provider
- 自定义媒体资源文件的回调。详见 IMediaPlayerCustomDataProvider。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
OpenWithMediaSource
打开媒体资源并进行播放设置。
public abstract int OpenWithMediaSource(MediaSource source);
详情
该方法支持你打开不同类型的媒体资源,包括自定义的媒体资源文件,并可进行播放设置。
参数
- source
- 媒体资源,详见 MediaSource。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
Pause
暂停播放。
public abstract int Pause();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
Play
PlayPreloadedSrc
播放预加载的媒体资源。
public abstract int PlayPreloadedSrc(string src);
详情
调用 PreloadSrc 方法将媒体资源预加载到播放列表后,可以调用该方法播放已预加载的媒体资源。调用该方法后,如果你收到 OnPlayerSourceStateChanged 回调报告状态 PLAYER_STATE_PLAYING,则表示播放成功。
如果你想更换播放的预加载媒体资源,你可以再次调用该方法并指定新的媒体资源路径。如果你想重新播放媒体资源,你需要在播放前调用 PreloadSrc 重新将该媒体资源预加载到播放列表。如果你想清空播放列表,请调用 Stop。
如果你在播放暂停时调用该方法,该方法会在恢复播放后才生效。
参数
- src
- 播放列表中的媒体资源 URL 地址,必须与 PreloadSrc 方法设置的 src 一致,否则无法播放。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
PreloadSrc
预加载媒体资源。
public abstract int PreloadSrc(string src, Int64 startPos);
详情
你可以调用该方法将一个媒体资源预加载到播放列表中。如果需要预加载多个媒体资源,你可以多次调用该方法。
预加载成功后,如果你想播放媒体资源,请调用 PlayPreloadedSrc;如果你想清空播放列表,请调用 Stop。
SDK 不支持你预加载重复的媒体资源到播放列表,但支持你将正在播放的媒体资源再次预加载到播放列表。
参数
- src
- 媒体资源的网络路径。
- startPos
- 预加载到播放列表后,开始播放时的起始位置(毫秒)。预加载直播流时,将该参数设置为 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
RegisterAudioFrameObserver [1/2]
注册 PCM 音频帧观测器。
public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer);
详情
你需要在该方法中实现一个 IAudioPcmFrameSink 类,并根据场景需要,注册该类的回调。成功注册音频帧观测器后,SDK 会在捕捉到每个音频帧时,触发你所注册的回调。
参数
- observer
- 音频帧观测器,观测每帧音频的接收,详见 IAudioPcmFrameSink。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
RegisterAudioFrameObserver [2/2]
注册音频帧观测器。
public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer, RAW_AUDIO_FRAME_OP_MODE_TYPE mode);
参数
- observer
-
音频帧观测器,观测每帧音频的接收,详见 IAudioPcmFrameSink。
- mode
-
音频帧的使用模式,详见 RAW_AUDIO_FRAME_OP_MODE_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
RemoveAllCaches
删除媒体播放器中所有已缓存的媒体文件。
public abstract int RemoveAllCaches();
详情
该方法不会删除正在播放中的已缓存媒体文件。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
RemoveCacheByUri
删除指定的已缓存媒体文件。
public abstract int RemoveCacheByUri(string uri) ;
详情
该方法不会删除正在播放中的已缓存媒体文件。
参数
- uri
- 待删除的缓存文件的 URI(Uniform Resource Identifier),可用于标识媒体文件。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
RemoveOldCache
删除媒体播放器中近期最少使用的一个缓存媒体文件。
public abstract int RemoveOldCache();
详情
缓存媒体文件占用过多空间时,你可以调用该方法清理缓存文件。调用该方法后,SDK 会删除最少使用的一个缓存媒体文件。
当你调用此方法删除缓存媒体文件时,当前正在播放的已缓存媒体文件不会被删除。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
Resume
暂停后恢复播放。
public abstract int Resume();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
Seek
定位到媒体文件的指定播放位置。
public abstract int Seek(Int64 newPos);
详情
成功调用该方法后,你会收到 OnPlayerEvent 回调,报告当前播放器发生的事件,如定位开始、定位成功或定位失败。
- 调用该方法定位。
- 定位完成后,调用 Play 方法播放。
参数
- newPos
- 指定的位置(毫秒)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SelectAudioTrack
指定当前音频文件的播放音轨。
public abstract int SelectAudioTrack(int index);
详情
获取音频文件的音轨索引后,你可以调用该方法指定任一音轨进行播放。例如,如果一个多音轨文件的不同音轨存放了不同语言的歌曲,则你可以调用该方法设置播放语言。
参数
- index
- 音轨的索引值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SetAudioDualMonoMode
设置当前音频文件的声道模式。
public abstract int SetAudioDualMonoMode(AUDIO_DUAL_MONO_MODE mode);
详情
在双声道音频文件中,左声道和右声道可以存储不同的音频数据。根据实际需要,你可以设置声道模式为原始模式、左声道模式、右声道模式或混合模式。例如,在 KTV 场景中,音频文件的左声道存储了伴奏,右声道存储了原唱的歌声。如果你只需听伴奏,调用该方法设置音频文件的声道模式为左声道模式;如果你需要同时听伴奏和原唱,调用该方法设置声道模式为混合模式。
- 你需要在调用 Open 后调用该方法。
- 该方法仅适用于双声道的音频文件。
参数
- mode
- 声道模式。详见 AUDIO_DUAL_MONO_MODE。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
SetAudioPitch
调整当前播放的媒体资源的音调。
public abstract int SetAudioPitch(int pitch);
详情
参数
- pitch
- 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
SetCacheDir
设置待缓存的媒体文件的储存路径。
public abstract int SetCacheDir(string path) ;
详情
该方法需在初始化 IRtcEngine 之后调用。
参数
- path
- 缓存文件储存的绝对路径。请确保指定的目录存在且可写。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
SetLoopCount
设置循环播放。
public abstract int SetLoopCount(int loopCount);
详情
如果你希望循环播放,请调用该方法并设置循环播放次数。
循环播放结束时,SDK 会触发 OnPlayerSourceStateChanged 回调,向你报告播放状态为 PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED。
参数
- loopCount
- 循环播放的次数。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SetMaxCacheFileCount
设置缓存媒体文件数量的上限。
public abstract int SetMaxCacheFileCount(int count);
参数
- count
- 可缓存的媒体文件数量的上限,默认值为 1000。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
SetMaxCacheFileSize
设置缓存媒体文件的总缓存大小的上限。
public abstract int SetMaxCacheFileSize(Int64 cacheSize);
参数
- cacheSize
- 缓存媒体文件的总缓存上限,单位为字节。默认为 1 GB。
返回值
- 0:方法调用成功。
- < 0:方法调用失败,详见 MEDIA_PLAYER_ERROR。
SetPlaybackSpeed
设置当前音频文件的播放速度。
public abstract int SetPlaybackSpeed(int speed);
详情
你需要在 Open 后调用该方法。
参数
- speed
- 播放速度。推荐取值范围为 [50,400],其中:
- 50: 0.5 倍速。
- 100: 原始速度。
- 400: 4 倍速。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SetRenderMode
设置播放器视图的渲染模式。
public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode);
参数
- renderMode
-
播放器视图的渲染模式。详见 RENDER_MODE_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SetSpatialAudioParams
开启或关闭媒体播放器的空间音效。
public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params);
详情
成功设置媒体播放器的空间音效参数后,SDK 会开启媒体播放器的空间音效,即本地用户听媒体资源会有空间感。
如果需关闭媒体播放器的空间音效,你需要将 params 参数设为空。
参数
- spatial_audio_params
- 媒体播放器的空间音效参数。详见 SpatialAudioParams。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SetView
设置播放器渲染视图。
public abstract int SetView();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
Stop
停止播放。
public abstract int Stop();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
SwitchSrc
切换媒体资源。
public abstract int SwitchSrc(string src, bool syncPts = true);
详情
- 在网络较差时,将播放的媒体资源切换为较低码率的媒体资源地址。
- 在网络较好时,将播放的媒体资源切换为较高码率的媒体资源地址。
调用该方法后,如果你收到 OnPlayerEvent 回调报告事件 PLAYER_EVENT_SWITCH_COMPLETE,则媒体资源切换成功;如果你收到 OnPlayerEvent 回调报告事件 PLAYER_EVENT_SWITCH_ERROR,则媒体资源切换失败。
参数
- src
- 媒体资源的网络路径。
- syncPts
- 是否同步切换前后的起始播放位置:
true
:同步。false
:(默认) 不同步。
如果媒体资源为直播流,你只能将该参数设置为
false
,否则 SDK 切换媒体资源会失败。如果媒体资源为点播流,你可以根据场景需求对该参数赋值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
UnloadSrc
释放预加载的媒体资源。
public abstract int UnloadSrc(string src);
详情
该方法不支持释放当前播放的媒体资源。
参数
- src
- 媒体资源的网络路径。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
UnregisterAudioFrameObserver
取消注册音频帧观测器。
public abstract int UnregisterAudioFrameObserver();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
OnAudioVolumeIndication
媒体播放器音量提示回调。
public virtual void OnAudioVolumeIndication(int volume) {}
SDK 每 200 毫秒触发一次该回调,报告媒体播放器当前的音量。
参数
- volume
- 播放器的当前音量,取值范围为 [0,255]。
OnMetaData
报告已获取媒体附属信息。
public virtual void OnMetaData(byte[] data, int length) { }
解析媒体附属信息后时,SDK 会触发该回调,报告媒体附属信息的数据类型和具体数据。
参数
- data
- 具体数据,用户自定义格式的数据。
- length
- 数据长度,单位为 byte。
OnPlayBufferUpdated
报告当前缓冲数据能播放的时间。
public virtual void OnPlayBufferUpdated(Int64 playCachedBuffer) { }
- 当缓冲数据支持的播放时间小于阈值(默认为 0)时,返回 PLAYER_EVENT_BUFFER_LOW。
- 当缓冲数据支持的播放时间大于阈值(默认为 0)时,返回 PLAYER_EVENT_BUFFER_RECOVER。
参数
- playCachedBuffer
- 当前缓冲的数据能支持的播放时间 (毫秒)。
OnPlayerEvent
报告播放器的事件。
public virtual void OnPlayerEvent(MEDIA_PLAYER_EVENT eventCode, Int64 elapsedTime, string message) { }
- 调用 Seek 定位播放后,SDK 会触发该回调,报告定位播放的结果。
参数
- eventCode
- 播放器事件,详见 MEDIA_PLAYER_EVENT。
- elapsedTime
- 发生事件的时间 (毫秒)。
- message
- 事件的信息。
OnPlayerInfoUpdated
媒体播放器相关信息发生改变回调。
public virtual void OnPlayerInfoUpdated(PlayerUpdatedInfo info) { }
当媒体播放器相关信息发生改变时,SDK 会触发该回调。你可用其进行问题定位和排查。
参数
- info
- 媒体播放器相关信息。详见 PlayerUpdatedInfo。
OnPlayerSourceStateChanged
报告播放器状态改变。
public virtual void OnPlayerSourceStateChanged(MEDIA_PLAYER_STATE state, MEDIA_PLAYER_ERROR ec) { }
当播放器状态改变时,SDK 会触发该回调,报告新的播放状态。
参数
- state
- 新的播放状态,详见 MEDIA_PLAYER_STATE。
- ec
- 播放器错误码,详见 MEDIA_PLAYER_ERROR。
OnPlayerSrcInfoChanged
OnPositionChanged
报告当前播放进度。
public virtual void OnPositionChanged(Int64 position_ms) { }
播放媒体文件时,SDK 每隔 1 秒会自动触发该回调,报告当前播放进度。
参数
- position_ms
- 当前播放进度,单位为 ms。
OnPreloadEvent
报告预加载媒体资源的事件。
public virtual void OnPreloadEvent(string src, PLAYER_PRELOAD_EVENT @event) { }
参数
- src
- 媒体资源的路径。
- @event
- 预加载媒体资源时发生的事件。详见 PLAYER_PRELOAD_EVENT。
OnReadData
读取媒体资源数据回调。
public virtual int OnReadData(IntPtr bufferPtr, int bufferSize)
{
return 0;
}
参数
- bufferPtr
- 输入参数,数据 Buffer,单位为字节。请将 SDK 报告的 bufferSize 数据写入到此参数中。
- bufferSize
- 数据 Buffer 的长度,单位为字节。
返回值
- 如果读取数据成功,请在返回值中传入你实际读取的数据长度,单位为字节。
- 如果读取数据失败,请在返回值中传入 0。
OnSeek
定位媒体资源数据回调。
public virtual Int64 OnSeek(Int64 offset, int whence)
{
return 0;
}
参数
- offset
- 输入参数。定位位置相对于起点的偏移量,单位为字节。取值可正可负。
- whence
- 输入参数。表示定位的起点位置。可以为如下值:
- 0:起点为数据的头,定位后的实际数据偏移量为 offset。
- 1:起点为当前位置,定位后的实际数据偏移量为当前位置加上 offset。
- 2:起点为数据的尾,定位后的实际数据偏移量为文件长度加上 offset。
- 65536:不执行定位操作,返回文件大小。建议在播放 MP3、WAV 等纯音频文件时使用该参数值。
返回值
- 当 whence 为 65536 时,返回媒体文件大小。
- 当 whence 为 0/1/2 时,返回实际定位后的数据偏移量。
- -1:定位失败。