Client performance

Request URL

{{adminHost:8181}}/taskInfo/getPerformanceMeasure

Request Method

get

Header

Field Name
Sample
Required
Type
Note


adminKey
603284317954637824
Yes
string
This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management

timestamp
8641706679604867
Yes
string
The timestamp when sending a request, in milliseconds

signature
9A02B47AE67664D80A2ED13FC2B1691512613790
Yes
string
This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Request Query Parameters

Field Name
Sample
Required
Type
Note


taskId
 
Yes
string
Task Id

Success Response Example

{
    "code": 1000, 
    "message": "操作成功", 
    "result": [
        {
            "id": "732282282802413568", 
            "taskId": "732282274455748608", 
            "clientRenderLatency": 3.57, 
            "decodeLatency": 15.9, 
            "transportLatency": 3.96, 
            "encodeLatency": 11.84, 
            "serverRenderLatency1": 0.12, 
            "serverRenderLatency2": 0, 
            "cmdUploadLatency": 0, 
            "totalLatency": 54.65, 
            "feelLatency": 0, 
            "blackEdgeDegree": 0.54, 
            "clientFps": 70, 
            "serverFps": 24, 
            "rtt": 1, 
            "packetRate": 144, 
            "packetsLostInSecond": 0, 
            "totalSent": 0, 
            "sentRate": 0, 
            "frameRate": 23, 
            "resolutionRatio": "2560x1440", 
            "createDate": "2020-07-13 17:08:21", 
            "otherLatency": 19.38, 
            "packetsLostLatency": 0
        }
    ]
}

Parameter Note for Success Response Example

Field Name
Type
Note


code
string
None

message
string
None

result
array
None

id
string
None

taskId
string
Task Id

clientRenderLatency
string
Client rendering latency unit: ms

decodeLatency
string
Decoding delay unit: ms

transportLatency
string
Transmission delay unit: ms

encodeLatency
string
Encoding delay unit: ms

serverRenderLatency 1
string
Server rendering delay 1 unit: ms

serverRenderLatency 2
string
Server rendering delay 2 units: ms

cmdUploadLatency
string
Instruction upload delay unit: ms

totalLatency
string
Total delay unit: ms

feelLatency
string
Perceived delay unit: ms

blackEdgeDegree
string
Black edge degree unit: °

clientFps
string
Client FPS

serverFps
string
Server FPS

rtt
string
Network latency unit: ms

packetRate
string
Packet sending rate

packetsLostInSecond
string
Number of packet losses per second

totalSent
string
The total number of packets sent

sentRate
string
Send rate in Mbps

frameRate
string
bit rate

resolutionRatio
string
Client resolution

createDate
string
Creation time

otherLatency
string
Other delay delay units: ms

packetsLostLatency
string
packet loss rate

Field Name	Sample	Required	Type	Note
adminKey	603284317954637824	Yes	string	This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management
timestamp	8641706679604867	Yes	string	The timestamp when sending a request, in milliseconds
signature	9A02B47AE67664D80A2ED13FC2B1691512613790	Yes	string	This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Field Name	Type	Note
code	string	None
message	string	None
result	array	None
id	string	None
taskId	string	Task Id
clientRenderLatency	string	Client rendering latency unit: ms
decodeLatency	string	Decoding delay unit: ms
transportLatency	string	Transmission delay unit: ms
encodeLatency	string	Encoding delay unit: ms
serverRenderLatency 1	string	Server rendering delay 1 unit: ms
serverRenderLatency 2	string	Server rendering delay 2 units: ms
cmdUploadLatency	string	Instruction upload delay unit: ms
totalLatency	string	Total delay unit: ms
feelLatency	string	Perceived delay unit: ms
blackEdgeDegree	string	Black edge degree unit: °
clientFps	string	Client FPS
serverFps	string	Server FPS
rtt	string	Network latency unit: ms
packetRate	string	Packet sending rate
packetsLostInSecond	string	Number of packet losses per second
totalSent	string	The total number of packets sent
sentRate	string	Send rate in Mbps
frameRate	string	bit rate
resolutionRatio	string	Client resolution
createDate	string	Creation time
otherLatency	string	Other delay delay units: ms
packetsLostLatency	string	packet loss rate