Class ApiBufferState

• Defined in File ApiBufferApi.h

Class Documentation

class ApiBufferState

This enumerator class enumerates the states of an API buffer channel.

Public Types

enum T

Values:

enumerator Idle

The API buffer channel has not been created yet.

enumerator Active

The API buffer channel is active and is executing a sequence of APIs. The API buffer will remain in this state after the last API function in the API buffer has been executed. When another API function is added to the buffer, execution will automatically resume.

enumerator Stop

The API buffer channel is inactive and not executing APIs.

enumerator Delay

Execution of the API buffer is temporarily stopped because of the functions ApiBuffer::Wait and ApiBuffer::Sleep. The API buffer will not change to this state while executing Motion::Wait.