ssCore.App.setPriority

Set the priority of our application to tell the Windows scheduler to give us a higher or lower priority (more or less CPU time).


Availability:

First available in version 3.0 build 2039.


Input Parameters:

priority - The new priority for this application. Valid values include: normal, idle, high, and realtime.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.App.setPriority( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.App.setPriority( paramsObject );


Notes:

All applications are assigned a priority of NORMAL when they are created.

IDLE means your application is given CPU time only when the system is idle (your application can be preempted by any other application).

HIGH should be used for applications that perform time-critical tasks that must be executed immediately (applications with this priority will preempt IDLE and NORMAL applications).

REALTIME is the highest possible priority and will preempt applications of all other priorities, including operating system processes which can make the rest of the system appear sluggish and affect user input. Use the REALTIME priority setting with caution.


Examples:

ssCore.App.setPriority({priority:"idle"});