VuoSyphonListener Class Reference

Description

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

Definition at line 22 of file VuoSyphonListener.h.

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

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

Properties
SyphonClient *	syphonClient
	The Syphon client that receives frames. More...

Method Documentation

init

- (id) init

(void)

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

Definition at line 59 of file VuoSyphonListener.m.

refreshSyphonClient:

- (void) refreshSyphonClient:

(VuoList_VuoSyphonServerDescription)

serverDescriptions

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

Definition at line 59 of file VuoSyphonListener.m.

refreshSyphonClientThreadUnsafe:

- (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.

Definition at line 59 of file VuoSyphonListener.m.

startListeningWithServerDescription:callback:

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

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

Definition at line 59 of file VuoSyphonListener.m.

stopListening

- (void) stopListening

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

Definition at line 59 of file VuoSyphonListener.m.

Member Data Documentation

callback

- (void(* callback) (VuoImage))

protected

Called when a frame is received.

Definition at line 24 of file VuoSyphonListener.h.

desiredServer

- (VuoSyphonServerDescription) desiredServer

protected

A description of the Syphon server to connect to.

Definition at line 26 of file VuoSyphonListener.h.

refreshQueue

- (dispatch_queue_t) refreshQueue

protected

Synchronizes changes to member variables.

Definition at line 27 of file VuoSyphonListener.h.

serverNotifier

- (VuoSyphonServerNotifier*) serverNotifier

protected

Used to track changes to the available Syphon servers.

Definition at line 25 of file VuoSyphonListener.h.

Property Documentation

syphonClient

- (SyphonClient*) syphonClient

readwriteatomicretain

The Syphon client that receives frames.

Definition at line 30 of file VuoSyphonListener.h.

---

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

• node/vuo.syphon/VuoSyphonListener.h
• node/vuo.syphon/VuoSyphonListener.m