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

Modify documentation of SetTrackNetworkPeriod for clarity on Low Power Mode

parent e81cf17d
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
Show whitespace changes
Inline Side-by-side
Showing
with 7 additions and 0 deletions
wasm/follow.go
+ 7
− 0
View file @ 6add3c5d
...@@ -87,6 +87,13 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any { ...@@ -87,6 +87,13 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any {
// SetTrackNetworkPeriod allows changing the frequency that follower threads // SetTrackNetworkPeriod allows changing the frequency that follower threads
// are started. // 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.
//
// 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% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment