Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Typedefs | Enumerations | Functions
WsbElements.h File Reference

Wasabi Element API. More...

#include "WsbConfig.h"
#include "WsbTypes.h"

Go to the source code of this file.

Typedefs

typedef struct WSB_Element WSB_Element
 A WSB_Element object represents information about a hierarchical element. More...
 

Enumerations

enum  WSB_ElementType {
  WSB_ELEMENT_TYPE_OBJECT = 0,
  WSB_ELEMENT_TYPE_STRING,
  WSB_ELEMENT_TYPE_INTEGER,
  WSB_ELEMENT_TYPE_FLOAT,
  WSB_ELEMENT_TYPE_ARRAY,
  WSB_ELEMENT_TYPE_BOOLEAN,
  WSB_ELEMENT_TYPE_NULL
}
 Identifiers for element type. More...
 

Functions

WSB_EXPORT void WSB_Element_Release (WSB_Element *self)
 Releases the specified WSB_Element object. More...
 
WSB_EXPORT WSB_ElementWSB_Element_GetChild (WSB_Element *self, const char *name)
 Gets the child of the specified WSB_Element object based on name. More...
 
WSB_EXPORT WSB_ElementWSB_Element_GetChildAt (WSB_Element *self, WSB_Ordinal indx)
 Gets the child of the specified WSB_Element object based on index. More...
 
WSB_EXPORT WSB_Cardinal WSB_Element_GetChildCount (WSB_Element *self)
 Gets the number of children of the specified WSB_Element object. More...
 
WSB_EXPORT WSB_ElementWSB_Element_GetParent (WSB_Element *self)
 Gets the parent of the specified WSB_Element object. More...
 
WSB_EXPORT const char * WSB_Element_GetName (WSB_Element *self)
 Gets the name of the specified WSB_Element object. More...
 
WSB_EXPORT WSB_ElementType WSB_Element_GetType (WSB_Element *self)
 Gets the element type of the specified WSB_Element object. More...
 
WSB_EXPORT WSB_Int64 WSB_Element_AsInteger (WSB_Element *self)
 Gets the element value of the specified WSB_Element object as a 64 bits integer. More...
 
WSB_EXPORT double WSB_Element_AsFloat (WSB_Element *self)
 Gets the element value of the specified WSB_Element object as a double. More...
 
WSB_EXPORT WSB_Boolean WSB_Element_AsBoolean (WSB_Element *self)
 Gets the element value of the specified WSB_Element object as a boolean. More...
 
WSB_EXPORT const char * WSB_Element_AsString (WSB_Element *self)
 Gets the element value of the specified WSB_Element object as a string. More...
 
WSB_EXPORT WSB_Result WSB_Element_Serialize (WSB_Element *self, char *buffer, unsigned int *buffer_size)
 Serializes the specified WSB_Element into the supplied buffer. More...
 
WSB_EXPORT WSB_Result WSB_Element_Clone (WSB_Element *self, WSB_Element **clone)
 Clones the specified WSB_Element. More...
 

Detailed Description

Wasabi Element API.

Typedef Documentation

◆ WSB_Element

typedef struct WSB_Element WSB_Element

A WSB_Element object represents information about a hierarchical element.

Enumeration Type Documentation

◆ WSB_ElementType

Identifiers for element type.

Enumerator
WSB_ELEMENT_TYPE_OBJECT 
WSB_ELEMENT_TYPE_STRING 
WSB_ELEMENT_TYPE_INTEGER 
WSB_ELEMENT_TYPE_FLOAT 
WSB_ELEMENT_TYPE_ARRAY 
WSB_ELEMENT_TYPE_BOOLEAN 
WSB_ELEMENT_TYPE_NULL