Skip to content
Snippets Groups Projects
Commit 8a68a48e authored by Josh Brooks's avatar Josh Brooks
Browse files

Add suggested values for low power mode

parent 6add3c5d
No related branches found
No related tags found
2 merge requests!104Modify documentation of SetTrackNetworkPeriod for clarity on Low Power Mode,!67fix for latest client release
...@@ -91,9 +91,17 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any { ...@@ -91,9 +91,17 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any {
// of the device following the network. // of the device following the network.
// - Low period -> Higher frequency of polling -> Higher battery usage // - Low period -> Higher frequency of polling -> Higher battery usage
// - High period -> Lower frequency of polling -> Lower battery usage // - High period -> Lower frequency of polling -> Lower battery usage
//
// This may be used to enable a low power (or battery optimization) mode // This may be used to enable a low power (or battery optimization) mode
// for the end user. // for the end user.
// //
// Suggested values are provided, however there are no guarantees that these
// values will perfectly fit what the end user's device would require to match
// the user's expectations:
// - Low Power Usage: 5000 milliseconds
// - High Power Usage: 1000 milliseconds (default, see
// [cmix.DefaultFollowPeriod]
//
// Parameters: // Parameters:
// - args[0] - The duration of the period, in milliseconds (int). // - args[0] - The duration of the period, in milliseconds (int).
func (c *Cmix) SetTrackNetworkPeriod(_ js.Value, args []js.Value) any { func (c *Cmix) SetTrackNetworkPeriod(_ js.Value, args []js.Value) any {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment