---
title: "getRate"
canonical: "https://help.vicon.com/space/ShogunPost121/1253738777/getRate"
format: markdown
---
# Description

Retrieves the scene data rate, in frames per second.

## Functional area

Data retrieval

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `getRate` |

### Arguments

None

### Flags

None

## Return value

float

## Examples

```plaintext
// Set and get the scene rate
int $fps;
playOptions -fps 24;
 
//set play to 24fps 
$fps = `getRate`;
print $fps;
```

# Additional information

## Related commands

- [playOptions](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736691)