_input_object Struct Reference

#include <input_plugin.h>


Data Fields

int ready
int flags
int nr_frames
int nr_tracks
int nr_channels
int frame_size
void * local_data
char * path
pthread_mutex_t object_mutex


Detailed Description

This is a structure that keeps frequently used parameters of an input instance. It also contains a pointer to any local_data that might be allocated by the plugin itself.

Field Documentation

Flag that should be set to 1 if your plugin is ready to accept play_frame() callback

Stream specific flags that should be set in the open() call. Read the description of the P_* definitions for details.

The total number of frames in the stream. Should be set in the open() call.

The number of tracks, if any, in the stream. Should be set in the open() call.

The number of PCM channels in the stream. Should always be 2 at this time.

The frame size in bytes. play_frame() will be called with this value.

If your plugin needs extra space for its own variables assign the allocated data structure to this pointer

Path of the currently played file

pthread_mutex_t _input_object::object_mutex

The object mutex. Used to lock and unlock the data structures. Initialized and called from the HOST.


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

Generated on Mon Jun 16 21:18:45 2008 for AlsaPlayer by  doxygen 1.5.6