Huron & SNAP Documentation

Huron & SNAP Documentation Huron & SNAP Documentation

sheffield.ac.uk
from sheffield.ac.uk More from this publisher
05.05.2013 Views

Initialisation SNAP Commands General VRack Commands Parameter Description OTHER SIMULATION TOOLS To begin communication, issue the SNAPConnect() command. This will open a socket to the Huron. Note that the Socket for Windows 2000 application must be running on the Huron or this command will fail. Use SNAPDisconnect() to close the socket. If your application exits without calling SNAPDisconnect() then Socket for Windows 2000 may crash. SNAPConnect Creates a TCP/IP connection with the Huron. The Socket application must be running on the Huron for a connection to be established. in const char* szIPAddress The IP address of the Huron SNAPDisconnect Disconnects the TCP/IP connection with the Huron. SNAPExec Huron runs a command on the Microsoft Windows operating system. To send a command to be executed by Windows call this function with the full path of the command in the path field. in char* szPath Full path of Windows command SNAPSetWorkspace This command allows the loading of a new workspace into the VRack of Huron. This command requires the path field to be set to the full path of the workspace file. VRack must also be running on the Server (Huron). in const char* szPath Full path of workspace file out long* plStatus out char* szPath SNAPGetStatus This command returns the current operating status of the Huron. SNAPGetWorkspace To find the currently loaded workspace in VRack send this command. The VRack application will send a HuronGetWorkspace command back to the remote computer with the path field set to the full path of the current workspace file. VRack must be running. HURON TECHNICAL MANUAL PAGE 160

Positional Commands Note: The number of positional commands sent per second should be limited by the controlling application. Sending too many messages per second can cause buffer overflow, resulting in delayed response and loss of command data. Parameter Description OTHER SIMULATION TOOLS These positional commands can be used with Binscape, Space Array, Multiscape, Aniscape, and Headscape. The sound objects and listener object in each simulation application receive their location and orientation information on Location and Angle channels. Every independently moveable source should have a unique Location and Angle channel assigned to it. Object location and angle settings will be updated on receipt of the command. SNAPLocation This command sets the X, Y, and Z coordinates of an object. The distances are measured in meters. in long lChannel Location channel that will receive the coordinates (1-255) in float fX X coordinate of the object in meters in float fY Y coordinate of the object in meters in float fZ Z coordinate of the object in meters SNAPAngle This command sets the orientation of an object. The angles passed are in degrees. in long lChannel Angle channel that will receive the data (1-255) in float fAz Azimuth of the object in degrees in float fEl Elevation of the object in degrees in float fRl Roll of the object in degrees HURON TECHNICAL MANUAL PAGE 161

Initialisation<br />

<strong>SNAP</strong> Commands<br />

General VRack Commands<br />

Parameter Description<br />

OTHER SIMULATION TOOLS<br />

To begin communication, issue the <strong>SNAP</strong>Connect() command.<br />

This will open a socket to the <strong>Huron</strong>. Note that the Socket for<br />

Windows 2000 application must be running on the <strong>Huron</strong> or<br />

this command will fail. Use <strong>SNAP</strong>Disconnect() to close the<br />

socket. If your application exits without calling<br />

<strong>SNAP</strong>Disconnect() then Socket for Windows 2000 may crash.<br />

<strong>SNAP</strong>Connect<br />

Creates a TCP/IP connection with the <strong>Huron</strong>. The Socket<br />

application must be running on the <strong>Huron</strong> for a connection to be<br />

established.<br />

in const char* szIPAddress The IP address of the <strong>Huron</strong><br />

<strong>SNAP</strong>Disconnect<br />

Disconnects the TCP/IP connection with the <strong>Huron</strong>.<br />

<strong>SNAP</strong>Exec<br />

<strong>Huron</strong> runs a command on the Microsoft Windows operating<br />

system. To send a command to be executed by Windows call<br />

this function with the full path of the command in the path field.<br />

in char* szPath Full path of Windows command<br />

<strong>SNAP</strong>SetWorkspace<br />

This command allows the loading of a new workspace into the<br />

VRack of <strong>Huron</strong>. This command requires the path field to be<br />

set to the full path of the workspace file. VRack must also be<br />

running on the Server (<strong>Huron</strong>).<br />

in const char* szPath Full path of workspace file<br />

out long* plStatus<br />

out char* szPath<br />

<strong>SNAP</strong>GetStatus<br />

This command returns the current operating status of the <strong>Huron</strong>.<br />

<strong>SNAP</strong>GetWorkspace<br />

To find the currently loaded workspace in VRack send this<br />

command. The VRack application will send a<br />

<strong>Huron</strong>GetWorkspace command back to the remote computer<br />

with the path field set to the full path of the current workspace<br />

file. VRack must be running.<br />

HURON TECHNICAL MANUAL PAGE 160

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!