Encoder driver
Encoder driver. More...
Collaboration diagram for Encoder driver:
Classes | |
| struct | nugu_encoder_driver_ops |
| encoder driver operations More... | |
Typedefs | |
| typedef struct _nugu_encoder_driver | NuguEncoderDriver |
| encoder driver object | |
Enumerations | |
| enum | nugu_encoder_type { NUGU_ENCODER_TYPE_SPEEX , NUGU_ENCODER_TYPE_OPUS , NUGU_ENCODER_TYPE_CUSTOM = 99 } |
| encoder type More... | |
Functions | |
| NUGU_API NuguEncoderDriver * | nugu_encoder_driver_find (const char *name) |
| Find a driver by name in the driver list. More... | |
| NUGU_API NuguEncoderDriver * | nugu_encoder_driver_find_bytype (enum nugu_encoder_type type) |
| Find a driver by type in the driver list. More... | |
| NUGU_API int | nugu_encoder_driver_free (NuguEncoderDriver *driver) |
| Destroy the encoder driver. More... | |
| NUGU_API NuguEncoderDriver * | nugu_encoder_driver_new (const char *name, enum nugu_encoder_type type, struct nugu_encoder_driver_ops *ops) |
| Create new encoder driver. More... | |
| NUGU_API int | nugu_encoder_driver_register (NuguEncoderDriver *driver) |
| Register the driver to driver list. More... | |
| NUGU_API int | nugu_encoder_driver_remove (NuguEncoderDriver *driver) |
| Remove the driver from driver list. More... | |
Detailed Description
Encoder driver.
The encoder driver performs a function of encoding the received pcm data.
Enumeration Type Documentation
◆ nugu_encoder_type
| enum nugu_encoder_type |
encoder type
- See also
- nugu_encoder_driver_new()
| Enumerator | |
|---|---|
| NUGU_ENCODER_TYPE_SPEEX | SPEEX |
| NUGU_ENCODER_TYPE_OPUS | OPUS |
| NUGU_ENCODER_TYPE_CUSTOM | Custom type |
Function Documentation
◆ nugu_encoder_driver_new()
| NUGU_API NuguEncoderDriver* nugu_encoder_driver_new | ( | const char * | name, |
| enum nugu_encoder_type | type, | ||
| struct nugu_encoder_driver_ops * | ops | ||
| ) |
Create new encoder driver.
- Parameters
-
[in] name driver name [in] type encoder type [in] ops operation table
- Returns
- encoder driver object
- See also
- nugu_encoder_driver_free()
◆ nugu_encoder_driver_free()
| NUGU_API int nugu_encoder_driver_free | ( | NuguEncoderDriver * | driver | ) |
Destroy the encoder driver.
- Parameters
-
[in] driver encoder driver object
- Returns
- result
- Return values
-
0 success -1 failure
◆ nugu_encoder_driver_register()
| NUGU_API int nugu_encoder_driver_register | ( | NuguEncoderDriver * | driver | ) |
Register the driver to driver list.
- Parameters
-
[in] driver encoder driver object
- Returns
- result
- Return values
-
0 success -1 failure
◆ nugu_encoder_driver_remove()
| NUGU_API int nugu_encoder_driver_remove | ( | NuguEncoderDriver * | driver | ) |
Remove the driver from driver list.
- Parameters
-
[in] driver encoder driver object
- Returns
- result
- Return values
-
0 success -1 failure
◆ nugu_encoder_driver_find()
| NUGU_API NuguEncoderDriver* nugu_encoder_driver_find | ( | const char * | name | ) |
Find a driver by name in the driver list.
- Parameters
-
[in] name encoder driver name
- Returns
- encoder driver object
◆ nugu_encoder_driver_find_bytype()
| NUGU_API NuguEncoderDriver* nugu_encoder_driver_find_bytype | ( | enum nugu_encoder_type | type | ) |
Find a driver by type in the driver list.
- Parameters
-
[in] type encoder driver type
- Returns
- encoder driver object
- See also
- nugu_encoder_driver_find
