WpSpaPod
Wp.SpaPod
Wp.SpaPod
Constructors
wp_spa_pod_new_boolean
WpSpaPod * wp_spa_pod_new_boolean (gboolean value)
Creates a spa pod of type boolean
Parameters:
value
–
the boolean value
The new spa pod
wp_spa_pod_new_bytes
WpSpaPod * wp_spa_pod_new_bytes (gconstpointer value, guint32 len)
Creates a spa pod of type bytes
Parameters:
value
–
the bytes value
len
–
the length of the bytes value
The new spa pod
Wp.SpaPod.new_bytes
def Wp.SpaPod.new_bytes (value, len):
#python wrapper for 'wp_spa_pod_new_bytes'
Creates a spa pod of type bytes
The new spa pod
wp_spa_pod_new_choice_valist
WpSpaPod * wp_spa_pod_new_choice_valist (const char* type_name, va_list args)
This is the va_list
version of wp_spa_pod_new_choice
Parameters:
type_name
–
the type name of the choice type
args
–
the variable arguments passed to wp_spa_pod_new_choice
The new spa pod
wp_spa_pod_new_double
WpSpaPod * wp_spa_pod_new_double (double value)
Creates a spa pod of type double
Parameters:
value
–
the double value
The new spa pod
wp_spa_pod_new_fd
WpSpaPod * wp_spa_pod_new_fd (gint64 value)
Creates a spa pod of type Fd
Parameters:
value
–
the Fd value
The new spa pod
wp_spa_pod_new_float
WpSpaPod * wp_spa_pod_new_float (float value)
Creates a spa pod of type float
Parameters:
value
–
the float value
The new spa pod
wp_spa_pod_new_fraction
WpSpaPod * wp_spa_pod_new_fraction (guint32 num, guint32 denom)
Creates a spa pod of type fraction
Parameters:
num
–
the numerator value of the fraction
denom
–
the denominator value of the fraction
The new spa pod
Wp.SpaPod.new_fraction
def Wp.SpaPod.new_fraction (num, denom):
#python wrapper for 'wp_spa_pod_new_fraction'
Creates a spa pod of type fraction
Parameters:
num
(
int
)
–
the numerator value of the fraction
denom
(
int
)
–
the denominator value of the fraction
The new spa pod
Wp.SpaPod.prototype.new_fraction
function Wp.SpaPod.prototype.new_fraction(num: Number, denom: Number): {
// javascript wrapper for 'wp_spa_pod_new_fraction'
}
Creates a spa pod of type fraction
Parameters:
num
(
Number
)
–
the numerator value of the fraction
denom
(
Number
)
–
the denominator value of the fraction
The new spa pod
wp_spa_pod_new_id
WpSpaPod * wp_spa_pod_new_id (guint32 value)
Creates a spa pod of type Id
Parameters:
value
–
the Id value
The new spa pod
wp_spa_pod_new_int
WpSpaPod * wp_spa_pod_new_int (gint value)
Creates a spa pod of type int
Parameters:
value
–
the int value
The new spa pod
wp_spa_pod_new_long
WpSpaPod * wp_spa_pod_new_long (glong value)
Creates a spa pod of type long
Parameters:
value
–
the long value
The new spa pod
wp_spa_pod_new_none
WpSpaPod * wp_spa_pod_new_none ()
Creates a spa pod of type None
The new spa pod
Wp.SpaPod.new_none
def Wp.SpaPod.new_none ():
#python wrapper for 'wp_spa_pod_new_none'
Creates a spa pod of type None
The new spa pod
Wp.SpaPod.prototype.new_none
function Wp.SpaPod.prototype.new_none(): {
// javascript wrapper for 'wp_spa_pod_new_none'
}
Creates a spa pod of type None
The new spa pod
wp_spa_pod_new_object
WpSpaPod * wp_spa_pod_new_object (const char* type_name, const char* id_name, ... ...)
Creates a spa pod of type object
Parameters:
type_name
–
the type name of the object type
id_name
–
the id name of the object
...
–
a list of object properties with their values, followed by NULL
The new spa pod
wp_spa_pod_new_object_valist
WpSpaPod * wp_spa_pod_new_object_valist (const char* type_name, const char* id_name, va_list args)
This is the va_list
version of wp_spa_pod_new_object
Parameters:
type_name
–
the type name of the object type
id_name
–
the id name of the object
args
–
the variable arguments passed to wp_spa_pod_new_object
The new spa pod
wp_spa_pod_new_pointer
WpSpaPod * wp_spa_pod_new_pointer (const char* type_name, gconstpointer value)
Creates a spa pod of type pointer
Parameters:
type_name
–
the type name the pointer points to
value
–
the pointer value
The new spa pod
Wp.SpaPod.new_pointer
def Wp.SpaPod.new_pointer (type_name, value):
#python wrapper for 'wp_spa_pod_new_pointer'
Creates a spa pod of type pointer
Parameters:
type_name
(
str
)
–
the type name the pointer points to
value
(
object
)
–
the pointer value
The new spa pod
Wp.SpaPod.prototype.new_pointer
function Wp.SpaPod.prototype.new_pointer(type_name: String, value: Object): {
// javascript wrapper for 'wp_spa_pod_new_pointer'
}
Creates a spa pod of type pointer
Parameters:
type_name
(
String
)
–
the type name the pointer points to
value
(
Object
)
–
the pointer value
The new spa pod
wp_spa_pod_new_rectangle
WpSpaPod * wp_spa_pod_new_rectangle (guint32 width, guint32 height)
Creates a spa pod of type rectangle
Parameters:
width
–
the width value of the rectangle
height
–
the height value of the rectangle
The new spa pod
Wp.SpaPod.new_rectangle
def Wp.SpaPod.new_rectangle (width, height):
#python wrapper for 'wp_spa_pod_new_rectangle'
Creates a spa pod of type rectangle
Parameters:
width
(
int
)
–
the width value of the rectangle
height
(
int
)
–
the height value of the rectangle
The new spa pod
Wp.SpaPod.prototype.new_rectangle
function Wp.SpaPod.prototype.new_rectangle(width: Number, height: Number): {
// javascript wrapper for 'wp_spa_pod_new_rectangle'
}
Creates a spa pod of type rectangle
Parameters:
width
(
Number
)
–
the width value of the rectangle
height
(
Number
)
–
the height value of the rectangle
The new spa pod
wp_spa_pod_new_sequence_valist
WpSpaPod * wp_spa_pod_new_sequence_valist (guint unit, va_list args)
This is the va_list
version of wp_spa_pod_new_sequence
Parameters:
unit
–
the unit of the sequence
args
–
the variable arguments passed to wp_spa_pod_new_sequence
The new spa pod
wp_spa_pod_new_string
WpSpaPod * wp_spa_pod_new_string (const char* value)
Creates a spa pod of type string
Parameters:
value
–
the string value
The new spa pod
Methods
wp_spa_pod_copy
WpSpaPod * wp_spa_pod_copy (WpSpaPod * other)
Copies a spa pod object
Parameters:
other
–
a spa pod object
The newly copied spa pod
wp_spa_pod_ensure_unique_owner
WpSpaPod * wp_spa_pod_ensure_unique_owner (WpSpaPod * self)
Parameters:
self
–
wp_spa_pod_equal
gboolean wp_spa_pod_equal (WpSpaPod * self, WpSpaPod * pod)
Checks whether two spa pod objects have the same value or not
Parameters:
self
–
the spa pod object
pod
–
the pod with the value to be compared with
TRUE if both spa pod objects have the same values, FALSE othewrise.
Wp.SpaPod.equal
def Wp.SpaPod.equal (self, pod):
#python wrapper for 'wp_spa_pod_equal'
Checks whether two spa pod objects have the same value or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
pod
(
Wp.SpaPod
)
–
the pod with the value to be compared with
TRUE if both spa pod objects have the same values, FALSE othewrise.
Wp.SpaPod.prototype.equal
function Wp.SpaPod.prototype.equal(pod: Wp.SpaPod): {
// javascript wrapper for 'wp_spa_pod_equal'
}
Checks whether two spa pod objects have the same value or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
pod
(
Wp.SpaPod
)
–
the pod with the value to be compared with
TRUE if both spa pod objects have the same values, FALSE othewrise.
wp_spa_pod_get_array_child
WpSpaPod * wp_spa_pod_get_array_child (WpSpaPod * self)
Gets the child of a spa pod array object
Parameters:
self
–
a spa pod choice object
the child of the spa pod array object
Wp.SpaPod.get_array_child
def Wp.SpaPod.get_array_child (self):
#python wrapper for 'wp_spa_pod_get_array_child'
Gets the child of a spa pod array object
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod choice object
the child of the spa pod array object
Wp.SpaPod.prototype.get_array_child
function Wp.SpaPod.prototype.get_array_child(): {
// javascript wrapper for 'wp_spa_pod_get_array_child'
}
Gets the child of a spa pod array object
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod choice object
the child of the spa pod array object
wp_spa_pod_get_boolean
gboolean wp_spa_pod_get_boolean (WpSpaPod * self, gboolean * value)
Gets the boolean value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the boolean value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_boolean
def Wp.SpaPod.get_boolean (self):
#python wrapper for 'wp_spa_pod_get_boolean'
Gets the boolean value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
bool
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_boolean
function Wp.SpaPod.prototype.get_boolean(): {
// javascript wrapper for 'wp_spa_pod_get_boolean'
}
Gets the boolean value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_bytes
gboolean wp_spa_pod_get_bytes (WpSpaPod * self, gconstpointer * value, guint32 * len)
Gets the bytes value and its len of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the bytes value
len
(
[out]
)
–
the length of the bytes value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_bytes
def Wp.SpaPod.get_bytes (self):
#python wrapper for 'wp_spa_pod_get_bytes'
Gets the bytes value and its len of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
object
)
–
TRUE if the value was obtained, FALSE otherwise
len
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_bytes
function Wp.SpaPod.prototype.get_bytes(): {
// javascript wrapper for 'wp_spa_pod_get_bytes'
}
Gets the bytes value and its len of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Object
)
–
TRUE if the value was obtained, FALSE otherwise
len
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_choice_child
WpSpaPod * wp_spa_pod_get_choice_child (WpSpaPod * self)
Gets the child of a spa pod choice object
Parameters:
self
–
a spa pod choice object
the child of the spa pod choice object
Wp.SpaPod.get_choice_child
def Wp.SpaPod.get_choice_child (self):
#python wrapper for 'wp_spa_pod_get_choice_child'
Gets the child of a spa pod choice object
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod choice object
the child of the spa pod choice object
Wp.SpaPod.prototype.get_choice_child
function Wp.SpaPod.prototype.get_choice_child(): {
// javascript wrapper for 'wp_spa_pod_get_choice_child'
}
Gets the child of a spa pod choice object
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod choice object
the child of the spa pod choice object
wp_spa_pod_get_choice_type_name
const char* wp_spa_pod_get_choice_type_name (WpSpaPod * self)
Parameters:
self
–
wp_spa_pod_get_control
gboolean wp_spa_pod_get_control (WpSpaPod * self, guint32 * offset, const char** type_name, WpSpaPod ** value)
Gets the offset, type name and spa pod value of a spa pod control
Parameters:
self
–
the spa pod object
offset
(
[out]
[optional]
)
–
the offset of the control
type_name
(
[out]
[optional]
)
–
the type name of the control
value
(
[out]
[optional]
)
–
the spa pod value of the control
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_control
def Wp.SpaPod.get_control (self):
#python wrapper for 'wp_spa_pod_get_control'
Gets the offset, type name and spa pod value of a spa pod control
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
offset
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
type_name
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Wp.SpaPod
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_control
function Wp.SpaPod.prototype.get_control(): {
// javascript wrapper for 'wp_spa_pod_get_control'
}
Gets the offset, type name and spa pod value of a spa pod control
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
offset
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
type_name
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Wp.SpaPod
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_double
gboolean wp_spa_pod_get_double (WpSpaPod * self, double* value)
Gets the double value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the double value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_double
def Wp.SpaPod.get_double (self):
#python wrapper for 'wp_spa_pod_get_double'
Gets the double value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
float
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_double
function Wp.SpaPod.prototype.get_double(): {
// javascript wrapper for 'wp_spa_pod_get_double'
}
Gets the double value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_fd
gboolean wp_spa_pod_get_fd (WpSpaPod * self, gint64 * value)
Gets the Fd value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the Fd value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_fd
def Wp.SpaPod.get_fd (self):
#python wrapper for 'wp_spa_pod_get_fd'
Gets the Fd value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_fd
function Wp.SpaPod.prototype.get_fd(): {
// javascript wrapper for 'wp_spa_pod_get_fd'
}
Gets the Fd value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_float
gboolean wp_spa_pod_get_float (WpSpaPod * self, float* value)
Gets the float value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the float value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_float
def Wp.SpaPod.get_float (self):
#python wrapper for 'wp_spa_pod_get_float'
Gets the float value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
float
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_float
function Wp.SpaPod.prototype.get_float(): {
// javascript wrapper for 'wp_spa_pod_get_float'
}
Gets the float value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_fraction
gboolean wp_spa_pod_get_fraction (WpSpaPod * self, guint32 * num, guint32 * denom)
Gets the fractions's numerator and denominator value of a spa pod object
Parameters:
self
–
the spa pod object
num
(
[out]
)
–
the fractions's numerator value
denom
(
[out]
)
–
the fractions's denominator value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_fraction
def Wp.SpaPod.get_fraction (self):
#python wrapper for 'wp_spa_pod_get_fraction'
Gets the fractions's numerator and denominator value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
num
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
denom
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_fraction
function Wp.SpaPod.prototype.get_fraction(): {
// javascript wrapper for 'wp_spa_pod_get_fraction'
}
Gets the fractions's numerator and denominator value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
num
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
denom
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_id
gboolean wp_spa_pod_get_id (WpSpaPod * self, guint32 * value)
Gets the Id value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the Id value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_id
def Wp.SpaPod.get_id (self):
#python wrapper for 'wp_spa_pod_get_id'
Gets the Id value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_id
function Wp.SpaPod.prototype.get_id(): {
// javascript wrapper for 'wp_spa_pod_get_id'
}
Gets the Id value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_int
gboolean wp_spa_pod_get_int (WpSpaPod * self, gint * value)
Gets the int value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the int value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_int
def Wp.SpaPod.get_int (self):
#python wrapper for 'wp_spa_pod_get_int'
Gets the int value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_int
function Wp.SpaPod.prototype.get_int(): {
// javascript wrapper for 'wp_spa_pod_get_int'
}
Gets the int value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_long
gboolean wp_spa_pod_get_long (WpSpaPod * self, glong * value)
Gets the long value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the long value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_long
def Wp.SpaPod.get_long (self):
#python wrapper for 'wp_spa_pod_get_long'
Gets the long value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_long
function Wp.SpaPod.prototype.get_long(): {
// javascript wrapper for 'wp_spa_pod_get_long'
}
Gets the long value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_object
gboolean wp_spa_pod_get_object (WpSpaPod * self, const char* type_name, const char** id_name, ... ...)
Gets the object properties values of a spa pod object
Parameters:
self
–
the spa pod object
type_name
–
the type name of the object type
id_name
(
[out]
)
–
the id name of the object
...
(
[out]
)
–
the list of the object properties values, followed by NULL
TRUE if the object properties values were obtained, FALSE otherwise
wp_spa_pod_get_object_type_name
const char* wp_spa_pod_get_object_type_name (WpSpaPod * self)
Parameters:
self
–
wp_spa_pod_get_object_valist
gboolean wp_spa_pod_get_object_valist (WpSpaPod * self, const char* type_name, const char** id_name, va_list args)
This is the va_list
version of wp_spa_pod_get_object
Parameters:
self
–
the spa pod object
type_name
–
the type name of the object type
id_name
(
[out]
)
–
the id name of the object
args
(
[out]
)
–
the variable arguments passed to wp_spa_pod_get_object
TRUE if the object properties values were obtained, FALSE otherwise
wp_spa_pod_get_pointer
gboolean wp_spa_pod_get_pointer (WpSpaPod * self, const char** type_name, gconstpointer * value)
Gets the pointer value and its type name of a spa pod object
Parameters:
self
–
the spa pod object
type_name
(
[out]
)
–
the type name of the pointer value
value
(
[out]
)
–
the pointer value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_pointer
def Wp.SpaPod.get_pointer (self):
#python wrapper for 'wp_spa_pod_get_pointer'
Gets the pointer value and its type name of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
type_name
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
object
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_pointer
function Wp.SpaPod.prototype.get_pointer(): {
// javascript wrapper for 'wp_spa_pod_get_pointer'
}
Gets the pointer value and its type name of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
type_name
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Object
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_property
gboolean wp_spa_pod_get_property (WpSpaPod * self, const char** key, WpSpaPod ** value)
Gets the name, flags and spa pod value of a spa pod property
Parameters:
self
–
the spa pod object
key
(
[out]
[optional]
)
–
the name of the property
value
(
[out]
[optional]
)
–
the spa pod value of the property
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_property
def Wp.SpaPod.get_property (self):
#python wrapper for 'wp_spa_pod_get_property'
Gets the name, flags and spa pod value of a spa pod property
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
key
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Wp.SpaPod
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_property
function Wp.SpaPod.prototype.get_property(): {
// javascript wrapper for 'wp_spa_pod_get_property'
}
Gets the name, flags and spa pod value of a spa pod property
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
key
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Wp.SpaPod
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_rectangle
gboolean wp_spa_pod_get_rectangle (WpSpaPod * self, guint32 * width, guint32 * height)
Gets the rectangle's width and height value of a spa pod object
Parameters:
self
–
the spa pod object
width
(
[out]
)
–
the rectangle's width value
height
(
[out]
)
–
the rectangle's height value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_rectangle
def Wp.SpaPod.get_rectangle (self):
#python wrapper for 'wp_spa_pod_get_rectangle'
Gets the rectangle's width and height value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
width
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
height
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_rectangle
function Wp.SpaPod.prototype.get_rectangle(): {
// javascript wrapper for 'wp_spa_pod_get_rectangle'
}
Gets the rectangle's width and height value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
width
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
height
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_string
gboolean wp_spa_pod_get_string (WpSpaPod * self, const char** value)
Gets the string value of a spa pod object
Parameters:
self
–
the spa pod object
value
(
[out]
)
–
the string value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.get_string
def Wp.SpaPod.get_string (self):
#python wrapper for 'wp_spa_pod_get_string'
Gets the string value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPod.prototype.get_string
function Wp.SpaPod.prototype.get_string(): {
// javascript wrapper for 'wp_spa_pod_get_string'
}
Gets the string value of a spa pod object
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_get_struct_valist
gboolean wp_spa_pod_get_struct_valist (WpSpaPod * self, va_list args)
This is the va_list
version of wp_spa_pod_get_struct
Parameters:
self
–
the spa pod object
args
(
[out]
)
–
the variable arguments passed to wp_spa_pod_get_struct
TRUE if the struct values were obtained, FALSE otherwise
wp_spa_pod_get_type_name
const char* wp_spa_pod_get_type_name (WpSpaPod * self)
Gets the type name of the spa pod object
Parameters:
self
–
a spa pod object
the type name of the spa pod object
wp_spa_pod_is_array
gboolean wp_spa_pod_is_array (WpSpaPod * self)
Checks wether the spa pod is of type array or not
Parameters:
self
–
the spa pod object
TRUE if it is of type array, FALSE otherwise
wp_spa_pod_is_boolean
gboolean wp_spa_pod_is_boolean (WpSpaPod * self)
Checks wether the spa pod is of type boolean or not
Parameters:
self
–
the spa pod object
TRUE if it is of type boolean, FALSE otherwise
wp_spa_pod_is_bytes
gboolean wp_spa_pod_is_bytes (WpSpaPod * self)
Checks wether the spa pod is of type bytes or not
Parameters:
self
–
the spa pod object
TRUE if it is of type bytes, FALSE otherwise
wp_spa_pod_is_choice
gboolean wp_spa_pod_is_choice (WpSpaPod * self)
Checks wether the spa pod is of type choice or not
Parameters:
self
–
the spa pod object
TRUE if it is of type choice, FALSE otherwise
wp_spa_pod_is_control
gboolean wp_spa_pod_is_control (WpSpaPod * self)
Checks wether the spa pod is of type control or not
Parameters:
self
–
the spa pod object
TRUE if it is of type control, FALSE otherwise
wp_spa_pod_is_double
gboolean wp_spa_pod_is_double (WpSpaPod * self)
Checks wether the spa pod is of type double or not
Parameters:
self
–
the spa pod object
TRUE if it is of type double, FALSE otherwise
wp_spa_pod_is_fd
gboolean wp_spa_pod_is_fd (WpSpaPod * self)
Checks wether the spa pod is of type Fd or not
Parameters:
self
–
the spa pod object
TRUE if it is of type Fd, FALSE otherwise
wp_spa_pod_is_float
gboolean wp_spa_pod_is_float (WpSpaPod * self)
Checks wether the spa pod is of type float or not
Parameters:
self
–
the spa pod object
TRUE if it is of type float, FALSE otherwise
wp_spa_pod_is_fraction
gboolean wp_spa_pod_is_fraction (WpSpaPod * self)
Checks wether the spa pod is of type fraction or not
Parameters:
self
–
the spa pod object
TRUE if it is of type fraction, FALSE otherwise
Wp.SpaPod.is_fraction
def Wp.SpaPod.is_fraction (self):
#python wrapper for 'wp_spa_pod_is_fraction'
Checks wether the spa pod is of type fraction or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type fraction, FALSE otherwise
Wp.SpaPod.prototype.is_fraction
function Wp.SpaPod.prototype.is_fraction(): {
// javascript wrapper for 'wp_spa_pod_is_fraction'
}
Checks wether the spa pod is of type fraction or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type fraction, FALSE otherwise
wp_spa_pod_is_id
gboolean wp_spa_pod_is_id (WpSpaPod * self)
Checks wether the spa pod is of type Id or not
Parameters:
self
–
the spa pod object
TRUE if it is of type Id, FALSE otherwise
wp_spa_pod_is_int
gboolean wp_spa_pod_is_int (WpSpaPod * self)
Checks wether the spa pod is of type int or not
Parameters:
self
–
the spa pod object
TRUE if it is of type int, FALSE otherwise
wp_spa_pod_is_long
gboolean wp_spa_pod_is_long (WpSpaPod * self)
Checks wether the spa pod is of type long or not
Parameters:
self
–
the spa pod object
TRUE if it is of type long, FALSE otherwise
wp_spa_pod_is_none
gboolean wp_spa_pod_is_none (WpSpaPod * self)
Checks wether the spa pod is of type none or not
Parameters:
self
–
the spa pod object
TRUE if it is of type none, FALSE otherwise
wp_spa_pod_is_object
gboolean wp_spa_pod_is_object (WpSpaPod * self)
Checks wether the spa pod is of type object or not
Parameters:
self
–
the spa pod object
TRUE if it is of type object, FALSE otherwise
wp_spa_pod_is_pointer
gboolean wp_spa_pod_is_pointer (WpSpaPod * self)
Checks wether the spa pod is of type pointer or not
Parameters:
self
–
the spa pod object
TRUE if it is of type pointer, FALSE otherwise
wp_spa_pod_is_property
gboolean wp_spa_pod_is_property (WpSpaPod * self)
Checks wether the spa pod is of type property or not
Parameters:
self
–
the spa pod object
TRUE if it is of type property, FALSE otherwise
Wp.SpaPod.is_property
def Wp.SpaPod.is_property (self):
#python wrapper for 'wp_spa_pod_is_property'
Checks wether the spa pod is of type property or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type property, FALSE otherwise
Wp.SpaPod.prototype.is_property
function Wp.SpaPod.prototype.is_property(): {
// javascript wrapper for 'wp_spa_pod_is_property'
}
Checks wether the spa pod is of type property or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type property, FALSE otherwise
wp_spa_pod_is_rectangle
gboolean wp_spa_pod_is_rectangle (WpSpaPod * self)
Checks wether the spa pod is of type rectangle or not
Parameters:
self
–
the spa pod object
TRUE if it is of type rectangle, FALSE otherwise
Wp.SpaPod.is_rectangle
def Wp.SpaPod.is_rectangle (self):
#python wrapper for 'wp_spa_pod_is_rectangle'
Checks wether the spa pod is of type rectangle or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type rectangle, FALSE otherwise
Wp.SpaPod.prototype.is_rectangle
function Wp.SpaPod.prototype.is_rectangle(): {
// javascript wrapper for 'wp_spa_pod_is_rectangle'
}
Checks wether the spa pod is of type rectangle or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type rectangle, FALSE otherwise
wp_spa_pod_is_sequence
gboolean wp_spa_pod_is_sequence (WpSpaPod * self)
Checks wether the spa pod is of type sequence or not
Parameters:
self
–
the spa pod object
TRUE if it is of type sequence, FALSE otherwise
Wp.SpaPod.is_sequence
def Wp.SpaPod.is_sequence (self):
#python wrapper for 'wp_spa_pod_is_sequence'
Checks wether the spa pod is of type sequence or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type sequence, FALSE otherwise
Wp.SpaPod.prototype.is_sequence
function Wp.SpaPod.prototype.is_sequence(): {
// javascript wrapper for 'wp_spa_pod_is_sequence'
}
Checks wether the spa pod is of type sequence or not
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
TRUE if it is of type sequence, FALSE otherwise
wp_spa_pod_is_string
gboolean wp_spa_pod_is_string (WpSpaPod * self)
Checks wether the spa pod is of type string or not
Parameters:
self
–
the spa pod object
TRUE if it is of type string, FALSE otherwise
wp_spa_pod_is_struct
gboolean wp_spa_pod_is_struct (WpSpaPod * self)
Checks wether the spa pod is of type struct or not
Parameters:
self
–
the spa pod object
TRUE if it is of type struct, FALSE otherwise
wp_spa_pod_is_unique_owner
gboolean wp_spa_pod_is_unique_owner (WpSpaPod * self)
Checks if the pod is the unique owner of its data or not
Parameters:
self
–
a spa pod object
TRUE if the pod owns the data, FALSE otherwise.
Wp.SpaPod.is_unique_owner
def Wp.SpaPod.is_unique_owner (self):
#python wrapper for 'wp_spa_pod_is_unique_owner'
Checks if the pod is the unique owner of its data or not
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod object
TRUE if the pod owns the data, FALSE otherwise.
Wp.SpaPod.prototype.is_unique_owner
function Wp.SpaPod.prototype.is_unique_owner(): {
// javascript wrapper for 'wp_spa_pod_is_unique_owner'
}
Checks if the pod is the unique owner of its data or not
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod object
TRUE if the pod owns the data, FALSE otherwise.
wp_spa_pod_iterate
WpIterator * wp_spa_pod_iterate (WpSpaPod * pod)
Creates a new iterator for a spa pod object.
Parameters:
pod
–
a spa pod object
the new spa pod iterator
Wp.SpaPod.iterate
def Wp.SpaPod.iterate (self):
#python wrapper for 'wp_spa_pod_iterate'
Creates a new iterator for a spa pod object.
Parameters:
pod
(
Wp.SpaPod
)
–
a spa pod object
the new spa pod iterator
Wp.SpaPod.prototype.iterate
function Wp.SpaPod.prototype.iterate(): {
// javascript wrapper for 'wp_spa_pod_iterate'
}
Creates a new iterator for a spa pod object.
Parameters:
pod
(
Wp.SpaPod
)
–
a spa pod object
the new spa pod iterator
wp_spa_pod_ref
WpSpaPod * wp_spa_pod_ref (WpSpaPod * self)
Parameters:
self
–
a spa pod object
self with an additional reference count on it
wp_spa_pod_set_boolean
gboolean wp_spa_pod_set_boolean (WpSpaPod * self, gboolean value)
Sets a boolean value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the boolean value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_boolean
def Wp.SpaPod.set_boolean (self, value):
#python wrapper for 'wp_spa_pod_set_boolean'
Sets a boolean value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_double
gboolean wp_spa_pod_set_double (WpSpaPod * self, double value)
Sets a double value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the double value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_double
def Wp.SpaPod.set_double (self, value):
#python wrapper for 'wp_spa_pod_set_double'
Sets a double value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_fd
gboolean wp_spa_pod_set_fd (WpSpaPod * self, gint64 value)
Sets a Fd value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the Fd value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_fd
def Wp.SpaPod.set_fd (self, value):
#python wrapper for 'wp_spa_pod_set_fd'
Sets a Fd value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_float
gboolean wp_spa_pod_set_float (WpSpaPod * self, float value)
Sets a float value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the float value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_float
def Wp.SpaPod.set_float (self, value):
#python wrapper for 'wp_spa_pod_set_float'
Sets a float value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_fraction
gboolean wp_spa_pod_set_fraction (WpSpaPod * self, guint32 num, guint32 denom)
Sets the numerator and denominator values of a fraction in the spa pod object.
Parameters:
self
–
the spa pod object
num
–
the numerator value of the farction
denom
–
the denominator value of the fraction
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_fraction
def Wp.SpaPod.set_fraction (self, num, denom):
#python wrapper for 'wp_spa_pod_set_fraction'
Sets the numerator and denominator values of a fraction in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
num
(
int
)
–
the numerator value of the farction
denom
(
int
)
–
the denominator value of the fraction
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.prototype.set_fraction
function Wp.SpaPod.prototype.set_fraction(num: Number, denom: Number): {
// javascript wrapper for 'wp_spa_pod_set_fraction'
}
Sets the numerator and denominator values of a fraction in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
num
(
Number
)
–
the numerator value of the farction
denom
(
Number
)
–
the denominator value of the fraction
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_id
gboolean wp_spa_pod_set_id (WpSpaPod * self, guint32 value)
Sets an Id value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the Id value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_id
def Wp.SpaPod.set_id (self, value):
#python wrapper for 'wp_spa_pod_set_id'
Sets an Id value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_int
gboolean wp_spa_pod_set_int (WpSpaPod * self, gint value)
Sets an int value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the int value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_int
def Wp.SpaPod.set_int (self, value):
#python wrapper for 'wp_spa_pod_set_int'
Sets an int value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_long
gboolean wp_spa_pod_set_long (WpSpaPod * self, glong value)
Sets a long value in the spa pod object.
Parameters:
self
–
the spa pod object
value
–
the long value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_long
def Wp.SpaPod.set_long (self, value):
#python wrapper for 'wp_spa_pod_set_long'
Sets a long value in the spa pod object.
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_pod
gboolean wp_spa_pod_set_pod (WpSpaPod * self, WpSpaPod * pod)
Sets the value of a spa pod object in the current spa pod object. THe spa pod objects must be of the same value.
Parameters:
self
–
the spa pod object
pod
–
the pod with the value to be set
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_pod
def Wp.SpaPod.set_pod (self, pod):
#python wrapper for 'wp_spa_pod_set_pod'
Sets the value of a spa pod object in the current spa pod object. THe spa pod objects must be of the same value.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
pod
(
Wp.SpaPod
)
–
the pod with the value to be set
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.prototype.set_pod
function Wp.SpaPod.prototype.set_pod(pod: Wp.SpaPod): {
// javascript wrapper for 'wp_spa_pod_set_pod'
}
Sets the value of a spa pod object in the current spa pod object. THe spa pod objects must be of the same value.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
pod
(
Wp.SpaPod
)
–
the pod with the value to be set
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_pointer
gboolean wp_spa_pod_set_pointer (WpSpaPod * self, const char* type_name, gconstpointer value)
Sets a pointer value with its type name in the spa pod object.
Parameters:
self
–
the spa pod object
type_name
–
the type name the pointer points to
value
–
the pointer value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_pointer
def Wp.SpaPod.set_pointer (self, type_name, value):
#python wrapper for 'wp_spa_pod_set_pointer'
Sets a pointer value with its type name in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
type_name
(
str
)
–
the type name the pointer points to
value
(
object
)
–
the pointer value
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.prototype.set_pointer
function Wp.SpaPod.prototype.set_pointer(type_name: String, value: Object): {
// javascript wrapper for 'wp_spa_pod_set_pointer'
}
Sets a pointer value with its type name in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
type_name
(
String
)
–
the type name the pointer points to
value
(
Object
)
–
the pointer value
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_set_rectangle
gboolean wp_spa_pod_set_rectangle (WpSpaPod * self, guint32 width, guint32 height)
Sets the width and height values of a rectangle in the spa pod object.
Parameters:
self
–
the spa pod object
width
–
the width value of the rectangle
height
–
the height value of the rectangle
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.set_rectangle
def Wp.SpaPod.set_rectangle (self, width, height):
#python wrapper for 'wp_spa_pod_set_rectangle'
Sets the width and height values of a rectangle in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
width
(
int
)
–
the width value of the rectangle
height
(
int
)
–
the height value of the rectangle
TRUE if the value could be set, FALSE othewrise.
Wp.SpaPod.prototype.set_rectangle
function Wp.SpaPod.prototype.set_rectangle(width: Number, height: Number): {
// javascript wrapper for 'wp_spa_pod_set_rectangle'
}
Sets the width and height values of a rectangle in the spa pod object.
Parameters:
self
(
Wp.SpaPod
)
–
the spa pod object
width
(
Number
)
–
the width value of the rectangle
height
(
Number
)
–
the height value of the rectangle
TRUE if the value could be set, FALSE othewrise.
wp_spa_pod_unref
wp_spa_pod_unref (WpSpaPod * self)
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
[transfer: full]
)
–
a spa pod object
Wp.SpaPod.unref
def Wp.SpaPod.unref (self):
#python wrapper for 'wp_spa_pod_unref'
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod object
Wp.SpaPod.prototype.unref
function Wp.SpaPod.prototype.unref(): {
// javascript wrapper for 'wp_spa_pod_unref'
}
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPod
)
–
a spa pod object
WpSpaPodBuilder
Wp.SpaPodBuilder
Wp.SpaPodBuilder
Constructors
wp_spa_pod_builder_new_array
WpSpaPodBuilder * wp_spa_pod_builder_new_array ()
Creates a spa pod builder of type array
the new spa pod builder
Wp.SpaPodBuilder.new_array
def Wp.SpaPodBuilder.new_array ():
#python wrapper for 'wp_spa_pod_builder_new_array'
Creates a spa pod builder of type array
the new spa pod builder
Wp.SpaPodBuilder.prototype.new_array
function Wp.SpaPodBuilder.prototype.new_array(): {
// javascript wrapper for 'wp_spa_pod_builder_new_array'
}
Creates a spa pod builder of type array
the new spa pod builder
wp_spa_pod_builder_new_choice
WpSpaPodBuilder * wp_spa_pod_builder_new_choice (const char* type_name)
Creates a spa pod builder of type choice
Parameters:
type_name
–
the type name of the choice type
the new spa pod builder
Wp.SpaPodBuilder.new_choice
def Wp.SpaPodBuilder.new_choice (type_name):
#python wrapper for 'wp_spa_pod_builder_new_choice'
Creates a spa pod builder of type choice
Parameters:
type_name
(
str
)
–
the type name of the choice type
the new spa pod builder
Wp.SpaPodBuilder.prototype.new_choice
function Wp.SpaPodBuilder.prototype.new_choice(type_name: String): {
// javascript wrapper for 'wp_spa_pod_builder_new_choice'
}
Creates a spa pod builder of type choice
Parameters:
type_name
(
String
)
–
the type name of the choice type
the new spa pod builder
wp_spa_pod_builder_new_object
WpSpaPodBuilder * wp_spa_pod_builder_new_object (const char* type_name, const char* id_name)
Creates a spa pod builder of type object
Parameters:
type_name
–
the type name of the object type
id_name
–
the Id name of the object
the new spa pod builder
Wp.SpaPodBuilder.new_object
def Wp.SpaPodBuilder.new_object (type_name, id_name):
#python wrapper for 'wp_spa_pod_builder_new_object'
Creates a spa pod builder of type object
Parameters:
type_name
(
str
)
–
the type name of the object type
id_name
(
str
)
–
the Id name of the object
the new spa pod builder
Wp.SpaPodBuilder.prototype.new_object
function Wp.SpaPodBuilder.prototype.new_object(type_name: String, id_name: String): {
// javascript wrapper for 'wp_spa_pod_builder_new_object'
}
Creates a spa pod builder of type object
Parameters:
type_name
(
String
)
–
the type name of the object type
id_name
(
String
)
–
the Id name of the object
the new spa pod builder
wp_spa_pod_builder_new_sequence
WpSpaPodBuilder * wp_spa_pod_builder_new_sequence (guint unit)
Creates a spa pod builder of type sequence
Parameters:
unit
–
the new spa pod builder
Wp.SpaPodBuilder.new_sequence
def Wp.SpaPodBuilder.new_sequence (unit):
#python wrapper for 'wp_spa_pod_builder_new_sequence'
Creates a spa pod builder of type sequence
Parameters:
unit
(
int
)
–
the new spa pod builder
Wp.SpaPodBuilder.prototype.new_sequence
function Wp.SpaPodBuilder.prototype.new_sequence(unit: Number): {
// javascript wrapper for 'wp_spa_pod_builder_new_sequence'
}
Creates a spa pod builder of type sequence
Parameters:
unit
(
Number
)
–
the new spa pod builder
wp_spa_pod_builder_new_struct
WpSpaPodBuilder * wp_spa_pod_builder_new_struct ()
Creates a spa pod builder of type struct
the new spa pod builder
Wp.SpaPodBuilder.new_struct
def Wp.SpaPodBuilder.new_struct ():
#python wrapper for 'wp_spa_pod_builder_new_struct'
Creates a spa pod builder of type struct
the new spa pod builder
Wp.SpaPodBuilder.prototype.new_struct
function Wp.SpaPodBuilder.prototype.new_struct(): {
// javascript wrapper for 'wp_spa_pod_builder_new_struct'
}
Creates a spa pod builder of type struct
the new spa pod builder
Methods
wp_spa_pod_builder_add
wp_spa_pod_builder_add (WpSpaPodBuilder * self, ... ...)
Adds a list of values into the builder
wp_spa_pod_builder_add_boolean
wp_spa_pod_builder_add_boolean (WpSpaPodBuilder * self, gboolean value)
Adds a boolean value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the boolean value
Wp.SpaPodBuilder.add_boolean
def Wp.SpaPodBuilder.add_boolean (self, value):
#python wrapper for 'wp_spa_pod_builder_add_boolean'
Adds a boolean value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
bool
)
–
the boolean value
Wp.SpaPodBuilder.prototype.add_boolean
function Wp.SpaPodBuilder.prototype.add_boolean(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_boolean'
}
Adds a boolean value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
Number
)
–
the boolean value
wp_spa_pod_builder_add_bytes
wp_spa_pod_builder_add_bytes (WpSpaPodBuilder * self, gconstpointer value, guint32 len)
Adds a bytes value with its length into the builder
Parameters:
self
–
the spa pod builder object
value
–
the bytes value
len
–
the length of the bytes value
Wp.SpaPodBuilder.add_bytes
def Wp.SpaPodBuilder.add_bytes (self, value, len):
#python wrapper for 'wp_spa_pod_builder_add_bytes'
Adds a bytes value with its length into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
object
)
–
the bytes value
len
(
int
)
–
the length of the bytes value
Wp.SpaPodBuilder.prototype.add_bytes
function Wp.SpaPodBuilder.prototype.add_bytes(value: Object, len: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_bytes'
}
Adds a bytes value with its length into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
Object
)
–
the bytes value
len
(
Number
)
–
the length of the bytes value
wp_spa_pod_builder_add_control
wp_spa_pod_builder_add_control (WpSpaPodBuilder * self, guint32 offset, const char* type_name)
Adds a control into the builder
Parameters:
self
–
the spa pod builder object
offset
–
the offset of the control
type_name
–
the type name of the control
Wp.SpaPodBuilder.add_control
def Wp.SpaPodBuilder.add_control (self, offset, type_name):
#python wrapper for 'wp_spa_pod_builder_add_control'
Adds a control into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
offset
(
int
)
–
the offset of the control
type_name
(
str
)
–
the type name of the control
Wp.SpaPodBuilder.prototype.add_control
function Wp.SpaPodBuilder.prototype.add_control(offset: Number, type_name: String): {
// javascript wrapper for 'wp_spa_pod_builder_add_control'
}
Adds a control into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
offset
(
Number
)
–
the offset of the control
type_name
(
String
)
–
the type name of the control
wp_spa_pod_builder_add_double
wp_spa_pod_builder_add_double (WpSpaPodBuilder * self, double value)
Adds a double value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the double value
Wp.SpaPodBuilder.add_double
def Wp.SpaPodBuilder.add_double (self, value):
#python wrapper for 'wp_spa_pod_builder_add_double'
Adds a double value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
float
)
–
the double value
Wp.SpaPodBuilder.prototype.add_double
function Wp.SpaPodBuilder.prototype.add_double(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_double'
}
Adds a double value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
Number
)
–
the double value
wp_spa_pod_builder_add_fd
wp_spa_pod_builder_add_fd (WpSpaPodBuilder * self, gint64 value)
Adds a Fd value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the Fd value
Wp.SpaPodBuilder.add_fd
def Wp.SpaPodBuilder.add_fd (self, value):
#python wrapper for 'wp_spa_pod_builder_add_fd'
Adds a Fd value into the builder
Wp.SpaPodBuilder.prototype.add_fd
function Wp.SpaPodBuilder.prototype.add_fd(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_fd'
}
Adds a Fd value into the builder
wp_spa_pod_builder_add_float
wp_spa_pod_builder_add_float (WpSpaPodBuilder * self, float value)
Adds a float value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the float value
Wp.SpaPodBuilder.add_float
def Wp.SpaPodBuilder.add_float (self, value):
#python wrapper for 'wp_spa_pod_builder_add_float'
Adds a float value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
float
)
–
the float value
Wp.SpaPodBuilder.prototype.add_float
function Wp.SpaPodBuilder.prototype.add_float(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_float'
}
Adds a float value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
Number
)
–
the float value
wp_spa_pod_builder_add_fraction
wp_spa_pod_builder_add_fraction (WpSpaPodBuilder * self, guint32 num, guint32 denom)
Adds the numerator and denominator values of a fraction into the builder
Parameters:
self
–
the spa pod builder object
num
–
the numerator value of the fraction
denom
–
the denominator value of the fraction
Wp.SpaPodBuilder.add_fraction
def Wp.SpaPodBuilder.add_fraction (self, num, denom):
#python wrapper for 'wp_spa_pod_builder_add_fraction'
Adds the numerator and denominator values of a fraction into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
num
(
int
)
–
the numerator value of the fraction
denom
(
int
)
–
the denominator value of the fraction
Wp.SpaPodBuilder.prototype.add_fraction
function Wp.SpaPodBuilder.prototype.add_fraction(num: Number, denom: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_fraction'
}
Adds the numerator and denominator values of a fraction into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
num
(
Number
)
–
the numerator value of the fraction
denom
(
Number
)
–
the denominator value of the fraction
wp_spa_pod_builder_add_id
wp_spa_pod_builder_add_id (WpSpaPodBuilder * self, guint32 value)
Adds a Id value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the Id value
Wp.SpaPodBuilder.add_id
def Wp.SpaPodBuilder.add_id (self, value):
#python wrapper for 'wp_spa_pod_builder_add_id'
Adds a Id value into the builder
Wp.SpaPodBuilder.prototype.add_id
function Wp.SpaPodBuilder.prototype.add_id(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_id'
}
Adds a Id value into the builder
wp_spa_pod_builder_add_int
wp_spa_pod_builder_add_int (WpSpaPodBuilder * self, gint value)
Adds a int value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the int value
Wp.SpaPodBuilder.add_int
def Wp.SpaPodBuilder.add_int (self, value):
#python wrapper for 'wp_spa_pod_builder_add_int'
Adds a int value into the builder
Wp.SpaPodBuilder.prototype.add_int
function Wp.SpaPodBuilder.prototype.add_int(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_int'
}
Adds a int value into the builder
wp_spa_pod_builder_add_long
wp_spa_pod_builder_add_long (WpSpaPodBuilder * self, glong value)
Adds a long value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the long value
Wp.SpaPodBuilder.add_long
def Wp.SpaPodBuilder.add_long (self, value):
#python wrapper for 'wp_spa_pod_builder_add_long'
Adds a long value into the builder
Wp.SpaPodBuilder.prototype.add_long
function Wp.SpaPodBuilder.prototype.add_long(value: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_long'
}
Adds a long value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
Number
)
–
the long value
wp_spa_pod_builder_add_none
wp_spa_pod_builder_add_none (WpSpaPodBuilder * self)
Adds a none value into the builder
Parameters:
self
–
the spa pod builder object
Wp.SpaPodBuilder.add_none
def Wp.SpaPodBuilder.add_none (self):
#python wrapper for 'wp_spa_pod_builder_add_none'
Adds a none value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
Wp.SpaPodBuilder.prototype.add_none
function Wp.SpaPodBuilder.prototype.add_none(): {
// javascript wrapper for 'wp_spa_pod_builder_add_none'
}
Adds a none value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
wp_spa_pod_builder_add_pod
wp_spa_pod_builder_add_pod (WpSpaPodBuilder * self, WpSpaPod * pod)
Adds a pod value into the builder
Parameters:
self
–
the spa pod builder object
pod
–
the pod value
Wp.SpaPodBuilder.add_pod
def Wp.SpaPodBuilder.add_pod (self, pod):
#python wrapper for 'wp_spa_pod_builder_add_pod'
Adds a pod value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
pod
(
Wp.SpaPod
)
–
the pod value
Wp.SpaPodBuilder.prototype.add_pod
function Wp.SpaPodBuilder.prototype.add_pod(pod: Wp.SpaPod): {
// javascript wrapper for 'wp_spa_pod_builder_add_pod'
}
Adds a pod value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
pod
(
Wp.SpaPod
)
–
the pod value
wp_spa_pod_builder_add_pointer
wp_spa_pod_builder_add_pointer (WpSpaPodBuilder * self, const char* type_name, gconstpointer value)
Adds a pointer value with its type name into the builder
Parameters:
self
–
the spa pod builder object
type_name
–
the type name that the pointer points to
value
–
the pointer vaue
Wp.SpaPodBuilder.add_pointer
def Wp.SpaPodBuilder.add_pointer (self, type_name, value):
#python wrapper for 'wp_spa_pod_builder_add_pointer'
Adds a pointer value with its type name into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
type_name
(
str
)
–
the type name that the pointer points to
value
(
object
)
–
the pointer vaue
Wp.SpaPodBuilder.prototype.add_pointer
function Wp.SpaPodBuilder.prototype.add_pointer(type_name: String, value: Object): {
// javascript wrapper for 'wp_spa_pod_builder_add_pointer'
}
Adds a pointer value with its type name into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
type_name
(
String
)
–
the type name that the pointer points to
value
(
Object
)
–
the pointer vaue
wp_spa_pod_builder_add_property
wp_spa_pod_builder_add_property (WpSpaPodBuilder * self, const char* key)
Adds a property into the builder
Parameters:
self
–
the spa pod builder object
key
–
the name of the property
Wp.SpaPodBuilder.add_property
def Wp.SpaPodBuilder.add_property (self, key):
#python wrapper for 'wp_spa_pod_builder_add_property'
Adds a property into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
key
(
str
)
–
the name of the property
Wp.SpaPodBuilder.prototype.add_property
function Wp.SpaPodBuilder.prototype.add_property(key: String): {
// javascript wrapper for 'wp_spa_pod_builder_add_property'
}
Adds a property into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
key
(
String
)
–
the name of the property
wp_spa_pod_builder_add_property_id
wp_spa_pod_builder_add_property_id (WpSpaPodBuilder * self, guint32 id)
Adds a property into the builder
Parameters:
self
–
the spa pod builder object
id
–
the id of the property
Wp.SpaPodBuilder.add_property_id
def Wp.SpaPodBuilder.add_property_id (self, id):
#python wrapper for 'wp_spa_pod_builder_add_property_id'
Adds a property into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
id
(
int
)
–
the id of the property
Wp.SpaPodBuilder.prototype.add_property_id
function Wp.SpaPodBuilder.prototype.add_property_id(id: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_property_id'
}
Adds a property into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
id
(
Number
)
–
the id of the property
wp_spa_pod_builder_add_rectangle
wp_spa_pod_builder_add_rectangle (WpSpaPodBuilder * self, guint32 width, guint32 height)
Adds the width and height values of a rectangle into the builder
Parameters:
self
–
the spa pod builder object
width
–
the width value of the rectangle
height
–
the height value of the rectangle
Wp.SpaPodBuilder.add_rectangle
def Wp.SpaPodBuilder.add_rectangle (self, width, height):
#python wrapper for 'wp_spa_pod_builder_add_rectangle'
Adds the width and height values of a rectangle into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
width
(
int
)
–
the width value of the rectangle
height
(
int
)
–
the height value of the rectangle
Wp.SpaPodBuilder.prototype.add_rectangle
function Wp.SpaPodBuilder.prototype.add_rectangle(width: Number, height: Number): {
// javascript wrapper for 'wp_spa_pod_builder_add_rectangle'
}
Adds the width and height values of a rectangle into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
width
(
Number
)
–
the width value of the rectangle
height
(
Number
)
–
the height value of the rectangle
wp_spa_pod_builder_add_string
wp_spa_pod_builder_add_string (WpSpaPodBuilder * self, const char* value)
Adds a string value into the builder
Parameters:
self
–
the spa pod builder object
value
–
the string value
Wp.SpaPodBuilder.add_string
def Wp.SpaPodBuilder.add_string (self, value):
#python wrapper for 'wp_spa_pod_builder_add_string'
Adds a string value into the builder
Wp.SpaPodBuilder.prototype.add_string
function Wp.SpaPodBuilder.prototype.add_string(value: String): {
// javascript wrapper for 'wp_spa_pod_builder_add_string'
}
Adds a string value into the builder
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
value
(
String
)
–
the string value
wp_spa_pod_builder_add_valist
wp_spa_pod_builder_add_valist (WpSpaPodBuilder * self, va_list args)
Adds a list of values into the builder
Parameters:
self
–
the spa pod builder object
args
–
the variable arguments passed to wp_spa_pod_builder_add
wp_spa_pod_builder_end
WpSpaPod * wp_spa_pod_builder_end (WpSpaPodBuilder * self)
Ends the builder process and returns the constructed spa pod object
Parameters:
self
–
the spa pod builder object
the constructed spa pod object
Wp.SpaPodBuilder.end
def Wp.SpaPodBuilder.end (self):
#python wrapper for 'wp_spa_pod_builder_end'
Ends the builder process and returns the constructed spa pod object
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
the constructed spa pod object
Wp.SpaPodBuilder.prototype.end
function Wp.SpaPodBuilder.prototype.end(): {
// javascript wrapper for 'wp_spa_pod_builder_end'
}
Ends the builder process and returns the constructed spa pod object
Parameters:
self
(
Wp.SpaPodBuilder
)
–
the spa pod builder object
the constructed spa pod object
wp_spa_pod_builder_ref
WpSpaPodBuilder * wp_spa_pod_builder_ref (WpSpaPodBuilder * self)
Parameters:
self
–
a spa pod builder object
self with an additional reference count on it
Wp.SpaPodBuilder.ref
def Wp.SpaPodBuilder.ref (self):
#python wrapper for 'wp_spa_pod_builder_ref'
Parameters:
self
(
Wp.SpaPodBuilder
)
–
a spa pod builder object
self with an additional reference count on it
Wp.SpaPodBuilder.prototype.ref
function Wp.SpaPodBuilder.prototype.ref(): {
// javascript wrapper for 'wp_spa_pod_builder_ref'
}
Parameters:
self
(
Wp.SpaPodBuilder
)
–
a spa pod builder object
self with an additional reference count on it
wp_spa_pod_builder_unref
wp_spa_pod_builder_unref (WpSpaPodBuilder * self)
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
[transfer: full]
)
–
a spa pod builder object
Wp.SpaPodBuilder.unref
def Wp.SpaPodBuilder.unref (self):
#python wrapper for 'wp_spa_pod_builder_unref'
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPodBuilder
)
–
a spa pod builder object
Wp.SpaPodBuilder.prototype.unref
function Wp.SpaPodBuilder.prototype.unref(): {
// javascript wrapper for 'wp_spa_pod_builder_unref'
}
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPodBuilder
)
–
a spa pod builder object
WpSpaPodParser
Wp.SpaPodParser
Wp.SpaPodParser
Constructors
wp_spa_pod_parser_new_object
WpSpaPodParser * wp_spa_pod_parser_new_object (WpSpaPod * pod, const char* type_name, const char** id_name)
Parameters:
pod
–
type_name
–
id_name
–
Wp.SpaPodParser.new_object
def Wp.SpaPodParser.new_object (pod, type_name, id_name):
#python wrapper for 'wp_spa_pod_parser_new_object'
Parameters:
pod
(
Wp.SpaPod
)
–
type_name
(
str
)
–
id_name
(
str
)
–
Wp.SpaPodParser.prototype.new_object
function Wp.SpaPodParser.prototype.new_object(pod: Wp.SpaPod, type_name: String, id_name: String): {
// javascript wrapper for 'wp_spa_pod_parser_new_object'
}
Parameters:
pod
(
Wp.SpaPod
)
–
type_name
(
String
)
–
id_name
(
String
)
–
wp_spa_pod_parser_new_struct
WpSpaPodParser * wp_spa_pod_parser_new_struct (WpSpaPod * pod)
Creates an struct spa pod parser. The pod object must be valid for the entire life-cycle of the returned parser.
Parameters:
pod
–
the struct spa pod to parse
The new spa pod parser
Wp.SpaPodParser.new_struct
def Wp.SpaPodParser.new_struct (pod):
#python wrapper for 'wp_spa_pod_parser_new_struct'
Creates an struct spa pod parser. The pod object must be valid for the entire life-cycle of the returned parser.
Parameters:
pod
(
Wp.SpaPod
)
–
the struct spa pod to parse
The new spa pod parser
Wp.SpaPodParser.prototype.new_struct
function Wp.SpaPodParser.prototype.new_struct(pod: Wp.SpaPod): {
// javascript wrapper for 'wp_spa_pod_parser_new_struct'
}
Creates an struct spa pod parser. The pod object must be valid for the entire life-cycle of the returned parser.
Parameters:
pod
(
Wp.SpaPod
)
–
the struct spa pod to parse
The new spa pod parser
Methods
wp_spa_pod_parser_end
wp_spa_pod_parser_end (WpSpaPodParser * self)
Ends the parser process
Parameters:
self
–
the spa pod parser object
Wp.SpaPodParser.end
def Wp.SpaPodParser.end (self):
#python wrapper for 'wp_spa_pod_parser_end'
Ends the parser process
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Wp.SpaPodParser.prototype.end
function Wp.SpaPodParser.prototype.end(): {
// javascript wrapper for 'wp_spa_pod_parser_end'
}
Ends the parser process
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
wp_spa_pod_parser_get
gboolean wp_spa_pod_parser_get (WpSpaPodParser * self, ... ...)
Gets a list of values from a spa pod parser object
Parameters:
self
–
the spa pod parser object
...
(
[out]
)
–
a list of values to get, followed by NULL
TRUE if the values were obtained, FALSE otherwise
wp_spa_pod_parser_get_boolean
gboolean wp_spa_pod_parser_get_boolean (WpSpaPodParser * self, gboolean * value)
Gets the boolean value from a spa pod parser
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the boolean value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_boolean
def Wp.SpaPodParser.get_boolean (self):
#python wrapper for 'wp_spa_pod_parser_get_boolean'
Gets the boolean value from a spa pod parser
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
bool
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_boolean
function Wp.SpaPodParser.prototype.get_boolean(): {
// javascript wrapper for 'wp_spa_pod_parser_get_boolean'
}
Gets the boolean value from a spa pod parser
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_bytes
gboolean wp_spa_pod_parser_get_bytes (WpSpaPodParser * self, gconstpointer * value, guint32 * len)
Gets the bytes value and its length from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the bytes value
len
(
[out]
)
–
the length of the bytes value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_bytes
def Wp.SpaPodParser.get_bytes (self):
#python wrapper for 'wp_spa_pod_parser_get_bytes'
Gets the bytes value and its length from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
object
)
–
TRUE if the value was obtained, FALSE otherwise
len
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_bytes
function Wp.SpaPodParser.prototype.get_bytes(): {
// javascript wrapper for 'wp_spa_pod_parser_get_bytes'
}
Gets the bytes value and its length from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Object
)
–
TRUE if the value was obtained, FALSE otherwise
len
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_double
gboolean wp_spa_pod_parser_get_double (WpSpaPodParser * self, double* value)
Gets the double value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the double value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_double
def Wp.SpaPodParser.get_double (self):
#python wrapper for 'wp_spa_pod_parser_get_double'
Gets the double value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
float
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_double
function Wp.SpaPodParser.prototype.get_double(): {
// javascript wrapper for 'wp_spa_pod_parser_get_double'
}
Gets the double value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_fd
gboolean wp_spa_pod_parser_get_fd (WpSpaPodParser * self, gint64 * value)
Gets the Fd value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the Fd value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_fd
def Wp.SpaPodParser.get_fd (self):
#python wrapper for 'wp_spa_pod_parser_get_fd'
Gets the Fd value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_fd
function Wp.SpaPodParser.prototype.get_fd(): {
// javascript wrapper for 'wp_spa_pod_parser_get_fd'
}
Gets the Fd value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_float
gboolean wp_spa_pod_parser_get_float (WpSpaPodParser * self, float* value)
Gets the float value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the float value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_float
def Wp.SpaPodParser.get_float (self):
#python wrapper for 'wp_spa_pod_parser_get_float'
Gets the float value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
float
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_float
function Wp.SpaPodParser.prototype.get_float(): {
// javascript wrapper for 'wp_spa_pod_parser_get_float'
}
Gets the float value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_fraction
gboolean wp_spa_pod_parser_get_fraction (WpSpaPodParser * self, guint32 * num, guint32 * denom)
Gets the fractions's numerator and denominator value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
num
(
[out]
)
–
the fractions's numerator value
denom
(
[out]
)
–
the fractions's denominator value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_fraction
def Wp.SpaPodParser.get_fraction (self):
#python wrapper for 'wp_spa_pod_parser_get_fraction'
Gets the fractions's numerator and denominator value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
num
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
denom
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_fraction
function Wp.SpaPodParser.prototype.get_fraction(): {
// javascript wrapper for 'wp_spa_pod_parser_get_fraction'
}
Gets the fractions's numerator and denominator value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
num
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
denom
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_id
gboolean wp_spa_pod_parser_get_id (WpSpaPodParser * self, guint32 * value)
Gets the Id value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the Id value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_id
def Wp.SpaPodParser.get_id (self):
#python wrapper for 'wp_spa_pod_parser_get_id'
Gets the Id value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_id
function Wp.SpaPodParser.prototype.get_id(): {
// javascript wrapper for 'wp_spa_pod_parser_get_id'
}
Gets the Id value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_int
gboolean wp_spa_pod_parser_get_int (WpSpaPodParser * self, gint * value)
Gets the int value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the int value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_int
def Wp.SpaPodParser.get_int (self):
#python wrapper for 'wp_spa_pod_parser_get_int'
Gets the int value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_int
function Wp.SpaPodParser.prototype.get_int(): {
// javascript wrapper for 'wp_spa_pod_parser_get_int'
}
Gets the int value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_long
gboolean wp_spa_pod_parser_get_long (WpSpaPodParser * self, glong * value)
Gets the long value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the long value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_long
def Wp.SpaPodParser.get_long (self):
#python wrapper for 'wp_spa_pod_parser_get_long'
Gets the long value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_long
function Wp.SpaPodParser.prototype.get_long(): {
// javascript wrapper for 'wp_spa_pod_parser_get_long'
}
Gets the long value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_pod
WpSpaPod * wp_spa_pod_parser_get_pod (WpSpaPodParser * self)
Gets the spa pod value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
The spa pod value or NULL if it could not be obtained
Wp.SpaPodParser.get_pod
def Wp.SpaPodParser.get_pod (self):
#python wrapper for 'wp_spa_pod_parser_get_pod'
Gets the spa pod value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
The spa pod value or NULL if it could not be obtained
Wp.SpaPodParser.prototype.get_pod
function Wp.SpaPodParser.prototype.get_pod(): {
// javascript wrapper for 'wp_spa_pod_parser_get_pod'
}
Gets the spa pod value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
The spa pod value or NULL if it could not be obtained
wp_spa_pod_parser_get_pointer
gboolean wp_spa_pod_parser_get_pointer (WpSpaPodParser * self, const char** type_name, gconstpointer * value)
Gets the pointer value and its type name from a spa pod parser object
Parameters:
self
–
the spa pod parser object
type_name
(
[out]
)
–
the type name of the pointer value
value
(
[out]
)
–
the pointer value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_pointer
def Wp.SpaPodParser.get_pointer (self):
#python wrapper for 'wp_spa_pod_parser_get_pointer'
Gets the pointer value and its type name from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
type_name
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
object
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_pointer
function Wp.SpaPodParser.prototype.get_pointer(): {
// javascript wrapper for 'wp_spa_pod_parser_get_pointer'
}
Gets the pointer value and its type name from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
type_name
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
value
(
Object
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_rectangle
gboolean wp_spa_pod_parser_get_rectangle (WpSpaPodParser * self, guint32 * width, guint32 * height)
Gets the rectangle's width and height value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
width
(
[out]
)
–
the rectangle's width value
height
(
[out]
)
–
the rectangle's height value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_rectangle
def Wp.SpaPodParser.get_rectangle (self):
#python wrapper for 'wp_spa_pod_parser_get_rectangle'
Gets the rectangle's width and height value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
width
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
height
(
int
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_rectangle
function Wp.SpaPodParser.prototype.get_rectangle(): {
// javascript wrapper for 'wp_spa_pod_parser_get_rectangle'
}
Gets the rectangle's width and height value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
width
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
height
(
Number
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_string
gboolean wp_spa_pod_parser_get_string (WpSpaPodParser * self, const char** value)
Gets the string value from a spa pod parser object
Parameters:
self
–
the spa pod parser object
value
(
[out]
)
–
the string value
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.get_string
def Wp.SpaPodParser.get_string (self):
#python wrapper for 'wp_spa_pod_parser_get_string'
Gets the string value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
str
)
–
TRUE if the value was obtained, FALSE otherwise
Wp.SpaPodParser.prototype.get_string
function Wp.SpaPodParser.prototype.get_string(): {
// javascript wrapper for 'wp_spa_pod_parser_get_string'
}
Gets the string value from a spa pod parser object
Parameters:
self
(
Wp.SpaPodParser
)
–
the spa pod parser object
Returns a tuple made of:
TRUE if the value was obtained, FALSE otherwise
value
(
String
)
–
TRUE if the value was obtained, FALSE otherwise
wp_spa_pod_parser_get_valist
gboolean wp_spa_pod_parser_get_valist (WpSpaPodParser * self, va_list args)
This is the va_list
version of wp_spa_pod_parser_get
Parameters:
self
–
the spa pod parser object
args
–
the variable arguments passed to wp_spa_pod_parser_get
TRUE if the values were obtained, FALSE otherwise
wp_spa_pod_parser_ref
WpSpaPodParser * wp_spa_pod_parser_ref (WpSpaPodParser * self)
Parameters:
self
–
a spa pod sparser object
self with an additional reference count on it
Wp.SpaPodParser.ref
def Wp.SpaPodParser.ref (self):
#python wrapper for 'wp_spa_pod_parser_ref'
Parameters:
self
(
Wp.SpaPodParser
)
–
a spa pod sparser object
self with an additional reference count on it
Wp.SpaPodParser.prototype.ref
function Wp.SpaPodParser.prototype.ref(): {
// javascript wrapper for 'wp_spa_pod_parser_ref'
}
Parameters:
self
(
Wp.SpaPodParser
)
–
a spa pod sparser object
self with an additional reference count on it
wp_spa_pod_parser_unref
wp_spa_pod_parser_unref (WpSpaPodParser * self)
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
[transfer: full]
)
–
a spa pod parser object
Wp.SpaPodParser.unref
def Wp.SpaPodParser.unref (self):
#python wrapper for 'wp_spa_pod_parser_unref'
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPodParser
)
–
a spa pod parser object
Wp.SpaPodParser.prototype.unref
function Wp.SpaPodParser.prototype.unref(): {
// javascript wrapper for 'wp_spa_pod_parser_unref'
}
Decreases the reference count on self and frees it when the ref count reaches zero.
Parameters:
self
(
Wp.SpaPodParser
)
–
a spa pod parser object
Constants
WP_TYPE_SPA_POD_BUILDER
#define WP_TYPE_SPA_POD_BUILDER (wp_spa_pod_builder_get_type ())
The WpSpaPodBuilder GType
WP_TYPE_SPA_POD_PARSER
#define WP_TYPE_SPA_POD_PARSER (wp_spa_pod_parser_get_type ())
The WpSpaPodParser GType
The results of the search are