audio_filter_info Struct Reference

#include <audio_filter.h>

Collaboration diagram for audio_filter_info:

Public Attributes
enum af_result_code(*	configure )(void *state, int bps, int ch_count, int sample_rate)
	Configure audio input format.
void(*	done )(void *state)
	Frees filter.
enum af_result_code(*	filter )(void *state, struct audio_frame **f)
	Filter audio frame.
void(*	get_configured_in )(void *state, int *bps, int *ch_count, int *sample_rate)
	Get configured input audio format.
void(*	get_configured_out )(void *state, int *bps, int *ch_count, int *sample_rate)
	Get configured output audio format.
enum af_result_code(*	init )(struct module *mod, const char *cfg, void **state)
	Initializes filter.
const char *	name

Detailed Description

Definition at line 58 of file audio_filter.h.

Member Data Documentation

configure

enum af_result_code(* audio_filter_info::configure) (void *state, int bps, int ch_count, int sample_rate)

Configure audio input format.

Parameters

state	filter state
bps	bytes per sample
ch_count	channel count
sample_rate	sample rate

Return values

0	if initialized successfully
<0	if error

Definition at line 70 of file audio_filter.h.

done

void(* audio_filter_info::done) (void *state)

Frees filter.

Definition at line 70 of file audio_filter.h.

filter

enum af_result_code(* audio_filter_info::filter) (void *state, struct audio_frame **f)

Filter audio frame.

Parameters

state	filter state
f	frame to filter, can take ownership of passed

Definition at line 87 of file audio_filter.h.

get_configured_in

void(* audio_filter_info::get_configured_in) (void *state, int *bps, int *ch_count, int *sample_rate)

Get configured input audio format.

Definition at line 83 of file audio_filter.h.

get_configured_out

void(* audio_filter_info::get_configured_out) (void *state, int *bps, int *ch_count, int *sample_rate)

Get configured output audio format.

Definition at line 87 of file audio_filter.h.

init

enum af_result_code(* audio_filter_info::init) (struct module *mod, const char *cfg, void **state)

Initializes filter.

Parameters

	cfg	configuration string from cmdline
[out]	state	output state

Return values

0	if initialized successfully
<0	if error
>0	no error but state was not returned, eg. showing help

Definition at line 59 of file audio_filter.h.

name

const char* audio_filter_info::name

Definition at line 59 of file audio_filter.h.

---

The documentation for this struct was generated from the following file:

• src/audio/audio_filter.h