writer Struct Reference

Describes a data sink for audio streams. More...

#include <write.h>

Data Fields
void(*	pre_monitor )(struct sched *s, void *context)
	Ask the scheduler to check whether data can be written. More...
int(*	post_monitor )(struct sched *s, void *context)
	Write audio data. More...
void(*	close )(struct writer_node *)
	Close one instance of the writer. More...
btr_command_handler	execute
	The callback handler. More...

Detailed Description

Describes a data sink for audio streams.

A paraslash writer obtains data via the buffer tree mechanism from its parent node. It consumes data without producing output on its own.

This structure contains the methods which have to be implemented by each writer.

See also

struct writer_node, struct receiver, struct filter, struct sched.

Field Documentation

pre_monitor

void(* pre_monitor) (struct sched *s, void *context)

Ask the scheduler to check whether data can be written.

Referenced by register_writer_node().

post_monitor

int(* post_monitor) (struct sched *s, void *context)

Write audio data.

Referenced by register_writer_node().

close

void(* close) (struct writer_node *)

Close one instance of the writer.

This function is assumed to succeed.

execute

btr_command_handler execute

The callback handler.

Each writer may provide an ->execute callback which can be used for inter-node communication.

Referenced by register_writer_node().

---

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

• write.h