Vuo  0.8.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Typedefs | Functions
VuoSyphon.h File Reference

Description

VuoSyphon implementation.

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, VuoGlContext *glContext)
 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 Documentation

typedef void* VuoSyphonClient

Receives frames via Syphon from a Syphon server.

typedef void* VuoSyphonServer

Sends frames via Syphon to a Syphon client.

Function Documentation

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.

Todo:
Handle UTF8 names (add VuoText function).
VuoList_VuoSyphonServerDescription VuoSyphon_getAvailableServerDescriptions ( void  )

Returns a list of all available Syphon servers.

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.

void VuoSyphonClient_disconnectFromServer ( VuoSyphonClient  syphonClient)

Stops the Syphon client from listening for frames from its server.

VuoSyphonClient VuoSyphonClient_make ( void  )

Creates a Syphon client that is not yet connected to any server.

VuoSyphonServer VuoSyphonServer_make ( const char *  serverName,
VuoGlContext glContext 
)

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.

Parameters
serverNameThe server name.
glContextThe GL context to use when publishing frames.
Returns
The Syphon server.
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.