TsHapticPlayer

teslasuit_sdk.subsystems.ts_haptic.TsHapticPlayer

Controls haptic playback for a single TESLASUIT device.

Manages a queue of playable haptic assets and instant touch events, and exposes per-player and per-playable state controls such as pause, mute, loop, and parameter multipliers.

Methods#

__init__#

def __init__(device):

---

is_player_running#

def is_player_running() -> bool:

---

stop_player#

def stop_player() -> None:

---

is_player_paused#

def is_player_paused() -> bool:

---

set_player_paused#

def set_player_paused(is_paused: bool) -> None:

---

is_player_muted#

def is_player_muted() -> bool:

---

set_player_muted#

def set_player_muted(is_muted: bool) -> None:

---

get_player_time#

def get_player_time() -> int:

---

get_number_of_master_multipliers#

def get_number_of_master_multipliers() -> int:

---

get_master_multipliers#

def get_master_multipliers() -> List[TsHapticParamMultiplier]:

---

set_master_multipliers#

def set_master_multipliers(multipliers: List[TsHapticParamMultiplier]) -> None:

The length of multipliers must equal the value returned by

---

get_master_multiplier#

def get_master_multiplier(type: TsHapticParamType) -> TsHapticParamMultiplier:

---

set_master_multiplier#

def set_master_multiplier(multiplier: TsHapticParamMultiplier) -> None:

---

create_playable#

def create_playable(asset: int, is_looped: bool) -> int:

---

is_playable_exists#

def is_playable_exists(playable_id: int) -> bool:

---

play_playable#

def play_playable(playable_id: int) -> None:

---

play_touch#

def play_touch(params: List[TsHapticParam], channels: List[int], duration: int) -> None:

---

create_touch#

def create_touch(params: List[TsHapticParam], channels: List[int], duration: int) -> int:

---

is_playable_playing#

def is_playable_playing(playable_id: int) -> bool:

---

stop_playable#

def stop_playable(playable_id: int) -> None:

---

remove_playable#

def remove_playable(playable_id: int) -> None:

---

get_playable_paused#

def get_playable_paused(playable_id: int) -> bool:

---

set_playable_paused#

def set_playable_paused(playable_id: int, is_paused: bool) -> None:

---

get_playable_muted#

def get_playable_muted(playable_id: int) -> bool:

---

set_playable_muted#

def set_playable_muted(playable_id: int, is_muted: bool) -> None:

---

get_playable_looped#

def get_playable_looped(playable_id: int) -> bool:

---

set_playable_looped#

def set_playable_looped(playable_id: int, is_looped: bool) -> None:

---

get_number_of_playable_multipliers#

def get_number_of_playable_multipliers(playable_id: int) -> int:

---

get_playable_multipliers#

def get_playable_multipliers(playable_id: int):

---

set_playable_multipliers#

def set_playable_multipliers(playable_id: int, multipliers: List[TsHapticParamMultiplier]) -> None:

---

get_playable_local_time#

def get_playable_local_time(playable_id: int) -> int:

---

set_playable_local_time#

def set_playable_local_time(playable_id: int, local_time: int) -> None:

---

get_playable_duration#

def get_playable_duration(playable_id: int) -> int:

---

clear_all_playables#

def clear_all_playables() -> None:

---

add_channel_to_dynamic_playable#

def add_channel_to_dynamic_playable(channel_id, playable_id: int) -> None:

---

remove_channel_from_dynamic_playable#

def remove_channel_from_dynamic_playable(channel_id, playable_id: int) -> None:

---

set_material_channel_impact#

def set_material_channel_impact(channel_id, impact: float, playable_id: int) -> None:

---

create_touch_parameters#

def create_touch_parameters(period_ms: int, amplitude: int, pulse_width: int) -> List[TsHapticParam]:

.. note:: The period_ms argument is expressed in microseconds, not milliseconds; the _ms suffix is a legacy misnomer. Use period_us = 1000000 / frequency_hz (e.g. 10000 µs = 100 Hz).

---

create_touch_multipliers#

def create_touch_multipliers(period_ms_m: float, amplitude_m: float, pulse_width_m: float) -> List[TsHapticParamMultiplier]:

---

Data Structures#

ts_haptic.TsHapticParam#

C structure representing a single haptic parameter type–value pair.

Fields

type int

value int

---

ts_haptic.TsHapticParamMultiplier#

C structure representing a haptic parameter multiplier.

Used to scale haptic output by multiplying a parameter's base value by a coefficient between 0 and 1.

Fields

type int

value float

---

Enumerations#

ts_haptic.TsHapticParamType#

Enumeration of haptic parameter types.

• Undefined (0): Parameter type not specified.
• Period (1): Period of the haptic waveform in microseconds (e.g. 10000 = 100 Hz).
• Amplitude (2): Amplitude of the haptic waveform.
• PulseWidth (3): Pulse width of the haptic waveform.
• Temperature (4): Temperature feedback parameter.

Members

Undefined 0 Period 1 Amplitude 2 PulseWidth 3 Temperature 4

---