# WindowContentFrameStats

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Inherited Constants](https://developer.android.com/reference/android/view/WindowContentFrameStats#inhconstants)\|[Fields](https://developer.android.com/reference/android/view/WindowContentFrameStats#lfields)\|[Methods](https://developer.android.com/reference/android/view/WindowContentFrameStats#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/view/WindowContentFrameStats#inhmethods)  

# WindowContentFrameStats

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/WindowContentFrameStats "View this page in Kotlin")\|Java

`
public

final

class
WindowContentFrameStats
`  
`


``

extends `[FrameStats](https://developer.android.com/reference/android/view/FrameStats)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

|---|---|--------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.view.FrameStats](https://developer.android.com/reference/android/view/FrameStats) ||
|   | ↳ | android.view.WindowContentFrameStats |

<br />

*** ** * ** ***

This class contains window content frame statistics. For example, a window content is rendred in frames when a view is scrolled. The frame statistics are a snapshot for the time interval from[FrameStats.getStartTimeNano()](https://developer.android.com/reference/android/view/FrameStats#getStartTimeNano())to[FrameStats.getEndTimeNano()](https://developer.android.com/reference/android/view/FrameStats#getEndTimeNano()).

The key idea is that in order to provide a smooth user experience an application has to draw a frame at a specific time interval obtained by calling[FrameStats.getRefreshPeriodNano()](https://developer.android.com/reference/android/view/FrameStats#getRefreshPeriodNano()). If the application does not render a frame every refresh period the user will see irregular UI transitions.

An application posts a frame for presentation by synchronously rendering its contents in a buffer which is then posted or posting a buffer to which the application is asychronously rendering the content via GL. After the frame is posted and rendered (potentially asynchronosly) it is presented to the user. The time a frame was posted can be obtained via[getFramePostedTimeNano(int)](https://developer.android.com/reference/android/view/WindowContentFrameStats#getFramePostedTimeNano(int)), the time a frame content was rendered and ready for dsiplay (GL case) via[getFrameReadyTimeNano(int)](https://developer.android.com/reference/android/view/WindowContentFrameStats#getFrameReadyTimeNano(int)), and the time a frame was presented on the screen via[FrameStats.getFramePresentedTimeNano(int)](https://developer.android.com/reference/android/view/FrameStats#getFramePresentedTimeNano(int)).

<br />

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From class[android.view.FrameStats](https://developer.android.com/reference/android/view/FrameStats) |--------|----------------------------------------------------------------------------------------------------------------------------| | `long` | [UNDEFINED_TIME_NANO](https://developer.android.com/reference/android/view/FrameStats#UNDEFINED_TIME_NANO) Undefined time. |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |

|                                                                                                                                                          ### Fields                                                                                                                                                          ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[WindowContentFrameStats](https://developer.android.com/reference/android/view/WindowContentFrameStats)`>` | [CREATOR](https://developer.android.com/reference/android/view/WindowContentFrameStats#CREATOR) <br /> |

|                                                                                                                                                               ### Public methods                                                                                                                                                                ||
|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                | ` `[describeContents](https://developer.android.com/reference/android/view/WindowContentFrameStats#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                      |
| ` long`                                                               | ` `[getFramePostedTimeNano](https://developer.android.com/reference/android/view/WindowContentFrameStats#getFramePostedTimeNano(int))`(int index) ` Get the time a frame at a given index was posted by the producer (e.g. the application).                             |
| ` long`                                                               | ` `[getFrameReadyTimeNano](https://developer.android.com/reference/android/view/WindowContentFrameStats#getFrameReadyTimeNano(int))`(int index) ` Get the time a frame at a given index was ready for presentation.                                                      |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/view/WindowContentFrameStats#toString())`() ` Returns a string representation of the object.                                                                                                               |
| ` void`                                                               | ` `[writeToParcel](https://developer.android.com/reference/android/view/WindowContentFrameStats#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` parcel, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[android.view.FrameStats](https://developer.android.com/reference/android/view/FrameStats)` ` |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` final long` | ` `[getEndTimeNano](https://developer.android.com/reference/android/view/FrameStats#getEndTimeNano())`() ` Gets the end time of the interval for which these statistics apply.                                        | | ` final int`  | ` `[getFrameCount](https://developer.android.com/reference/android/view/FrameStats#getFrameCount())`() ` Gets the number of frames for which there is data.                                                           | | ` final long` | ` `[getFramePresentedTimeNano](https://developer.android.com/reference/android/view/FrameStats#getFramePresentedTimeNano(int))`(int index) ` Get the time a frame at a given index was presented.                     | | ` final long` | ` `[getRefreshPeriodNano](https://developer.android.com/reference/android/view/FrameStats#getRefreshPeriodNano())`() ` Gets the refresh period of the display hosting the window(s) for which these statistics apply. | | ` final long` | ` `[getStartTimeNano](https://developer.android.com/reference/android/view/FrameStats#getStartTimeNano())`() ` Gets the start time of the interval for which these statistics apply.                                  | ||
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<WindowContentFrameStats> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         Returns                                                                                                                         ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### getFramePostedTimeNano

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getFramePostedTimeNano (int index)
```

Get the time a frame at a given index was posted by the producer (e.g. the application). It is either explicitly set or defaulted to the time when the render buffer was posted.

**Note:** A frame can be posted and still it contents being rendered asynchronously in GL. To get the time the frame content was completely rendered and ready to display call[getFrameReadyTimeNano(int)](https://developer.android.com/reference/android/view/WindowContentFrameStats#getFrameReadyTimeNano(int)).

<br />

<br />

|               Parameters                ||
|---------|--------------------------------|
| `index` | `int`: The frame index. <br /> |

|                    Returns                     ||
|--------|----------------------------------------|
| `long` | The posted time in nanoseconds. <br /> |

### getFrameReadyTimeNano

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long getFrameReadyTimeNano (int index)
```

Get the time a frame at a given index was ready for presentation.

**Note:**A frame can be posted and still it contents being rendered asynchronously in GL. In such a case this is the time when the frame contents were completely rendered.

<br />

<br />

|               Parameters                ||
|---------|--------------------------------|
| `index` | `int`: The frame index. <br /> |

|                                                                                              Returns                                                                                               ||
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `long` | The ready time in nanoseconds or[FrameStats.UNDEFINED_TIME_NANO](https://developer.android.com/reference/android/view/FrameStats#UNDEFINED_TIME_NANO)if the frame is not ready yet. <br /> |

### toString

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |

### writeToParcel

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void writeToParcel (Parcel parcel, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

|                                                                                                                                                                                                                                Parameters                                                                                                                                                                                                                                ||
|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `parcel` | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`. <br />                                                                                                                                                                                                                                                                                                                                                                 |
| `flags`  | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |