Group s8_audio_device_implementors_api

group s8_audio_device_implementors_api

API for audio device implementors.

struct pjmedia_aud_dev_factory_op

#include <audiodev_imp.h>

Sound device factory operations.

Public Members

pj_status_t (*init)(pjmedia_aud_dev_factory *f)

Initialize the audio device factory.

Param f:: The audio device factory.

pj_status_t (*destroy)(pjmedia_aud_dev_factory *f)

Close this audio device factory and release all resources back to the operating system.

Param f:: The audio device factory.

unsigned (*get_dev_count)(pjmedia_aud_dev_factory *f)

Get the number of audio devices installed in the system.

Param f:: The audio device factory.

pj_status_t (*get_dev_info)(pjmedia_aud_dev_factory *f, unsigned index, pjmedia_aud_dev_info *info)

Get the audio device information and capabilities.

Param f:: The audio device factory.
Param index:: Device index.
Param info:: The audio device information structure which will be initialized by this function once it returns successfully.

pj_status_t (*default_param)(pjmedia_aud_dev_factory *f, unsigned index, pjmedia_aud_param *param)

Initialize the specified audio device parameter with the default values for the specified device.

Param f:: The audio device factory.
Param index:: Device index.
Param param:: The audio device parameter.

pj_status_t (*create_stream)(pjmedia_aud_dev_factory *f, const pjmedia_aud_param *param, pjmedia_aud_rec_cb rec_cb, pjmedia_aud_play_cb play_cb, void *user_data, pjmedia_aud_stream **p_aud_strm): Open the audio device and create audio stream. See pjmedia_aud_stream_create()

pj_status_t (*refresh)(pjmedia_aud_dev_factory *f)

Refresh the list of audio devices installed in the system.

Param f:: The audio device factory.

struct pjmedia_aud_dev_factory

#include <audiodev_imp.h>

This structure describes an audio device factory.

Forward declaration for audio device factory

Public Members

unsigned drv_idx: Driver index

struct pjmedia_aud_dev_factory::[anonymous] sys: Internal data to be initialized by audio subsystem.

pjmedia_aud_dev_factory_op *op: Operations

struct pjmedia_aud_stream_op

#include <audiodev_imp.h>

Sound stream operations.

Public Members

pj_status_t (*get_param)(pjmedia_aud_stream *strm, pjmedia_aud_param *param): See pjmedia_aud_stream_get_param()

pj_status_t (*get_cap)(pjmedia_aud_stream *strm, pjmedia_aud_dev_cap cap, void *value): See pjmedia_aud_stream_get_cap()

pj_status_t (*set_cap)(pjmedia_aud_stream *strm, pjmedia_aud_dev_cap cap, const void *value): See pjmedia_aud_stream_set_cap()

pj_status_t (*start)(pjmedia_aud_stream *strm): See pjmedia_aud_stream_start()

pj_status_t (*stop)(pjmedia_aud_stream *strm): See pjmedia_aud_stream_stop().

pj_status_t (*destroy)(pjmedia_aud_stream *strm): See pjmedia_aud_stream_destroy().

struct pjmedia_aud_stream

#include <audiodev_imp.h>

This structure describes the audio device stream.

Forward declaration for pjmedia_aud_stream

Public Members

unsigned drv_idx: Driver index

struct pjmedia_aud_stream::[anonymous] sys: Internal data to be initialized by audio subsystem

pjmedia_aud_stream_op *op: Operations