Share via


ViewGroup.PropagateRequestedFrameRate(Single, Boolean) Method

Definition

You can set the preferred frame rate for a ViewGroup and its children using a positive number or by specifying the preferred frame rate category using constants, including REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, REQUESTED_FRAME_RATE_CATEGORY_HIGH.

[Android.Runtime.Register("propagateRequestedFrameRate", "(FZ)V", "GetPropagateRequestedFrameRate_FZHandler", ApiSince=36)]
public virtual void PropagateRequestedFrameRate(float frameRate, bool forceOverride);
[<Android.Runtime.Register("propagateRequestedFrameRate", "(FZ)V", "GetPropagateRequestedFrameRate_FZHandler", ApiSince=36)>]
abstract member PropagateRequestedFrameRate : single * bool -> unit
override this.PropagateRequestedFrameRate : single * bool -> unit

Parameters

frameRate
Single

the preferred frame rate of the ViewGroup.

forceOverride
Boolean

indicate whether it should override the frame rate of all the children with the given frame rate.

Attributes

Remarks

You can set the preferred frame rate for a ViewGroup and its children using a positive number or by specifying the preferred frame rate category using constants, including REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, REQUESTED_FRAME_RATE_CATEGORY_HIGH. Keep in mind that the preferred frame rate affects the frame rate for the next frame, so use this method carefully. It's important to note that the preference is valid as long as the ViewGroup or any of its children is invalidated. To undo the frame rate propagation, call the API with REQUESTED_FRAME_RATE_CATEGORY_DEFAULT.

Java documentation for android.view.ViewGroup.propagateRequestedFrameRate(float, boolean).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to