Haptics application programming interface
Systems and methods are disclosed defining haptic patterns that include both haptic events and audio events, and optionally include video or animation. The haptic patterns can be called from an application or included as an attachment to a message and played on an electronic device that receives the message. A haptics application programming interface has a haptic experience mapping functionality that generates a same, or similar, haptic experience on different manufacturers or models of electronic devices having different haptic hardware. Haptic patterns can include synchronized haptic and audio events. Haptic event attributes include start time, sharpness, and intensity. Sharpness and/or intensity can be controlled via a parameter envelope for a single event, or for multiple events in a haptic pattern. Sharpness indicates a quality of the tactile sensation of a haptic event, from smooth or rounded, to sharp or precise.
1 . A computer-implemented method, comprising:
receiving, on a first device, a command to play a haptic pattern comprising a plurality of time-ordered events, wherein the plurality of time-ordered events is played on the first device and a second device, wherein the first device is communicatively coupled to the second device;
scheduling the plurality of time-ordered events according to a start time of each of the plurality of time-ordered events, wherein the start time of each of the plurality of time-ordered events is relative to a start time of the haptic pattern; and
causing playback of each of the plurality of time-ordered events in the haptic pattern in accordance with the scheduling on the first and second devices, wherein the playback includes mapping, by the first device, an event of the plurality of time-ordered events using a sharpness parameter and an intensity parameter for the second device to low-level haptic commands using an application programming interface (API) native to a hardware type of the second device, wherein the mapping is dependent on the hardware type of the second device, the sharpness parameter determines a tactile quality of a haptic output so that a lowest sharpness parameter value corresponds to a continuously differentiable haptic waveform, having no discontinuities, and a highest sharpness parameter value corresponds to a non-continuously differentiable waveform, including at least one discontinuity, and the intensity parameter determines a tactile magnitude of the haptic output.
2 . The method of claim 1 , wherein waveform values for the sharpness parameter are configured by mixing a sine wave with a complex waveform.
3 . The method of claim 1 , wherein at least one of the plurality of time-ordered events is an audio event having an audio waveform and an audio volume.
4 . The method of claim 1 , wherein at least two events of the plurality of the time-ordered events are haptic events that at least partially overlap in time, further comprising mixing, in a position domain, an overlapping portion of each of the at least two haptic events, before outputting the haptic output to haptic hardware.
5 . The method of claim 1 , wherein at least two events of the plurality of time-ordered events have a same start time, further comprising causing playback of the at least two events at a same time.
6 . The method of claim 5 , further comprising controlling an intensity of the at least two events of the plurality of time-ordered events in accordance with an intensity envelope.
7 . The method of claim 5 , wherein one of the at least two events of the plurality of time-ordered events is an audio event and one of the at least two events of the plurality of time-ordered events is a haptic event, and the at least two events are played at a same time.
8 . The method of claim 7 , wherein the haptic event is one of a haptic transient event having a fixed duration or a haptic continuous event having a specified duration.
9 . The method of claim 1 further comprising controlling an intensity of a haptic event in the plurality of time-ordered events in accordance with an intensity envelope associated with the haptic event.
10 . The method of claim 9 , further comprising controlling a volume of an audio event and the intensity of the haptic event in accordance with the intensity envelope.
11 . The method of claim 1 , further comprising:
receiving, from a host device application, a query message to the API native to the hardware type of the second device; and
transmitting, to the host device application from the API, attributes to address haptic actuation commands based on at least one of haptic hardware or haptic firmware in the second device in response to receiving the query message;
wherein, the plurality of time-ordered events is played on the first device and the second device, each based on at least one of the respective haptic hardware or the haptic firmware in the first device and the second device.
12 . A non-transitory computer-readable storage medium having executable instructions stored thereon, that when executed by a processing system having at least one hardware processor, cause the processing system to perform operations comprising:
receiving, on a first device, a command to play a haptic pattern comprising a plurality of time-ordered events, wherein the plurality of time-ordered events is played on the first device and a second device;
scheduling the plurality of time-ordered events according to a start time of each of the plurality of time-ordered events, each start time being relative to a start time of the haptic pattern, wherein the start time of each of the plurality of time-ordered events is relative to a start time of the haptic pattern; and
causing playback of each of the plurality of time-ordered events in the haptic pattern in accordance with the scheduling on the first and second devices, wherein the playback includes mapping, by the first device, an event of the plurality of time-ordered events using a sharpness parameter and an intensity parameter for the second device to low-level haptic commands using an application programming interface native to a hardware type of the second device, wherein the mapping is dependent on the hardware type of the second device, the sharpness parameter determines a tactile quality of a haptic output so that a lowest sharpness parameter value corresponds to a continuously differentiable haptic waveform, having no discontinuities, and a highest sharpness parameter value corresponds to a non-continuously differentiable waveform, including at least one discontinuity, and the intensity parameter determines a tactile magnitude of the haptic output.
13 . The medium of claim 12 , wherein waveform values for the sharpness parameter are configured by mixing a sine wave with a complex waveform.
14 . The medium of claim 12 , wherein at least one of the plurality of time-ordered events is an audio event having an audio waveform and an audio volume, the operations further comprising playing the audio event synchronously with a haptic event in the plurality of time-ordered events.
15 . The medium of claim 12 , wherein at least two events of the plurality of the time-ordered events are haptic events that at least partially overlap in time, the operations further comprising mixing, in a position domain, an overlapping portion of each of the at least two haptic events, before being output to haptic hardware.
16 . The medium of claim 15 , the operations further comprising controlling an intensity of both of the at least two events of the plurality of time-ordered events in accordance with an intensity envelope.
17 . The medium of claim 12 , the operations further comprising controlling an intensity of a haptic event in the plurality of time-ordered events in accordance with an intensity envelope associated with the haptic event.
18 . A first electronic device comprising a memory programmed with executable instructions that, when executed by a processing system having at least one hardware processor, cause the processing system to perform operations comprising:
receiving, on the first electronic device, a command to play a haptic pattern comprising a plurality of time-ordered events, wherein the plurality of time-ordered events is played on the first electronic device and a second electronic device;
scheduling the plurality of time-ordered events according to a start time of each of the plurality of time-ordered events, each start time being relative to a start time of the haptic pattern, wherein the start time of each of the plurality of time-ordered events is relative to a start time of the haptic pattern; and
causing playback of each of the plurality of time-ordered events in the haptic pattern in accordance with the scheduling on the first and second electronic devices, wherein the playback includes mapping, by the first electronic device, an event of the plurality of time-ordered events using a sharpness parameter and an intensity parameter for the second electronic device to low-level haptic commands using an application programming interface native to a hardware type of the second device, wherein the mapping is dependent on the hardware type of the second device, the sharpness parameter determines a tactile quality of a haptic output so that a lowest sharpness parameter value corresponds to a continuously differentiable haptic waveform, having no discontinuities, and a highest sharpness parameter value corresponds to a non-continuously differentiable waveform, including at least one discontinuity, and the intensity parameter determines a tactile magnitude of the haptic output.
19 . The first electronic device of claim 18 , wherein waveform values for the sharpness parameter are configured by mixing a sine wave with a complex waveform.
20 . The first electronic device of claim 18 , wherein at least one of the plurality of time-ordered events is an audio event having an audio waveform and an audio volume, the operations further comprising playing the audio event synchronously with a haptic event in the plurality of time-ordered events.
21 . The first electronic device of claim 18 , wherein at least two haptic events of the plurality of the time-ordered events are haptic events that at least partially overlap in time, the operations further comprising mixing, in a position domain, an overlapping portion of each of the at least two haptic events, before being output to haptic hardware.
22 . The first electronic device of claim 21 , the operations further comprising controlling an intensity of both of the at least two events of the plurality of time-ordered events in accordance with an intensity envelope.
23 . The first electronic device of claim 18 , the operations further comprising controlling an intensity of a haptic event in the plurality of time-ordered events in accordance with an intensity envelope associated with the haptic event.