Epok Engine

EPOK RUNTIME

epok::RumbleService::play

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Starts play as part of bounded controller motor pulses and cancellation.

Belongs to
epok::RumbleService
Header
rumble.hpp
Overloads
1

Declaration

Declaration
bool play(uint32_t large,bool small,uint32_t duration_ms,unsigned port=0)

Starts play as part of bounded controller motor pulses and cancellation.

ParameterTypeMeaning
largeuint32_tNot documented; consult the linked header.
smallboolNot documented; consult the linked header.
duration_msuint32_tNot documented; consult the linked header.
portunsigned intNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "rumble.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t large
// bool small
// uint32_t duration_ms
// unsigned int port

epok::RumbleService& object = /* obtain a valid instance */;

auto result = object.play(large, small, duration_ms, port);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/rumble.hpp:68

Related members