> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。 Public server APIs use two path prefixes with the same authentication: `/server/v1/...` (the main APIs of both SRTC and SMeeting) and `/stm/srvapi/v1/...` (the SMeeting user system, used by server-side low-code integration). Authenticate with four request headers, app_id + nonce + timestamp + signature, where signature is HMAC-SHA256 keyed with app_key; call these APIs only from the customer's own backend. Any other path is internal: never suggest calling it.
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。 app_key is a server-side secret and must never appear in client code, frontend config, or a mobile app. The token a client uses to join must be issued by the customer's backend and passed down to the client (SRTC: `/server/v1/channel/grant`; SMeeting: `/stm/srvapi/v1/member/grant`).
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上，也不要用「频道」「加入 / 离开」描述 SMeeting 的概念（接口标识符原样保留）。 SRTC and SMeeting are two separate layers with different terminology. SRTC is the audio/video foundation: it has channels, and users join and leave a channel. SMeeting is built on top of SRTC: it has rooms and meetings, and members enter and exit a meeting. Answer in the terms of the layer the user is working with: never apply "room" or "meeting" to SRTC APIs, and never describe SMeeting concepts in prose with "channel", "join", or "leave" (API identifiers such as `force_join` keep their literal names).
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。 Package, class, and method names differ between platform SDKs for the same capability. In sample code, use the API documented for that platform; never carry one platform's code over to another. On Apple platforms each product ships two SDKs (native Swift and Objective-C) whose APIs must not be mixed.

# LocalScreenTrack

> Android screen sharing track API: request screen capture permission, start and stop screen capture, configure the foreground service notification, bind render views, and handle RTCScreenStateEvent. Read when implementing screen sharing on Android.

## Description

`LocalScreenTrack` requests screen capture permission, starts and stops screen capture, and can be used as the input track for `publishLocalVideo`.

## LocalScreenTrack methods

### setEvent(e)

```kotlin theme={null}
fun setEvent(e: RTCScreenStateEvent?)
```

Description: Sets or clears the screen capture state callback. Pass `null` when the screen is destroyed to release the reference between the screen and the track.

Parameters:

* `e`: `RTCScreenStateEvent?`, the screen capture state callback implementation; `null` clears the callback.
  Returns: None (`Unit`).

### request(result)

```kotlin theme={null}
fun request(result: (Boolean, Intent?) -> Unit)
```

Description: Requests the system screen capture permission. The `Intent` returned on successful authorization must be passed to `startCapture`.\
Parameters:

* `result`: `(Boolean, Intent?) -> Unit`, the permission request result callback.
  Returns: None (`Unit`).

### setRecordNotification(smallIcon, title, desc, buttonText)

```kotlin theme={null}
fun setRecordNotification(smallIcon: Int, title: String?, desc: String?, buttonText: String?)
```

Description: Sets the style of the screen capture notification.\
Parameters:

* `smallIcon`: `Int`, the resource ID of the notification's small icon.
* `title`: `String?`, the notification title; can be `null`.
* `desc`: `String?`, the notification description; can be `null`.
* `buttonText`: `String?`, the notification button text; can be `null`.
  Returns: None (`Unit`).

### startCapture(intent, resultListener)

```kotlin theme={null}
fun startCapture(intent: Intent, resultListener: RTCResultListener?)
```

Description: Submits a request to start screen capture. `onSuccess()` only means the SDK accepted the request, not that capture is established; the actual state is reported through `RTCScreenStateEvent`. The result callback isn't guaranteed to run on the main thread.

Parameters:

* `intent`: `Intent`, the screen capture authorization data returned by the `request` success callback.
* `resultListener`: `RTCResultListener?`, whether the start request was accepted; `onFail(code)` means the request wasn't accepted, and no screen lifecycle event is produced for it. Can be `null`.
  Returns: None (`Unit`).

### stopCapture()

```kotlin theme={null}
fun stopCapture()
```

Description: Stops screen capture.\
Parameters: None.\
Returns: None (`Unit`).

## Rendering methods inherited from VideoTrack

Views are `VcsPlayerGlTextureView` / `VcsPlayerGlSurfaceView` from the `cn.seastart.rtc.media.original.render` package; for display control and lifecycle, see [Video rendering](/en/rtc/android/api-reference/RemoteVideoTrack).

### addPlayView(view)

```kotlin theme={null}
fun addPlayView(view: View): Boolean
```

Description: Adds a single render view. Only `VcsPlayerGlTextureView` / `VcsPlayerGlSurfaceView` are supported.\
Parameters:

* `view`: `View`, the render view.
  Returns: `Boolean`; `true` if the view was added, `false` if the type is unsupported or the view was already added.

### replacePlayView(views)

```kotlin theme={null}
fun replacePlayView(views: MutableList<View>)
```

Description: Replaces the entire list of render views.\
Parameters:

* `views`: `MutableList<View>`, the render views; only `VcsPlayerGlTextureView` / `VcsPlayerGlSurfaceView` are supported.
  Returns: None (`Unit`).

### removePlayView(view)

```kotlin theme={null}
fun removePlayView(view: View)
```

Description: Removes the specified render view.\
Parameters:

* `view`: `View`, the target render view.
  Returns: None (`Unit`).

### removeAllPlayView()

```kotlin theme={null}
fun removeAllPlayView()
```

Description: Removes all render views.\
Parameters: None.\
Returns: None (`Unit`).

## RTCScreenStateEvent callback interface

`RTCScreenStateEvent` is the screen capture state callback interface, registered through `setEvent(e)`.

### onScreenCaptureStateChanged(state, args)

```kotlin theme={null}
fun onScreenCaptureStateChanged(state: ScreenCaptureState, args: String?)
```

Description: Called when the actual screen capture lifecycle state changes. Whether the SDK accepted a start request is reported separately by the `RTCResultListener` of `startCapture`.

Parameters:

* `state`: `ScreenCaptureState`, one of `START`, `STOP`, and `ERROR`; for enum values, see [Enums](/en/rtc/android/enums).
* `args`: `String?`, extra information; can be `null`.
  Returns: None (`Unit`).

> Since 2.0.29, `onScreenRecordStateChanged(ScreenRecordState, ...)` has been replaced by `onScreenCaptureStateChanged(ScreenCaptureState, ...)`, and `ScreenRecordState.AUDIO_ERROR` is no longer available.