GetAverageFrameRate

The GetAverageFrameRate action returns statistics about the contents of a storage area. This information includes the average frame rate.

Type: synchronous

Parameter Description Required
IntervalDuration The duration of the intervals to get statistics for, in seconds (default 3600). No
NumIntervals The number of intervals to get statistics for (default 1). No
StartUTC The start time of the first interval to retrieve information for, in epoch seconds (UTC). Yes
StorageArea The storage area to obtain statistics for. Yes

Example

The following example returns statistics for the first storage area, starting at time 1519407284. The example requests statistics for two intervals of 10 minutes.

http://localhost:15000/action=GetAverageFrameRate&StorageArea=0
                                                    &StartUTC=1519407284
                                                    &IntervalDuration=600
                                                    &NumIntervals=2

Response

The following XML is an example response:

<responsedata>
  <interval>
    <startUTC>1519407284</startUTC>
    <duration>600</duration>
    <averageFPSForTimePeriod>12</averageFPSForTimePeriod>
    <averageFPSForRecordedSeconds>24</averageFPSForRecordedSeconds>
    <minFPS>24</minFPS>
    <maxFPS>25</maxFPS>
    <secondsContainingFrames>291</secondsContainingFrames>
    <secondsWithoutFrames>309</secondsWithoutFrames>
  </interval>
  <interval>
    <startUTC>1519407884</startUTC>
    <duration>600</duration>
    <averageFPSForTimePeriod>0</averageFPSForTimePeriod>
    <averageFPSForRecordedSeconds>0</averageFPSForRecordedSeconds>
    <minFPS>0</minFPS>
    <maxFPS>0</maxFPS>
    <secondsContainingFrames>0</secondsContainingFrames>
    <secondsWithoutFrames>600</secondsWithoutFrames>
  </interval>
</responsedata>

The response includes the following information:


_FT_HTML5_bannerTitle.htm