sfizz_message.h File Reference
Typedefs
sfizz_receive_t
| typedef void() sfizz_receive_t |
Generic message receiving function.
- Since
- 1.0.0
Functions
sfizz_prepare_message
| SFIZZ_EXPORTED_API uint32_t sfizz_prepare_message | ( | void * | buffer | , | uint32_t | capacity | , | const char * | path | , | const char * | sig | , | const sfizz_arg_t * | args | ) |
Convert the message to OSC using the provided output buffer.
- Parameters
-
buffer The output buffer capacity The capacity of the buffer path The path sig The signature args The arguments
- Returns
- The size necessary to store the converted message in entirety, <= capacity if the written message is valid.
- Since
- 1.0.0
sfizz_extract_message
| SFIZZ_EXPORTED_API int32_t sfizz_extract_message | ( | const void * | srcBuffer | , | uint32_t | srcCapacity | , | void * | argsBuffer | , | uint32_t | argsCapacity | , | const char ** | outPath | , | const char ** | outSig | , | const sfizz_arg_t ** | outArgs | ) |
Extract the contents of an OSC message.
- Parameters
-
srcBuffer The data of the OSC message srcCapacity The size of the OSC message argsBuffer A buffer where the function can allocate the arguments argsCapacity The capacity of the argument buffer outPath A pointer to the variable which receives the path outSig A pointer to the variable which receives the signature outArgs A pointer to the variable which receives the arguments
- Returns
- On success, this is the number of bytes read. On failure, it is 0 if the OSC message is invalid, -1 if there was not enough buffer for the arguments.
- Since
- 1.0.0