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

Merge branch 'XX-4660/LowPowerMode' into 'release'

Modify documentation of SetTrackNetworkPeriod for clarity on Low Power Mode

See merge request !104
parents e81cf17d 8a68a48e
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
......@@ -87,6 +87,21 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any {
// SetTrackNetworkPeriod allows changing the frequency that follower threads
// are started.
//
// Note that the frequency of the follower threads affect the power usage
// of the device following the network.
// - Low period -> Higher frequency of polling -> Higher battery usage
// - High period -> Lower frequency of polling -> Lower battery usage
//
// This may be used to enable a low power (or battery optimization) mode
// 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:
// - args[0] - The duration of the period, in milliseconds (int).
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