setPushToTalkActive | SignalWire

1 setPushToTalkActive(active): void

While push-to-talk is enabled, sets the talk state. true = transmitting, false = silent. No-op if push-to-talk has not been enabled.

Parameters

active

booleanRequired

Whether push-to-talk transmission is currently active.

Returns

void

Examples

Bind to a press-and-hold button

1 talkButton.addEventListener('pointerdown', () => call.setPushToTalkActive(true));
2 talkButton.addEventListener('pointerup',   () => call.setPushToTalkActive(false));
3 talkButton.addEventListener('pointercancel', () => call.setPushToTalkActive(false));

See

enablePushToTalk — install the pipeline (required first).
disablePushToTalk — tear down the pipeline.