vasingletondoc.hpp 1.13 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 *  --------------------------------------------------------------------------------------------
 *
 *    VVV        VVV A           Virtual Acoustics (VA) | http://www.virtualacoustics.org
 *     VVV      VVV AAA          Licensed under the Apache License, Version 2.0
 *      VVV    VVV   AAA
 *       VVV  VVV     AAA        Copyright 2015-2018
 *        VVVVVV       AAA       Institute of Technical Acoustics (ITA)
 *         VVVV         AAA      RWTH Aachen University
 *
 *  --------------------------------------------------------------------------------------------
 */

14 15
#include <Python.h>

16
PyDoc_STRVAR( module_doc,
17 18 19
	"connect(server, port) - connect to a VA server at given server and listening port\n"
	"disconnect() - disconnect from VA server." );

20
PyDoc_STRVAR( no_doc,
21 22 23
	"For this method no dedicated documentation is available. Please read the C++ API documentation\n"
	"of this method for further information." );

24
PyDoc_STRVAR( connect_doc,
25 26 27 28 29 30 31 32 33
	"Connect($module, /, server, port)\n"
	"--\n"
	"\n"
	"Connect to a VA server.\n"
	"\n"
	"  server\n"
	"    Remote server IP.\n"
	"  port\n"
	"    TCP/IP listening port, usually 12340." );