StartModule
Function Usage
Starts the module.
Restrictions
N/A
Prototype
VmiErrCode StartModule(VmiDataType module, uint8_t* config, uint32_t size)
Parameter Description
Field Name |
Input/Output |
Field Type |
Description |
|---|---|---|---|
module |
Input |
VmiDataType |
Module data type. |
config |
Input |
uint8_t* |
Configuration used for module startup. |
size |
Input |
uint32_t |
Length of the memory pointed to by config. |
config varies with the module. However, config of each module inherits from VmiConfig and uses VmiConfig as the first member variable, where VmiConfigVideo, VmiConfigAudio, VmiConfigTouch, and VmiConfigMic are for VO, AO, TI, and MI, respectively.
VmiConfig needs to transfer the module version number mentioned in API Description. The version number is specific to each module.
Return Value Description
Data type: enum VmiErrCode: int32_t
The value can be any of the following:
- OK (0): The module is started successfully.
- Negative error code: Failed to start the module.
Parent topic: Functional APIs