validate_dpf_sound_connection

ansys.sound.core.server_helpers._validate_dpf_sound_connection.validate_dpf_sound_connection(port=None)

Validate DPF server and DPF Sound plugin availability.

Parameters:

portint, default: None

Port on which the DPF server is listening.

Return type:

None

Examples

Validate that a global DPF server (whether local or remote) is available and has the DPF Sound plugin.

>>> from ansys.sound.core.server_helpers import validate_dpf_sound_connection
>>> validate_dpf_sound_connection()

Validate that a remote DPF server on a specific port is available and has the DPF Sound plugin.

>>> from ansys.sound.core.server_helpers import validate_dpf_sound_connection
>>> validate_dpf_sound_connection(port=6780)