你可以使用此接口查询房间内指定用户的实时推流状态。

接口行为

你可以调用 GetUserStreamState 接口，指定你所属的 AppId，查询指定 RoomId 房间中指定 UserId 用户的实时推流状态。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 GET 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	是否必填	示例值	描述
Action	String	是	`GetUserStreamState`	接口名称，本接口取值：`GetUserStreamState`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	String	是	`Your_AppId`	应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
UserId	String	是	`Your_UserId`	查询用户 ID

请求示例代码

Query

https://rtc.volcengineapi.com?Action=GetUserStreamState&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&UserId=Your_UserId

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID
UserId	String	`Your_UserId`	用户 ID
StreamStates	Array of StreamState	/	流相关信息

StreamState

参数名	类型	示例值	描述
MediaType	String	`Audio`	媒体流类型。可取值为：`Audio`，`Video`，`ScreenAudio`，`ScreenVideo`。 `Audio`：音频流 `Video`：视频流 `ScreenAudio`：屏幕共享音频流 `ScreenVideo`：屏幕共享视频流
State	Int32	`0`	此媒体流推流状态。可取值为`0`和`1`。 `0`：未在推流 `1`：正在推流

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetUserStreamState",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "RoomId": "Your_RoomId",
        "UserId": "Your_UserId",
        "StreamStates": [
            {
                "MediaType": "Audio",
                "State": 0,
            },
            {
                "MediaType": "Video",
                "State": 0,
            },
            {
                "MediaType": "ScreenAudio",
                "State": 0,
            },
            {
                "MediaType": "ScreenVideo",
                "State": 0,
            },
        ]
    }
}
json