Skip to end of metadata
Go to start of metadata

Versions

org.rdk.FrameRate.1 - Initial Version of the FrameRate API.

Methods

setCollectionFrequency  (v1)

Description: Sets the FPS data collection interval.

Arguments: 

  • frequency: int - The amount of time in milliseconds. The default value if no value is specified is 10000.

Returns:

Request : {"jsonrpc":"2.0","id":"3","params": {"frequency":1000},"method": "org.rdk.FrameRate.1.setCollectionFrequency"}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

startFpsCollection  (v1)

Description: Starts the FPS data collection

Arguments: None

Returns:

  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method": "org.rdk.FrameRate.1.startFpsCollection"}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

stopFpsCollection  (v1)

Description: Stops the FPS data collection

Arguments: None

Returns:

  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method": "org.rdk.FrameRate.1.stopFpsCollection"}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

Events:

onFpsEvent (v1)

Description: Fired at the end of each interval as described by collectionFrequency, and immediately after stopFpsCollection is invoked even if the full collection interval has not been reached.

Payload:

  • min: int
  • max: int
  • average: integer

{
  "jsonrpc":"2.0",
  "method":"org.rdk.FrameRate.1.onFpsEvent",
  "params": {
    "average":0,
    "min":0,
    "max":0
  }
}

  • No labels

2 Comments

  1. onFpsEvent example seems to be wrong

    1. Updated the callsigns. Thanks for pointing out the error.