Vuo  2.3.2
Classes | Macros | Enumerations | Functions
VuoVideoInputDevice

Description

Information about a video input device.

Classes

struct  VuoVideoInputDevice
 Information about a video input device. More...
 

Enumerations

enum  VuoVideoInputDevice_MatchType { VuoVideoInputDevice_MatchIdThenName , VuoVideoInputDevice_MatchId }
 Which field to match on. More...
 

Functions

VuoVideoInputDevice VuoVideoInputDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoVideoInputDevice_getJson (const VuoVideoInputDevice value)
 Encodes value as a JSON object. More...
 
char * VuoVideoInputDevice_getSummary (const VuoVideoInputDevice value)
 Returns a compact string representation of value. More...
 
bool VuoVideoInputDevice_areEqual (VuoVideoInputDevice value1, VuoVideoInputDevice value2)
 Returns true if the two video input device specifications are identical. More...
 
bool VuoVideoInputDevice_isLessThan (const VuoVideoInputDevice a, const VuoVideoInputDevice b)
 Returns true if a < b. More...
 
static VuoVideoInputDevice VuoVideoInputDevice_make (VuoText id, VuoText name) __attribute__((const))
 Returns a video input device with the specified values. More...
 
VuoVideoInputDevice VuoVideoInputDevice_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoVideoInputDevice_getString (const VuoVideoInputDevice value)
 Automatically generated function. More...
 
void VuoVideoInputDevice_retain (VuoVideoInputDevice value)
 Automatically generated function. More...
 
void VuoVideoInputDevice_release (VuoVideoInputDevice value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoVideoInputDevice

struct VuoVideoInputDevice
Class Members
VuoText id [QtCaptureDevice modelUniqueID]
VuoVideoInputDevice_MatchType matchType Which field to use for matching a VuoVideoInputDevice structure to an actual device.
VuoText name [QtCaptureDevice localizedDisplayName]

Enumeration Type Documentation

◆ VuoVideoInputDevice_MatchType

Which field to match on.

Definition at line 25 of file VuoVideoInputDevice.h.

Function Documentation

◆ VuoVideoInputDevice_areEqual()

bool VuoVideoInputDevice_areEqual ( VuoVideoInputDevice  value1,
VuoVideoInputDevice  value2 
)

Returns true if the two video input device specifications are identical.

Definition at line 119 of file VuoVideoInputDevice.c.

◆ VuoVideoInputDevice_getJson()

struct json_object* VuoVideoInputDevice_getJson ( const VuoVideoInputDevice  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoVideoInputDevice.c.

◆ VuoVideoInputDevice_getString()

char* VuoVideoInputDevice_getString ( const VuoVideoInputDevice  value)

Automatically generated function.

◆ VuoVideoInputDevice_getSummary()

char* VuoVideoInputDevice_getSummary ( const VuoVideoInputDevice  value)

Returns a compact string representation of value.

Definition at line 103 of file VuoVideoInputDevice.c.

◆ VuoVideoInputDevice_isLessThan()

bool VuoVideoInputDevice_isLessThan ( const VuoVideoInputDevice  a,
const VuoVideoInputDevice  b 
)

Returns true if a < b.

Changed in Vuo 2.0.0:
New.

Definition at line 130 of file VuoVideoInputDevice.c.

◆ VuoVideoInputDevice_make()

static VuoVideoInputDevice VuoVideoInputDevice_make ( VuoText  id,
VuoText  name 
) const
inlinestatic

Returns a video input device with the specified values.

Definition at line 64 of file VuoVideoInputDevice.h.

◆ VuoVideoInputDevice_makeFromJson()

VuoVideoInputDevice VuoVideoInputDevice_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"id" : "",
"name" : ""
}

Definition at line 60 of file VuoVideoInputDevice.c.

◆ VuoVideoInputDevice_makeFromString()

VuoVideoInputDevice VuoVideoInputDevice_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoVideoInputDevice_release()

void VuoVideoInputDevice_release ( VuoVideoInputDevice  value)

Automatically generated function.

◆ VuoVideoInputDevice_retain()

void VuoVideoInputDevice_retain ( VuoVideoInputDevice  value)

Automatically generated function.