ei_gesture_hold

Hold Gesture Object

Interface for hold gesture requests and events.

This interface is only provided once per device and where a client requests ei_gesture_hold.release the interface does not get re-initialized. An EIS implementation may adjust the behavior of the device (including removing the device) if the interface is released.

Note that for a client to receive objects of this type, it must announce support for this interface in ei_handshake.interface_version.

Requests

ei_gesture_hold.release

Since Version1 Request Opcode0

ei_gesture_hold.release()

Notification that the client is no longer interested in hold gestures. The EIS implementation will release any resources related to this gesture and send the ei_gesture_hold.destroyed event once complete.

ei_gesture_hold.begin

Since Version1 Request Opcode1

ei_gesture_hold.begin(fingers)

Argument	Type	Summary
fingers	`uint32`	number of fingers

Note

This request is only available for clients of ei_handshake.context_type.sender.

Starts a new hold gesture with the given number of fingers.

The finger count must be between 1 and 5 (inclusive).

Only one hold gesture may be active at any time, it is a protocol violation to send a ei_gesture_hold.begin request before terminating the previous gesture (if any) with ei_gesture_hold.end.

A hold gesture may be aborted by the EIS implementation with an ei_gesture_hold.aborted event.

ei_gesture_hold.end

Since Version1 Request Opcode2

ei_gesture_hold.end(is_cancelled)

Argument	Type	Summary
is_cancelled	`uint32`	1 if the gesture was cancelled or 0 otherwise

Note

This request is only available for clients of ei_handshake.context_type.sender.

Logically ends this gesture.

Events

ei_gesture_hold.destroyed

Since Version1 Event Opcode0

ei_gesture_hold.destroyed(serial)

Argument	Type	Summary
serial	`uint32`	this event’s serial number

Destructor

Immediately after sending this request, the object is considered destroyed by the EIS implementation. It must no longer be used by the client.

This gesture has been removed and a client should release all associated resources.

This ei_gesture_hold object will be destroyed by the EIS implementation immediately after this event is sent and as such the client must not attempt to use it after that point.

ei_gesture_hold.aborted

Since Version1 Event Opcode1

ei_gesture_hold.aborted(serial)

Argument	Type	Summary
serial	`uint32`	this event’s serial number

Note

This event is only available for clients of ei_handshake.context_type.sender.

The current gesture has been aborted by the EIS implementation. The client must discard the current gesture and not send further ei_gesture_hold.end events. Due to the asynchronous nature of the protocol, an EIS implementation must allow for ei_gesture_hold.end events to be received after sending ei_gesture_hold.aborted. These events must be discarded.

The client may begin a new gesture in the future using ei_gesture_hold.begin.

ei_gesture_hold.begin

Since Version1 Event Opcode2

ei_gesture_hold.begin(fingers)

Argument	Type	Summary
fingers	`uint32`	number of fingers

Note

This event is only available for clients of ei_handshake.context_type.receiver.

See the ei_gesture_hold.begin request for details.

ei_gesture_hold.end

Since Version1 Event Opcode3

ei_gesture_hold.end(is_cancelled)

Argument	Type	Summary
is_cancelled	`uint32`	1 if the gesture was cancelled or 0 otherwise

Note

This event is only available for clients of ei_handshake.context_type.receiver.

See the ei_gesture_hold.end request for details.