# URL 拉流播放 (/zh-CN/api-reference/rtc/android/play/rte-player)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## abrSubscriptionLayer [#abrsubscriptionlayer]
获取当前订阅的视频层级。
```java
public Constants.AbrSubscriptionLayer abrSubscriptionLayer()
```
该方法仅在打开 RTE URL 时有效。
### 返回值 [#返回值]
方法调用成功,返回 [AbrSubscriptionLayer](/zh-CN/api-reference/rtc/android/enum-rteabrsubscriptionlayer) 对象。
### 所属接口类 [#所属接口类]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## addView [#addview]
添加一个渲染视图。
```java
public void addView(View view, ViewConfig viewConfig) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
当你需要使用播放器播放视频时,可以调用该方法将视图添加到视频渲染器中,以显示视频内容。
:::note
注: 当前仅支持一个视图。
:::
### 适用场景 [#适用场景]
当你需要使用播放器播放视频时,可以调用此方法将视图添加到视频渲染器中,以显示视频内容。
### 调用时机 [#调用时机]
必须在调用 [setCanvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_setcanvas) 之前调用该方法。
### 参数 [#参数]
`SurfaceView` 对象。
视图的相关设置。
### 异常 [#异常]
添加渲染视图失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-1]
- [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)
## audioBitsPerSample [#audiobitspersample]
获取每个音频采样点的位数。
```java
public int audioBitsPerSample()
```
:::info[自从]
自 v4.5.1 版本新增。
:::
:::note
注: [audioBitsPerSample](/zh-CN/api-reference/rtc/android/play/rte-player#api_rteplayerinfo_audiobitspersample) 仅在打开非 RTM URL 时有效。
:::
### 返回值 [#返回值-1]
方法调用成功,返回每个音频采样点的位数,单位为 bit。
### 所属接口类 [#所属接口类-2]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## audioChannels [#audiochannels]
获取音频通道数。
```java
public int audioChannels()
```
### 返回值 [#返回值-2]
方法调用成功,返回音频通道数。
### 所属接口类 [#所属接口类-3]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## audioSampleRate [#audiosamplerate]
获取音频采样率。
```java
public int audioSampleRate()
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 返回值 [#返回值-3]
方法调用成功,返回音频采样率,单位为 Hz。
### 所属接口类 [#所属接口类-4]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## Canvas [#canvas]
构造一个 [Canvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_canvas_canvas) 对象。
```java
public Canvas(Rte rte, CanvasInitialConfig config)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 参数 [#参数-1]
用于构造 [Canvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_canvas_canvas) 的 [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte) 对象,详见 [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)。
初始化配置对象。你可以传入 `null`。
### 所属接口类 [#所属接口类-5]
- [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)
## code [#code]
获取 API 调用失败时返回的错误码。
```java
public Constants.ErrorCode code()
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-1]
你可以在 API 调用失败时调用此方法获取错误码。
### 返回值 [#返回值-4]
- 方法调用失败时,返回错误码。详见 [ErrorCode](/zh-CN/api-reference/rtc/android/enum-rteerrorcode)。
### 所属接口类 [#所属接口类-6]
- [Error](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_error)
## currentUrl [#currenturl]
获取当前正在播放的 URL。
```java
public String currentUrl()
```
### 返回值 [#返回值-5]
方法调用成功时,返回当前正在播放的 URL。
方法调用失败,返回空字符串。
### 所属接口类 [#所属接口类-7]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## destroy [#destroy]
销毁 `RTE` 对象,释放相关资源。
```java
public synchronized void destroy() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 异常 [#异常-1]
销毁失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-8]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## duration [#duration]
获取当前媒体资源的时长。
```java
public long duration()
```
:::info[自从]
自 v4.5.1 版本新增。
:::
:::note
注: 该方法仅在播放本地媒体文件或输入在线媒体流时有效。
:::
### 返回值 [#返回值-6]
方法调用成功,返回当前媒体资源的时长,单位为毫秒。
### 所属接口类 [#所属接口类-9]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## errorCode [#errorcode]
获取 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 中携带的错误码。
```java
public Constants.ErrorCode errorCode()
```
### 返回值 [#返回值-7]
方法调用成功,返回 [ErrorCode](/zh-CN/api-reference/rtc/android/enum-rteerrorcode) 对象。
### 所属接口类 [#所属接口类-10]
- [RteException](/zh-CN/api-reference/rtc/android/class-rteexception)
## getAbrFallbackLayer [#getabrfallbacklayer]
获取已配置的视频流回退选项。
```java
public Constants.AbrFallbackLayer getAbrFallbackLayer() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-2]
你必须在调用 `getConfigs` 之后调用此方法。
### 异常 [#异常-2]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-8]
方法调用成功,返回已配置的视频流回退选项。详见 [AbrFallbackLayer](/zh-CN/api-reference/rtc/android/enum-rteabrfallbacklayer)。
### 所属接口类 [#所属接口类-11]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getAbrSubscriptionLayer [#getabrsubscriptionlayer]
获取已订阅视频流的质量层级。
```java
public Constants.AbrSubscriptionLayer getAbrSubscriptionLayer() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-3]
你需要在调用 `getConfigs` 方法之后调用此方法。
### 异常 [#异常-3]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 返回值 [#返回值-9]
方法调用成功,返回当前设置的视频质量层级。详见 [AbrSubscriptionLayer](/zh-CN/api-reference/rtc/android/enum-rteabrsubscriptionlayer)。
### 所属接口类 [#所属接口类-12]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getAppId [#getappid]
获取已设置的 App ID。
```java
public String getAppId() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 返回值 [#返回值-10]
方法调用成功时,返回已设置的 App ID。
方法调用失败,返回空字符串。
### 所属接口类 [#所属接口类-13]
- [Config](/zh-CN/api-reference/rtc/android/class-config)
## getAutoPlay [#getautoplay]
获取媒体播放器的自动播放设置。
```java
public boolean getAutoPlay() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-4]
此方法必须在调用 `getConfigs` 之后调用。
### 异常 [#异常-4]
获取自动播放设置失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-11]
- true:获取成功。
- false:获取失败。
### 所属接口类 [#所属接口类-14]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getConfigs [3/3] [#getconfigs-33]
获取播放器当前的视频渲染配置。
```java
public void getConfigs(CanvasConfig config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-5]
你必须在调用 [Canvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_canvas_canvas) 之后调用此方法。
### 参数 [#参数-2]
[Canvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_canvas_canvas) 对象的设置,详见 [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)。
### 异常 [#异常-5]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception)。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-15]
- [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)
## getConfigs [2/3] [#getconfigs-23]
获取当前媒体播放器的配置选项。
```java
public void getConfigs(PlayerConfig config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-6]
该方法必须在调用 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后使用。
### 参数 [#参数-3]
媒体播放器配置对象,详见 [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)。
### 异常 [#异常-6]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-16]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## getConfigs [1/3] [#getconfigs-13]
获取 [Rte](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_rte_rte) 对象的配置信息。
```java
public void getConfigs(Config config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-7]
该方法必须在调用 [Rte](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_rte_rte) 之后使用。
### 参数 [#参数-4]
详见 [Config](/zh-CN/api-reference/rtc/android/class-config)。
### 异常 [#异常-7]
如果方法调用失败,SDK 会抛出 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 并返回相应的错误信息。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-17]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## getFromBridge [#getfrombridge]
从 [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) 中桥接一个 `RTE` 对象。
```java
public static synchronized Rte getFromBridge() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
通过该方法创建的 `RTE` 对象无需通过 [initMediaEngine](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_initmediaengine) 进行初始化。如果你尚未创建并初始化 `RTC` 引擎,可以先调用 `RTE` 创建一个 `RTE` 对象,再调用 [initMediaEngine](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_initmediaengine) 进行初始化。
### 调用时机 [#调用时机-8]
调用此方法前,请确保已调用 [create [2/2]](/zh-CN/api-reference/rtc/android/initialize#api_irtcengine_initialize) 初始化 `RTC` 引擎。
### 异常 [#异常-8]
如果方法调用失败,SDK 会抛出 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 并返回相应的错误信息。你需要捕获并处理该异常。
### 返回值 [#返回值-12]
方法调用成功,返回 `RTE` 对象。
### 所属接口类 [#所属接口类-18]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## getInfo [#getinfo]
检索与播放器和媒体流相关的信息。
```java
public void getInfo(PlayerInfo info) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-9]
该方法必须在调用 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后使用。
### 参数 [#参数-5]
与播放器和媒体流相关的信息,详见 [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)。
### 异常 [#异常-9]
如果该方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-19]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## getJsonParameter [#getjsonparameter]
获取当前设置的 JSON 格式的私有参数集。
```java
public String getJsonParameter() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 异常 [#异常-10]
调用失败,SDK 会抛出 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常,你需要捕获异常并进行处理。
### 返回值 [#返回值-13]
方法调用成功时,返回已设置的 JSON 格式的参数集。
方法调用失败,返回空字符串。
### 所属接口类 [#所属接口类-20]
- [Config](/zh-CN/api-reference/rtc/android/class-config)
## getLoopCount [#getloopcount]
获取媒体文件的循环播放次数。
```java
public int getLoopCount() throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 异常 [#异常-11]
获取失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-14]
方法调用成功,返回媒体文件的循环播放次数。
### 所属接口类 [#所属接口类-21]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getVideoMirrorMode [#getvideomirrormode]
获取视频镜像模式。
```java
public Constants.VideoMirrorMode getVideoMirrorMode() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 异常 [#异常-12]
获取视频镜像模式失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-15]
方法调用成功,返回视频镜像模式,详见 [VideoMirrorMode](/zh-CN/api-reference/rtc/android/enum-rtevideomirrormode)。
### 所属接口类 [#所属接口类-22]
- [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)
## getPlaybackSpeed [#getplaybackspeed]
获取播放速度参数。
```java
public int getPlaybackSpeed() throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 异常 [#异常-13]
获取播放速度失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-16]
方法调用成功,返回播放速度的值。
### 所属接口类 [#所属接口类-23]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getPlayoutVolume [#getplayoutvolume]
获取媒体播放器的播放音量。
```java
public int getPlayoutVolume() throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 返回值 [#返回值-17]
方法调用成功,返回媒体播放器的播放音量级别。
### 所属接口类 [#所属接口类-24]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## getPosition [#getposition]
获取当前的播放位置。
```java
public long getPosition() throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 异常 [#异常-14]
如果方法调用失败,SDK 会抛出一个 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-18]
方法调用成功,返回当前的播放位置,单位为毫秒。
### 所属接口类 [#所属接口类-25]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## getVideoRenderMode [#getvideorendermode]
获取当前设置的视频镜像模式。
```java
public Constants.VideoRenderMode getVideoRenderMode() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-10]
你需要在调用 `getConfigs` 之后调用此方法。
### 异常 [#异常-15]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 返回值 [#返回值-19]
方法调用成功,返回当前设置的视频镜像模式。详见 [VideoMirrorMode](/zh-CN/api-reference/rtc/android/enum-rtevideomirrormode)。
### 所属接口类 [#所属接口类-26]
- [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)
## getStats [#getstats]
获取播放器当前播放媒体资源的统计信息。
```java
public void getStats(PlayerGetStatsCallback callback)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
该方法通过回调异步返回播放器的统计信息。
### 调用时机 [#调用时机-11]
该方法必须在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之后调用。
### 参数 [#参数-6]
用于异步接收统计信息和错误信息的回调接口。详见 [PlayerGetStatsCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playergetstatscallback)。
### 所属接口类 [#所属接口类-27]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## hasAudio [#hasaudio]
判断媒体资源是否包含音频流。
```java
public boolean hasAudio()
```
### 返回值 [#返回值-20]
- true:媒体资源中包含音频流。
- false:媒体资源中不包含音频流。
### 所属接口类 [#所属接口类-28]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## hasVideo [#hasvideo]
判断是否包含视频流。
```java
public boolean hasVideo()
```
### 返回值 [#返回值-21]
true:URL 源包含视频流。
false:URL 源不包含视频流。
### 所属接口类 [#所属接口类-29]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## initMediaEngine [#initmediaengine]
初始化 `RTE` 引擎。
```java
public void initMediaEngine(AsyncCallback callBack) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
该方法为异步方法,通过回调函数返回初始化结果。你需要在创建 `RTE` 对象并设置 App ID 后调用该方法。
### 参数 [#参数-7]
异步返回引擎初始化结果的回调。详见 [AsyncCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_asynccallback)。
### 异常 [#异常-16]
初始化失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-30]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## isAudioMuted [#isaudiomuted]
判断播放器是否停止接收远端音频流。
```java
public boolean isAudioMuted()
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 返回值 [#返回值-22]
- true:播放器已停止接收远端音频流。
- false:播放器仍在接收远端音频流。
### 所属接口类 [#所属接口类-31]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## isVideoMuted [#isvideomuted]
判断播放器是否停止接收远端视频流。
```java
public boolean isVideoMuted()
```
:::info[自从]
自 v4.4.0 版本新增。
:::
:::note
注: [isVideoMuted](/zh-CN/api-reference/rtc/android/play/rte-player#api_rteplayerinfo_isvideomuted) 接口仅在打开 RTE URL 时有效。
:::
### 返回值 [#返回值-23]
- true:播放器已停止接收远端视频流。
- false:播放器仍在接收远端视频流。
### 所属接口类 [#所属接口类-32]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## message [#message]
获取详细的错误信息。
```java
public String message()
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-12]
当 API 调用失败时,可以调用该方法获取错误信息,以帮助排查问题。
### 返回值 [#返回值-24]
- 方法调用成功时,返回错误信息字符串。
- 方法调用失败,返回空字符串。
### 所属接口类 [#所属接口类-33]
- [Error](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_error)
## muteAudio [#muteaudio]
开始或停止接收音频流。
```java
public void muteAudio(boolean mute) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-13]
该方法需要在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 方法之后调用。
### 相关回调 [#相关回调]
调用该方法成功后,会触发 [onPlayerInfoUpdated](/zh-CN/api-reference/rtc/android/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayerinfoupdated) 回调,上报最新的播放器和媒体拉流信息。
### 参数 [#参数-8]
是否接收音频流:
- true:不接收音频流。
- false:接收音频流。
### 异常 [#异常-17]
方法调用失败时,SDK 会抛出包含错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-34]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## muteVideo [#mutevideo]
开始或停止接收远端视频流。
```java
public void muteVideo(boolean mute) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-14]
你必须在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之后调用该方法。
### 相关回调 [#相关回调-1]
该方法调用成功后,会触发 [onPlayerInfoUpdated](/zh-CN/api-reference/rtc/android/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayerinfoupdated) 回调,用于上报最新的播放器和媒体流信息。
### 参数 [#参数-9]
是否接收远端视频流:
- true:不接收远端视频流。
- false:接收远端视频流。
### 异常 [#异常-18]
如果方法调用失败,SDK 会抛出带有相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-35]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## openWithUrl [#openwithurl]
打开一个 URL 资源。
```java
public void openWithUrl(String url, long startTime, AsyncCallback callback)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
该方法支持通过 URL 打开实时流媒体资源。如果你希望加快打开速度,可以在调用该方法前使用 [preloadWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_preloadwithurl) 预加载资源。
如果资源打开失败,你会收到 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调,播放器状态为 `FAILED`。此时需要先调用 [stop](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_stop_player),然后再次调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 重新打开资源。
如果你关闭了自动播放功能,可以在资源打开后调用 [play](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_play_player) 开始播放。
:::note
注: 该方法目前仅支持以 `rte://` 开头的 URL、CDN 推流 URL 和本地媒体文件。
:::
### 调用时机 [#调用时机-15]
该方法必须在 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后调用。
### 相关回调 [#相关回调-2]
调用该方法后会触发 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调,播放器状态为 `OPENING`,表示正在打开 URL。成功打开后,播放器状态为 `OPEN_COMPLETED`。
### 参数 [#参数-10]
要打开的 URL,可以是 CDN 推流 URL、本地媒体文件,或以 `rte://` 为前缀的 URL。
播放的起始位置,单位为毫秒。
异步通知打开 URL 资源结果的回调。你可以通过该回调的 [onResult](/zh-CN/api-reference/rtc/android/play/rte-player#callback_asynccallback_onresult_asynccallback) 方法获取错误信息。
### 所属接口类 [#所属接口类-36]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## pause [#pause]
暂停播放。
```java
public void pause() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
调用 [play](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_play_player) 播放 URL 资源后,如需暂停播放,可以调用该方法。如需停止播放,请调用 [stop](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_stop_player)。
### 调用时机 [#调用时机-16]
该方法必须在调用 [play](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_play_player) 之后调用。
### 相关回调 [#相关回调-3]
成功调用该方法后,会触发 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调,报告播放器状态为 `PAUSED`。
### 异常 [#异常-19]
如果该方法调用失败,SDK 会抛出带有相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-37]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## play [#play]
播放一个 URL 资源。
```java
public void play() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
如果你已关闭自动播放,在使用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 成功打开一个在线媒体流后,可以调用该方法开始播放。
:::note
注: 该方法当前仅支持以 `rte://` 为前缀的 URL。
:::
### 调用时机 [#调用时机-17]
仅在收到状态为 `OPEN_COMPLETED` 的 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调后调用该方法。
### 相关回调 [#相关回调-4]
调用该方法成功后,会触发 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调以上报播放器状态。
### 异常 [#异常-20]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-38]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## Player [#player]
构造一个 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 播放器对象。
```java
public Player(Rte rte, PlayerInitialConfig initialConfig)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-18]
该方法必须在调用 [initMediaEngine](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_initmediaengine) 之后调用。
### 参数 [#参数-11]
一个 [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte) 对象。详见 [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)。
播放器对象的初始化设置。你可以传入 `null`。
### 所属接口类 [#所属接口类-39]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## preloadWithUrl [#preloadwithurl]
预加载 URL 资源。
```java
public static void preloadWithUrl(String url) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
成功预加载资源可以加快使用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 打开 URL 资源的速度,从而减少等待时间。
:::note
注: 该方法目前仅适用于以 `rte://` 为前缀的 URL。最多可预加载 20 个 URL,若超过限制,新预加载的 URL 会替换最早的 URL。
:::
### 适用场景 [#适用场景-1]
在打开媒体资源前预加载,可以减少用户等待时间,提供更流畅的视听体验。
### 调用时机 [#调用时机-19]
必须在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之前调用该方法。
### 参数 [#参数-12]
以 `rte://` 为前缀的 URL。各字段的详细信息参见观众端的“输入在线媒体流”。
### 异常 [#异常-21]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception)。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-40]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## registerObserver [#registerobserver]
注册播放器的观察者对象。
```java
public void registerObserver(PlayerObserver observer) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
在调用此方法之前,你需要实现一个继承自 [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver) 的接口类。
### 调用时机 [#调用时机-20]
该方法必须在调用 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后执行。
### 参数 [#参数-13]
详见 [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)。
### 异常 [#异常-22]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-41]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## removeView [#removeview]
移除一个渲染视图。
```java
public void removeView(View view, ViewConfig viewConfig) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
:::note
注: 每次只能移除一个视图。
:::
### 调用时机 [#调用时机-21]
该方法必须在调用 [addView](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_addview) 之后调用。
### 参数 [#参数-14]
要移除的视图对象。
`view` 对象的设置。
### 返回值 [#返回值-25]
调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-42]
- [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)
## Rte [#rte]
构造一个 [Rte](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_rte_rte) 对象。
```java
public Rte(InitialConfig initialConfig)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-22]
你必须在调用 [initMediaEngine](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_initmediaengine) 之前调用此方法。
### 参数 [#参数-15]
初始化设置。你可以传入 `null`。
### 所属接口类 [#所属接口类-43]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## seek [#seek]
跳转到指定的播放位置。
```java
public void seek(long newTime) throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 参数 [#参数-16]
要跳转到的播放位置,单位为毫秒。
### 异常 [#异常-23]
如果方法调用失败,SDK 会抛出一个 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-44]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## setAbrFallbackLayer [#setabrfallbacklayer]
设置已订阅远端视频流的回退选项。
```java
public void setAbrFallbackLayer(Constants.AbrFallbackLayer fallbackLayer) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
在网络状况不佳时,SDK 会将已订阅远端视频流的分辨率降级到指定的视频质量层。每个质量层对应特定的分辨率和码率。网络恢复后,SDK 会将视频流恢复至原始质量层。
:::note
注: 如果未开启 ABR 功能,视频流的回退质量层只能设置为 `LOW` 或 `AUDIO_ONLY`。
:::
### 适用场景 [#适用场景-2]
一般场景下,可调用该方法并将回退质量层设置为 `kRteAbrFallbackLow` 或 `kRteAbrFallbackAudioOnly`。当网络较差时,SDK 会回退为视频小流或仅接收音频流。
如果对回退视频流的分辨率有更高要求,可[联系技术支持](https://ticket.shengwang.cn/)开启 ABR 功能。开启后,可自定义每一层的分辨率。SDK 会以你指定的最低质量层的分辨率为下限,并根据网络状况在该范围内动态调整分辨率。
### 调用时机 [#调用时机-23]
必须在调用 `setConfigs` 之前调用该方法。
### 参数 [#参数-17]
视频流的回退质量层,详见 [AbrFallbackLayer](/zh-CN/api-reference/rtc/android/enum-rteabrfallbacklayer)。
:::note
注: 自定义分辨率时,请确保视频质量层按从高到低的分辨率排序;若分辨率相同,则按帧率从高到低排序。
| 视频质量层 | 分辨率 |
| --- | --- |
| `LAYER1` | 2160p (4K) |
| `LAYER2` | 1440p (2K) |
| `LAYER3` | 1080p (HD) |
| `LAYER4` | 720p (HD) |
| `LAYER5` | 540p (SD) |
| `LAYER6` | 480p (SD) |
:::
### 异常 [#异常-24]
调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-45]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setAbrSubscriptionLayer [#setabrsubscriptionlayer]
设置订阅媒体流的视频质量等级。
```java
public void setAbrSubscriptionLayer(Constants.AbrSubscriptionLayer subscriptionLayer) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你可以根据实际网络状况,在所订阅的视频流中切换不同的视频质量等级。如果你需要更高级的视频分辨率切换控制,可以[联系技术支持](https://ticket.shengwang.cn/)开启 ABR(自适应码率)功能。开启后,你可以为每个视频质量等级自定义分辨率,使观众可以根据需要在多质量层级视频流的所有等级之间切换。
:::note
注: 如果未开启 ABR 功能,你只能订阅 `HIGH` 或 `LOW` 视频质量等级。
:::
### 适用场景 [#适用场景-3]
在网络环境不稳定的场景中,订阅端可根据实际网络状况选择合适的视频质量层级,以保障流畅的观看体验。
### 调用时机 [#调用时机-24]
该方法必须在调用 `setConfigs` 之前调用。
### 参数 [#参数-18]
要订阅的视频质量等级,详见 [AbrSubscriptionLayer](/zh-CN/api-reference/rtc/android/enum-rteabrsubscriptionlayer)。在自定义 `LAYER1` 到 `LAYER6` 的分辨率时,你可以参考下表,或根据实际需求进行配置:
注意:自定义分辨率时,必须按分辨率从高到低排序各视频质量等级(Layer),若分辨率相同,则按帧率从高到低排序。
| 视频质量等级 | 分辨率 |
| --- | --- |
| `LAYER1` | 2160p (4K) |
| `LAYER2` | 1440p (2K) |
| `LAYER3` | 1080p (HD) |
| `LAYER4` | 720p (HD) |
| `LAYER5` | 540p (SD) |
| `LAYER6` | 480p (SD) |
### 异常 [#异常-25]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 异常。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-46]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setAppId [#setappid]
设置项目的声网 App ID。
```java
public void setAppId(String appId) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-25]
你必须在调用 [initMediaEngine](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_initmediaengine) 之前调用此方法。
### 参数 [#参数-19]
声网 App ID,可从控制台获取。
### 异常 [#异常-26]
调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-47]
- [Config](/zh-CN/api-reference/rtc/android/class-config)
## setAutoPlay [#setautoplay]
设置是否启用自动播放。
```java
public void setAutoPlay(boolean autoPlay) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你可以在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之前调用此方法设置是否启用自动播放。如果未设置,默认启用自动播放。
### 调用时机 [#调用时机-26]
此方法必须在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之前调用。
### 参数 [#参数-20]
是否启用自动播放:
- true:(默认)启用自动播放。
- false:关闭自动播放。
### 异常 [#异常-27]
设置失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-48]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setCanvas [#setcanvas]
设置用于显示视频的视图窗口。
```java
public void setCanvas(Canvas canvas) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
该方法用于设置用于显示视频的 [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas) 对象。
### 调用时机 [#调用时机-27]
该方法必须在调用 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后调用。
### 参数 [#参数-21]
用于渲染视频帧的对象,详见 [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)。
### 异常 [#异常-28]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-49]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## setConfigs [3/3] [#setconfigs-33]
设置播放器的视频渲染配置。
```java
public void setConfigs(CanvasConfig config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-28]
该方法需要在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之前调用。
### 参数 [#参数-22]
用于设置 [Canvas](/zh-CN/api-reference/rtc/android/play/rte-player#api_canvas_canvas_canvas) 对象的配置,详见 [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)。
### 异常 [#异常-29]
调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-50]
- [Canvas](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvas)
## setConfigs [2/3] [#setconfigs-23]
设置播放器配置。
```java
public void setConfigs(PlayerConfig config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你可以调用此方法配置播放器,例如启用自动播放、订阅不同分辨率和码率的视频流。
### 调用时机 [#调用时机-29]
此方法必须在调用 [Player](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_player_player) 之后调用。
### 参数 [#参数-23]
播放器配置对象,详见 [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)。
### 异常 [#异常-30]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception)。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-51]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## setConfigs [1/3] [#setconfigs-13]
配置 `RTE` 对象的信息。
```java
public void setConfigs(Config config) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 调用时机 [#调用时机-30]
该方法必须在调用 [Rte](/zh-CN/api-reference/rtc/android/play/rte-player#api_rte_rte_rte) 之后调用。
### 参数 [#参数-24]
用于设置 `RTE` 对象的配置信息,详见 [Config](/zh-CN/api-reference/rtc/android/class-config)。
### 异常 [#异常-31]
如果方法调用失败,SDK 会抛出 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception) 并返回相应的错误信息。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-52]
- [Rte](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rte)
## setJsonParameter [#setjsonparameter]
通过 JSON 配置 SDK 的技术预览或定制化功能。
```java
public void setJsonParameter(String jsonParameter) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 适用场景 [#适用场景-4]
当你需要设置私有参数或使用定制化功能时,可以调用此方法。
### 调用时机 [#调用时机-31]
此方法必须在调用 `setConfigs` 之前调用。
### 参数 [#参数-25]
JSON 字符串格式的参数。
### 异常 [#异常-32]
如果方法调用失败,SDK 会抛出包含相应错误信息的 [RteException](/zh-CN/api-reference/rtc/android/class-rteexception)。你需要捕获并处理该异常。
### 所属接口类 [#所属接口类-53]
- [Config](/zh-CN/api-reference/rtc/android/class-config)
## setLoopCount [#setloopcount]
设置媒体文件在播放期间循环播放的次数。
```java
public void setLoopCount(int count) throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 参数 [#参数-26]
媒体文件循环播放的次数:
- `1`:播放一次。
- `2`:播放两次。
- `-1`:无限循环播放,直到调用 [stop](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_stop_player) 停止播放。
### 异常 [#异常-33]
设置失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-54]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setVideoMirrorMode [#setvideomirrormode]
设置视频镜像模式。
```java
public void setVideoMirrorMode(Constants.VideoMirrorMode mode) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你必须在调用 `setConfigs` 方法之前调用此方法。
### 调用时机 [#调用时机-32]
你必须在调用 `setConfigs` 之前调用此方法。
### 参数 [#参数-27]
镜像模式,详见 [VideoMirrorMode](/zh-CN/api-reference/rtc/android/enum-rtevideomirrormode)。默认值为 `AUTO`,由 SDK 自动决定镜像模式。
### 异常 [#异常-34]
方法调用失败时,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-55]
- [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)
## setPlaybackSpeed [#setplaybackspeed]
设置播放速度参数。
```java
public void setPlaybackSpeed(int speed) throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
你可以在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 后调用该方法。
### 参数 [#参数-28]
播放速度。有效范围为 [50, 400]。
### 异常 [#异常-35]
设置播放速度失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-56]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setPlayoutVolume [#setplayoutvolume]
设置播放音量参数。
```java
public void setPlayoutVolume(int volume) throws RteException
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 参数 [#参数-29]
播放器的音量值。有效范围为 [0, 400]。
### 异常 [#异常-36]
设置播放音量失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-57]
- [PlayerConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerconfig)
## setVideoRenderMode [#setvideorendermode]
设置视频渲染模式。
```java
public void setVideoRenderMode(Constants.VideoRenderMode mode) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 参数 [#参数-30]
要设置的视频渲染模式,详见 [VideoRenderMode](/zh-CN/api-reference/rtc/android/enum-rtevideorendermode)。
:::note
注: 默认值为 `VideoRenderMode.HIDDEN`。
:::
### 异常 [#异常-37]
[RteException](/zh-CN/api-reference/rtc/android/class-rteexception):`RteException.errorCode()` 可能返回以下错误码:
- `ErrorCode.INVALID_ARGUMENT`:`mode` 参数设置为非法值。
### 所属接口类 [#所属接口类-58]
- [CanvasConfig](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_canvasconfig)
## state [#state]
获取当前播放器状态。
```java
public int state()
```
### 返回值 [#返回值-26]
方法调用成功,返回当前播放器的状态。
### 所属接口类 [#所属接口类-59]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## stop [#stop]
停止播放媒体资源。
```java
public void stop() throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
如果使用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 打开 URL 流失败,你需要先调用该方法,然后再调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 重新打开 URL。
### 调用时机 [#调用时机-33]
该方法必须在调用 [openWithUrl](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_openwithurl) 之后调用。
### 相关回调 [#相关回调-5]
调用成功后,该方法会触发 [onStateChanged](/zh-CN/api-reference/rtc/android/play/rte-player#callback_playerobserver_onstatechanged) 回调,并上报播放器状态为 `STOPPED`。
### 异常 [#异常-38]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-60]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## streamCount [#streamcount]
获取当前播放源中的流的数量。
```java
public int streamCount()
```
该方法仅在打开非 RTE URL 时有效。
### 返回值 [#返回值-27]
方法调用成功,返回流的数量。
### 所属接口类 [#所属接口类-61]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## switchWithUrl [#switchwithurl]
在播放过程中切换到新的 URL。
```java
public void switchWithUrl(String url, boolean syncPts, AsyncCallback callback)
```
:::info[自从]
自 v4.5.1 版本新增。
:::
当 SDK 返回播放器状态为 `OPEN_COMPLETED` 时,必须调用该方法。
:::note
注: 该方法仅在播放器打开非 RTE URL 时有效。
:::
### 参数 [#参数-31]
要切换的 URL 资源。
- true:同步播放位置。
- false:(默认)不同步播放位置。
异步通知切换操作结果的回调。你可以通过该回调的 `err` 参数得知操作的结果或错误码信息,详见 [AsyncCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_asynccallback)。
### 所属接口类 [#所属接口类-62]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## unregisterObserver [#unregisterobserver]
取消注册媒体播放器事件观察者对象。
```java
public void unregisterObserver(PlayerObserver observer) throws RteException
```
:::info[自从]
自 v4.4.0 版本新增。
:::
调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册媒体播放器事件观察者对象后,如需取消注册,请调用该方法。
### 调用时机 [#调用时机-34]
该方法必须在调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 之后调用。
### 参数 [#参数-32]
详见 [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)。
### 异常 [#异常-39]
如果方法调用失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。
### 所属接口类 [#所属接口类-63]
- [Player](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_player)
## videoHeight [#videoheight]
获取视频分辨率的高度。
```java
public int videoHeight()
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 返回值 [#返回值-28]
方法调用成功,返回视频分辨率的高度,单位为像素。
### 所属接口类 [#所属接口类-64]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## videoWidth [#videowidth]
获取视频分辨率的宽度。
```java
public int videoWidth()
```
:::info[自从]
自 v4.5.1 版本新增。
:::
### 返回值 [#返回值-29]
方法调用成功,返回视频分辨率的宽度,单位为像素。
### 所属接口类 [#所属接口类-65]
- [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)
## onAudioVolumeIndication [#onaudiovolumeindication]
播放器音量变化回调。
```java
public void onAudioVolumeIndication(int volume)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 触发时机 [#触发时机]
该回调在播放器音量发生变化时被触发。
### 参数 [#参数-33]
播放器当前的音量,取值范围为 [0, 225]。
### 所属接口类 [#所属接口类-66]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onEvent [#onevent]
播放器事件回调。
```java
public void onEvent(int event)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
如果你需要监听播放器事件,必须先调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册播放器观察者对象。
### 触发时机 [#触发时机-1]
该回调在播放器事件发生变化时被触发。
### 参数 [#参数-34]
播放器事件。
:::note
注: 详见 [PlayerEvent](/zh-CN/api-reference/rtc/android/enum-rteplayerevent)。
:::
### 所属接口类 [#所属接口类-67]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onMetadata [2/2] [#onmetadata-22]
接收媒体流附加信息的回调。
```java
public void onMetadata(int type, byte[] data)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册播放器观察者对象后,才能接收媒体流中的附加信息。
### 触发时机 [#触发时机-2]
该回调在 SDK 解析播放器正在播放的媒体流中的附加信息后触发,报告数据类型及其具体内容。
### 参数 [#参数-35]
附加信息的类型:
- 0:SEI(Supplemental Enhancement Information)类型。
解析后的附加信息。
### 所属接口类 [#所属接口类-68]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onPlayerInfoUpdated [2/2] [#onplayerinfoupdated-22]
播放器和媒体流信息发生变化回调。
```java
public void onPlayerInfoUpdated(PlayerInfo info)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你可以调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册播放器观察者对象来获取播放器和媒体流的信息,也可以直接调用 [getInfo](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_getinfo) 方法获取信息。
### 触发时机 [#触发时机-3]
该回调在播放器和媒体流信息发生变化时被触发。
### 参数 [#参数-36]
播放器及媒体流的相关信息,详见 [PlayerInfo](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_rteplayerinfo)。
### 所属接口类 [#所属接口类-69]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onPositionChanged [#onpositionchanged]
播放进度变化回调。
```java
public void onPositionChanged(long curr_time, long utc_time)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 触发时机 [#触发时机-4]
该回调在媒体资源播放过程中每秒触发一次。
### 参数 [#参数-37]
当前播放进度,单位为毫秒。
当前 NTP(网络时间协议)时间,单位为毫秒。
### 所属接口类 [#所属接口类-70]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onResolutionChanged [#onresolutionchanged]
视频分辨率变化的回调。
```java
public void onResolutionChanged(int width, int height)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
你必须先调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册一个播放器观察者对象,才能监听视频流分辨率的变化。
### 触发时机 [#触发时机-5]
该回调在视频流的分辨率发生变化时被触发,报告当前视频的宽度和高度。
### 参数 [#参数-38]
视频帧的宽度,单位为 px。
视频帧的高度,单位为 px。
### 所属接口类 [#所属接口类-71]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)
## onResult [#onresult]
[onResult](/zh-CN/api-reference/rtc/android/play/rte-player#callback_asynccallback_onresult_asynccallback) 回调,用于报告异步操作的结果。
```java
@CalledByNative void onResult(Error error);
```
:::info[自从]
自 v4.4.0 版本新增。
:::
### 触发时机 [#触发时机-6]
该回调在异步操作完成时被触发,用于报告操作结果。
### 参数 [#参数-39]
状态码或错误码。详见 [Error](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_error)。
### 所属接口类 [#所属接口类-72]
- [AsyncCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_asynccallback)
## onResult [#onresult-1]
异步获取媒体资源统计信息操作完成时触发的回调。
```java
@CalledByNative void onResult(PlayerStats playerStats, Error error);
```
### 触发时机 [#触发时机-7]
该回调在异步获取媒体资源信息的操作完成时被触发。
### 参数 [#参数-40]
媒体资源的统计信息。详见 [PlayerStats](/zh-CN/api-reference/rtc/android/class-rteplayerstats)。
状态和错误信息。详见 [Error](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_error)。
### 所属接口类 [#所属接口类-73]
- [PlayerGetStatsCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playergetstatscallback)
## onStateChanged [#onstatechanged]
播放器状态变化的回调。
```java
public void onStateChanged(int old_state, int new_state, Error error)
```
:::info[自从]
自 v4.4.0 版本新增。
:::
如果你需要监听播放器状态的变化,必须先调用 [registerObserver](/zh-CN/api-reference/rtc/android/play/rte-player#api_player_registerobserver_player) 注册播放器观察者对象。
### 触发时机 [#触发时机-8]
该回调在播放器状态发生变化时被触发。
### 参数 [#参数-41]
变更前的播放器状态。详见 [PlayerState](/zh-CN/api-reference/rtc/android/enum-rteplayerstate)。
当前的播放器状态。详见 [PlayerState](/zh-CN/api-reference/rtc/android/enum-rteplayerstate)。如果当前状态为 `FAILED`,你可以通过 `error` 参数获取详细的错误信息。
状态或错误信息。详见 [Error](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_error)。
### 所属接口类 [#所属接口类-74]
- [PlayerObserver](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_playerobserver)