Description

VuoSyphon implementation.

Copyright: Copyright © 2012–2023 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoSyphon.m.

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.

void	VuoSyphonClient_free (void *syphonClient)
	Frees memory.

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.

void	VuoSyphonServer_free (void *server)
	Makes the Syphon server unavailable, and frees memory.

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.

Function Documentation

◆ VuoSyphon_filterServerDescriptions()

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.

◆ VuoSyphon_getAvailableServerDescriptions()

VuoList_VuoSyphonServerDescription VuoSyphon_getAvailableServerDescriptions ( void )

Returns a list of all available Syphon servers.

Definition at line 35 of file VuoSyphon.m.

◆ VuoSyphonClient_connectToServer()

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.

◆ VuoSyphonClient_disconnectFromServer()

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_free()

void VuoSyphonClient_free ( void * syphonClient )

Frees memory.

Definition at line 128 of file VuoSyphon.m.

◆ VuoSyphonClient_make()

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_free()

void VuoSyphonServer_free ( void * server )

Makes the Syphon server unavailable, and frees memory.

Definition at line 180 of file VuoSyphon.m.

◆ VuoSyphonServer_make()

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.

Parameters

serverName The server name.

Returns: The Syphon server.

Definition at line 146 of file VuoSyphon.m.

◆ VuoSyphonServer_publishFrame()

void VuoSyphonServer_publishFrame	(	VuoSyphonServer	server,
		VuoImage	frame
	)

Publishes a frame from the Syphon server.

Definition at line 161 of file VuoSyphon.m.

◆ VuoSyphonServer_setName()

void VuoSyphonServer_setName	(	VuoSyphonServer	server,
		const char *	serverName
	)

Changes the name of the Syphon server.

Definition at line 169 of file VuoSyphon.m.