Vuo  1.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Instance Methods | Protected Attributes | Properties | List of all members
VuoSyphonListener Class Reference

Description

This class handles connecting to and receiving frames from a Syphon server.

Instance Methods

(id) - init
 Creates a Syphon client that is not yet connected to any server.
 
(void) - startListeningWithServerDescription:callback:
 Starts listening for frames from the Syphon server (or continues if already connected).
 
(void) - stopListening
 Disconnects the Syphon client from its server, making it stop receiving frames.
 
(void) - refreshSyphonClientThreadUnsafe:
 Updates the connected server in response to changes to the desired server or available servers.
 
(void) - refreshSyphonClient:
 Updates the connected server in response to changes to the desired server or available servers.
 

Protected Attributes

void(* callback )(VuoImage)
 Called when a frame is received.
 
VuoSyphonServerNotifierserverNotifier
 Used to track changes to the available Syphon servers.
 
VuoSyphonServerDescription desiredServer
 A description of the Syphon server to connect to.
 
dispatch_queue_t refreshQueue
 Synchronizes changes to member variables.
 

Properties

SyphonClient * syphonClient
 The Syphon client that receives frames.
 

Method Documentation

- (id) init

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

- (void) refreshSyphonClient: (VuoList_VuoSyphonServerDescription serverDescriptions

Updates the connected server in response to changes to the desired server or available servers.

- (void) refreshSyphonClientThreadUnsafe: (VuoList_VuoSyphonServerDescription serverDescriptions

Updates the connected server in response to changes to the desired server or available servers.

This function may only be called on dispatch queue refreshQueue.

- (void) startListeningWithServerDescription: (VuoSyphonServerDescription description
callback: (VuoImage receivedFrame 

Starts listening for frames from the Syphon server (or continues if already connected).

- (void) stopListening

Disconnects the Syphon client from its server, making it stop receiving frames.

Member Data Documentation

- (void(* callback)(VuoImage))
protected

Called when a frame is received.

- (VuoSyphonServerDescription) desiredServer
protected

A description of the Syphon server to connect to.

- (dispatch_queue_t) refreshQueue
protected

Synchronizes changes to member variables.

- (VuoSyphonServerNotifier*) serverNotifier
protected

Used to track changes to the available Syphon servers.

Property Documentation

- (SyphonClient*) syphonClient
readwriteatomicretain

The Syphon client that receives frames.


The documentation for this class was generated from the following files: