Warning
This version of the documentation is NOT an official release. You are looking at ‘latest’, which is in active and ongoing development. You can change versions on the bottom left of the screen.
music_message_in_proxy – A device which receives message strings from MUSIC¶
Description¶
A music_message_in_proxy can be used to receive message strings from remote MUSIC applications in NEST.
It uses the MUSIC library to receive message strings from other applications. The music_message_in_proxy represents an input port to which MUSIC can connect a message source. The music_message_in_proxy can queried using GetStatus to retrieve the messages.
To clear the data array, the parameter n_messages can be set to 0.
This model is only available if NEST was compiled with MUSIC.
Parameters¶
The following properties are available in the status dictionary:
port_name |
string |
The name of the MUSIC input port to listen to (default: message_in) |
port_width |
integer |
The width of the MUSIC input port |
data |
array |
A sub-dictionary that contains the string messages in the form of two arrays: messages - The strings message_times - The times the messages were sent (ms) |
n_messages |
integer |
The number of messages |
published |
boolean |
A bool indicating if the port has been already published with MUSIC |