VuoSyphon implementation.
Definition in file VuoSyphon.h.
Go to the source code of this file.
Typedefs | |
typedef void * | VuoSyphonClient |
Receives frames via Syphon from a Syphon server. | |
typedef void * | VuoSyphonServer |
Sends frames via Syphon to a Syphon client. | |
Functions | |
VuoList_VuoSyphonServerDescription | VuoSyphon_getAvailableServerDescriptions (void) |
Returns a list of all available Syphon servers. | |
VuoList_VuoSyphonServerDescription | VuoSyphon_filterServerDescriptions (VuoList_VuoSyphonServerDescription allDescriptions, VuoSyphonServerDescription partialDescription) |
Returns the subset of server descriptions that match the given partial description. | |
VuoSyphonClient | VuoSyphonClient_make (void) |
Creates a Syphon client that is not yet connected to any server. | |
void | VuoSyphonClient_connectToServer (VuoSyphonClient syphonClient, VuoSyphonServerDescription serverDescription, VuoOutputTrigger(receivedFrame, VuoImage)) |
Starts listening for frames from the Syphon server (or continues if already connected). | |
void | VuoSyphonClient_disconnectFromServer (VuoSyphonClient syphonClient) |
Stops the Syphon client from listening for frames from its server. | |
VuoSyphonServer | VuoSyphonServer_make (const char *serverName) |
Creates and starts a Syphon server, making it available for clients to connect to. | |
void | VuoSyphonServer_publishFrame (VuoSyphonServer server, VuoImage frame) |
Publishes a frame from the Syphon server. | |
void | VuoSyphonServer_setName (VuoSyphonServer server, const char *serverName) |
Changes the name of the Syphon server. | |
typedef void* VuoSyphonClient |
Receives frames via Syphon from a Syphon server.
Definition at line 26 of file VuoSyphon.h.
typedef void* VuoSyphonServer |
Sends frames via Syphon to a Syphon client.
Definition at line 34 of file VuoSyphon.h.
VuoList_VuoSyphonServerDescription VuoSyphon_filterServerDescriptions | ( | VuoList_VuoSyphonServerDescription | allDescriptions, |
VuoSyphonServerDescription | partialDescription | ||
) |
Returns the subset of server descriptions that match the given partial description.
A server description is considered a match if its UUID, name, and application name contain the UUID, name, and application name in the partial description.
Definition at line 59 of file VuoSyphon.m.
VuoList_VuoSyphonServerDescription VuoSyphon_getAvailableServerDescriptions | ( | void | ) |
Returns a list of all available Syphon servers.
Definition at line 35 of file VuoSyphon.m.
void VuoSyphonClient_connectToServer | ( | VuoSyphonClient | syphonClient, |
VuoSyphonServerDescription | serverDescription, | ||
VuoOutputTrigger(receivedFrame, VuoImage) | |||
) |
Starts listening for frames from the Syphon server (or continues if already connected).
Each time a frame is received, the given trigger function is called.
Definition at line 107 of file VuoSyphon.m.
void VuoSyphonClient_disconnectFromServer | ( | VuoSyphonClient | syphonClient | ) |
Stops the Syphon client from listening for frames from its server.
Definition at line 119 of file VuoSyphon.m.
VuoSyphonClient VuoSyphonClient_make | ( | void | ) |
Creates a Syphon client that is not yet connected to any server.
Definition at line 95 of file VuoSyphon.m.
VuoSyphonServer VuoSyphonServer_make | ( | const char * | serverName | ) |
Creates and starts a Syphon server, making it available for clients to connect to.
Retain the returned VuoSyphonServer, then later release it to stop serving.
serverName | The server name. |
Definition at line 146 of file VuoSyphon.m.
void VuoSyphonServer_publishFrame | ( | VuoSyphonServer | server, |
VuoImage | frame | ||
) |
Publishes a frame from the Syphon server.
Definition at line 161 of file VuoSyphon.m.
void VuoSyphonServer_setName | ( | VuoSyphonServer | server, |
const char * | serverName | ||
) |
Changes the name of the Syphon server.
Definition at line 169 of file VuoSyphon.m.